EmEditor Home - EmEditor Help - Plug-in Reference - Inline Functions

Editor_GetSelTypeEx

Obtains the type of selection status. You can use this inline function or explicitly send the EE_GET_SEL_TYPE message.

Editor_GetSelTypeEx( HWND hwnd, BOOL bNeedAlways );

Parameters

hwnd

Specifies the window handle of the view or frame of EmEditor.

bNeedAlways

If this parameter is TRUE, EE_GET_SEL_TYPE returns the type of selection status even if none is selected. If this parameter is FALSE, EE_GET_SEL_TYPE returns SEL_TYPE_NONE if none is selected.

Return Values

Returns a combination of the following values. SEL_TYPE_NONE, SEL_TYPE_CHAR, SEL_TYPE_LINE, and SEL_TYPE_BOX cannot be combined. SEL_TYPE_KEYBOARD and SEL_TYPE_SELECTED can be combined with other values. If bNeedAlways is TRUE and if text is selected, a logical sum with SEL_TYPE_SELECTED will be returned. If bNeedAlways is FALSE, SEL_TYPE_SELECTED will not be used.

Value Meaning
SEL_TYPE_NONE None is selected.
SEL_TYPE_CHAR Characters are selected.
SEL_TYPE_LINE Lines are selected.
SEL_TYPE_BOX Boxes are selected.
SEL_TYPE_KEYBOARD Selected by the keyboard.
SEL_TYPE_SELECTED Selected (when bNeedAlways = TRUE)

Version

Supported on EmEditor Professional Version 3.00 or later. However, bNeedAlways is supported on Version 5.00 or later. On the previous versions, bNeedAlways is assumed to be FALSE.

Copyright 2003-2014 by Emurasoft, Inc.