Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Classes

CExtShortcutListWnd Default constructor
Create Creates a window for the shortcut list control.
GetContentExpandWnd Returns a reference to the content pop-up window that is used for displaying shortcuts that are partially visible in the list.
GetEditorHWND Returns a handle of the window that is activated as a shortcut text editor at the moment. The method returns NULL if no editing is performed. By default, the single line edit control is used for editing shortcut text.
GetShortcutListStyle Returns shortcut list control styles.
GetToolTipCtrl Returns a reference to the tooltip window that is used for displaying tootips.
GetVisibleRange Returns the first and the last indices of visible shortcuts in the list. These shortcuts may be partially visible. In case of the empty list, both returned indices equal 0.
IsBigIconView Returns true if the shortcut list is in the large icon mode (i.e. the __ESLW_BIG_ICON_VIEW is set).
IsHorizontalLayout Returns true if the horizontal layout style __ESLW_HORIZONTAL is set.
ItemBeginEdit Activates the shortcut text editor, which is the single line edit control by default. To use any other edit control, create it in the overridden version of the OnShortcutListStartItemEditor() virtual function. The method returns true if the index is valid and the edit window has been successfully activated; otherwise, false.
ItemEnsureVisible Performs scrolling if the shortcut specified with its index is not in the visible area. The method performs no operations if the shortcut is visible even if the scrolling is enabled. It returns true if the shortcut became visible and false in the following cases: the empty shortcut list, a non-valid index, and the hidden shortcut ( i.e. the shortcut's CExtShortcutListWnd::SHORTCUT_ITEM_INFO::m_bVisible property is set to false).
ItemGetCount Returns the number of shortcuts in the list.
ItemGetIndexOf Returns the shortcut index specified by the pointer or the reference to that shortcut. Returns -1 if the pointer (or the reference) does not specify an item in the given shortcut list.
ItemGetInfo Returns a pointer to the shortcut item specified by its index. Returns NULL in case of the empty list or a non-valid index.
ItemGetRects Returns rectangular areas of the following objects: the shortcut icon, the shortcut text, and the entire shortcut (which includes the shortcut icon, the shortcut text and areas between the next and previous shortcuts). The method returns empty values in cases of a non-valid index or a shortcut without an icon and/or text.
ItemHitTest Returns an index of the shortcut whose area includes the ptClient point defined in client coordinates of the shortcut list window.
ItemInsert Insert a shortcut to the list and returns the reference to the inserted shortcut item.
ItemIsPartiallyVisible Checks whether the shortcut specified with nIndex is partially visible. The method returns true if the nIndex is valid, the shortcut is partially visible, and the conditions determined by other parameters are met. Returns false otherwise.
ItemRemove Removes shortcuts from the list and returns the number of removed shortcuts. The returned value must be greater than or equal 0 and less than or equal the value of the nCount parameter.
ItemRemoveAll Removes all shortcuts from the list.
ModifyShortcutListStyle Modifies shortcut list control styles.
ScrollPosGet Returns the scrolling position in pixels, which must be greater than or equal 0. If 0, scrolling is unavailable.
ScrollPosSet Sets the scrolling position in pixels, which must be greater than or equal 0 and less than or equal the scrolling size returned by the ScrollSizeGet() method.
ScrollSizeGet Returns the scrolling size in pixels, which must be greater than or equal 0. If 0, scrolling is unavailable.
SetBigIconView Sets the large/small icon mode.
UpdateShortcutListWnd Redraws the shortcut list window and recalculates shortcut layout.

Overridables

OnShortcutCanDoHover The method is called when you need to determine whether it is possible to change the appearance of shortcuts and scrolling buttons when moving the mouse over them.
OnShortcutListCalcButtonsPos The method is called when positions of the scrolling buttons should be calculated.
OnShortcutListCancelItemEditor The method is called when shortcut text editing should be cancelled by some reason.
OnShortcutListCanStartDrag The method is called for the shortcut list with the __ESLW_START_DRAG style set on when the left mouse button is pressed over the shortcut specified with nIndex and moved out of the shortcut area. The method returns true if the shortcut should be returned to its released state and the OnShortcutListStartItemDrag() method should be called to start drag-and-dropping. It returns false if the distance between where the mouse is pressed and where it is released is too short to start drag-and-dropping.
OnShortcutListDeactivateEditor The method is called from the shortcut text window when the editing is completed.
OnShortcutListDrawButton Call this method if you need to redraw the scrolling button.
OnShortcutListDrawEntire Call this method if you need to redraw the entire client area of the shortcut list window. The implementation of this method in the shortcut list includes the call of OnShortcutListEraseEntire() followed by calls of OnShortcutListEraseItem() and OnShortcutListDrawItem() methods for all visible shortcuts.
OnShortcutListDrawItem Call this method if you need to redraw the background of only one visible shortcut.
OnShortcutListEraseEntire Call this method if you need to redraw the entire client area of the shortcut list window.
OnShortcutListEraseItem Call this method if you need to redraw the background of only one visible shortcut.
OnShortcutListItemGetFont Call this method if you need to get the font of the shortcut described with the _sii object.
OnShortcutListItemHoverStart The method is called when moving the mouse pointer over the shortcut specified with nIndex. If the bPreHoverTest parameter is set to true, the returned value indicates that the appearance of the shortcut can be changed and the event of moving the mouse out of the shortcut can be traced. If bPreHoverTest is set to true, the returned value means nothing and the shortcut appearance is changed when redrawing the entire shortcut area.
OnShortcutListItemHoverStop The method is called when the mouse pointer is moved out of the shortcut area.
OnShortcutListItemInserted The method is called when a new shortcut is added to the list.
OnShortcutListItemMeasure Performs measuring the shortcut in the list and sets the measured parameters in the _sii object.
OnShortcutListItemPressedStart The method is called when the left mouse button is pressed over the shortcut specified with nIndex. If the bPreHoverTest parameter is set to true, the returned value indicates that the appearance of the shortcut can be changed and the event of moving the mouse out of the shortcut can be traced. If bPreHoverTest is set to true, the returned value means nothing and the shortcut appearance is changed when redrawing the entire shortcut area.
OnShortcutListItemPressedStop The method is called when the reference is sets back to its released state.
OnShortcutListItemRemoved The method is called immediately after a shortcut has been removed from the list.
OnShortcutListItemRemoving The method is called immediately before removing a shortcut from the list. It returns true if the shortcut can be removed; otherwise false.
OnShortcutListMeasureScrollParms The method is called for calculating the scrolling parameters when the scrolling button is pressed and the scrolling position in the shortcut list is to be changed.
OnShortcutListStartItemDrag The method is called for the shortcut list with the __ESLW_START_DRAG style set on when the drag-n-drop operation with the shortcut specified with nIndex should start.
OnShortcutListStartItemEditor The method is called when the edit window of the visible shortcut should be created and activated. It returns a handle of the edit window, which must be visible and have focus. The method returns NULL if the shortcut should not be edited. By default, the single line edit control is used for editing shortcut text.

See Also

CExtShortcutListWnd Overview | Hierarchy Chart