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

Classes

CExtTabWnd Constructor.
Create Creates an instance of the tab control window.
GetRectBtnClose Gets the rectangle that defines the boundaries of the "X" button.
GetRectBtnDown �Gets the rectangle that defines the boundaries of the scroll down button.
GetRectBtnHelp �Gets the rectangle that defines the boundaries of the help button.
GetRectBtnScrollEnd �Gets the rectangle that defines the boundaries of the scroll-to-end button.
GetRectBtnScrollHome �Gets the rectangle that defines the boundaries of the scroll-to-home button.
GetRectBtnTabList Gets the rectangle that defines the boundaries of the button that displays the pop-up menu with a list of all the tab items.
GetRectBtnUp Gets the rectangle that defines the boundaries of the scroll up button.
GetRectTabItemsArea Gets the rectangular area which covers all the fully and partially visible tab items.
GetRectTabNearBorderArea Gets the rectangle that defines a strip:
GetTabWndStyle Gets the basic tab control style (the __ETWS_*** flags).
GetTabWndStyleEx Gets the extended tab control style (the __ETWS_EX_*** flags).
ItemEnsureVisible Returns the value that specifies whether or not the tab item is visible. If true, the tab is visible, even though it can be out of the visible part of the window at the moment. In the last case, the method positions the tab making it visible on the screen.
ItemFindByLParam Gets the tab index specified by lParam. In case of several such tab items, returns the first.
ItemFindByStyle Returns the index of the tab item defined by the style starting at the specified position. In case of several such tab items, returns the first.
ItemGet Gets a pointer to the TAB_ITEM_INFO structure, which describes the tab at the position nIndex. If unsuccessful, the method returns NULL. The method is overloaded with two signatures: the first returns a constant pointer and the second does a non-constant one.
ItemGetCount Gets the number of the tabs in the tab control window.
ItemGetGroupRange Returns a pointers and the indices of the tab items that belong to the tab control window. The method is overloaded with two signatures: the first returns constant pointers and the second does non-constant ones.
ItemGetIndexOf Gets the tab index by the tab pointer.
ItemGetVisibleCount Gets the number of tab items that are visible in the tab control window. The tab is considered visible if it is displayed, even if it is entirely hidden at the moment (for details, see the ItemEnsureVisible function).
ItemHitTest Returns either the tab index if the returned value is negative, or the flag that specifies the region where the mouse pointer has been clicked if the returned value is positive.
ItemIconGet Returns the icon object associated with the tab.
ItemIconSet Assigns the icon to the tab item.
ItemInsert Inserts the tab item with its style, text, and icon and returns a pointer to the TAB_ITEM_INFO structure if successful or NULL otherwise
ItemLParamGet Gets the 32-bit value associated with the tab item.
ItemLParamSet Sets the 32-bit value associated with the tab item.
ItemMove Changes the position of the specified tab.
ItemRemove Removes one or several tab items in a row.
ItemRemoveAll Removes al the tab items in the tab control window.
ItemRemoveGroup Removes the group of the tab items in the tab control window.
ItemStyleGet Gets the style of the tab item.
ItemStyleModify Modifies the style of the style item.
ItemTextGet Gets the text for the tab item that specified by nIndex.
ItemTextSet Sets the text for the tab item.
ItemTooltipTextGet Gets tooltip text for the tab item that specified by nIndex.
ItemTooltipTextSet Sets tooltip text for the tab item.
ModifyTabWndStyle Sets/Modifies the basic tab control style (the __ETWS_*** flags).
ModifyTabWndStyleEx Sets/Modifies the extended tab control style (the __ETWS_EX_*** flags).
OrientationGet Gets a DWORD value that describes how the tab control is oriented. The returned value can have __ETWS_ORIENT_TOP, __ETWS_ORIENT_BOTTOM, __ETWS_ORIENT_LEFT or __ETWS_ORIENT_RIGHT value.
OrientationIsHorizontal Returns true if the tab control is oriented horizontally; vertically otherwise.
OrientationIsTopLeft Returns true if the tab control is located at the top when oriented horizontally or on the left if oriented vertically. Otherwise, the tab control is located at the bottom when oriented horizontally or on the right if oriented vertically.
OrientationIsVertical Returns true if the tab control is oriented vertically; horizontally otherwise.
OrientationSet Sets how the tab control is oriented and returns the previous orientation that can one of the following DWORD values: __ETWS_ORIENT_TOP, __ETWS_ORIENT_BOTTOM, __ETWS_ORIENT_LEFT or __ETWS_ORIENT_RIGHT.
SelectionBoldGet Returns true if the flag that specifies whether or not to show the text in bold is set to true; otherwise false.
SelectionBoldSet Enables/disables the flag that specifies whether or not to show the text of the selected tab in bold.
SelectionDelay Sets the delay time before the tab item is selected.
SelectionGet Returns the index of the selected tab item.
SelectionGetPtr Returns a pointer to the structure of the selected tab item. The method is overloaded with two signatures: the first returns the constant pointer and the second does the non-constant one.
SelectionSet Sets the selection of the tab item programmatically.
UpdateTabWnd Updates the tab control window.

Overridables

OnAdvancedPopupMenuTipWndDisplay Invoked to show the tooltip window.
OnAdvancedPopupMenuTipWndGet Called to get a pointer to the advanced tooltip window implemented in the CExtPopupMenuTipWnd class. This tooltip window is used to display tip information for the tab items and buttons. If the returned value is NULL, the standard tooltip window is used instead.
OnTabWndButtonsCalcWidth Invoked to calculate the total width (or height when the control is oriented vertically) of all the buttons.
OnTabWndButtonsRecalcLayout Invoked when positions of the tab control buttons is to be recalculated.
OnTabWndCalcButtonSize Invoked to compute the size of the tab control button.
OnTabWndClickedButton Invoked when a mouse button has been pressed or released over a tab control button and returns true if the event has been handled.
OnTabWndClickedItem Invoked when a mouse button has been pressed or released over a tab item and returns true if the event has been handled.
OnTabWndDoScroll Invoked to scroll tabs.
OnTabWndDrawButton Called to draw a button in the tab control window.
OnTabWndDrawDraggedTabItemContent Called to draw the shape of the drag-n-dropped tab item.
OnTabWndDrawEntire Called to draw the entire content of the tab window.
OnTabWndDrawItem Called to draw a tab item.
OnTabWndEraseClientArea Called to erase the client area of the tab window.
OnTabWndGetParentSizingMargin Invoked to allocate additional tab window space when it handles the WM_SIZEPARENT internal MFC message.
OnTabWndItemInsert Invoked after a tab item is inserted into the tab window.
OnTabWndItemPosChanged Invoked when the position of the tab item has changed as a result of either drag-and-drop or invoking the CExtTabWnd::ItemMove() method.
OnTabWndItemPosChanging Invoked when the position of the tab item is to be changed before completing either drag-and-drop or the CExtTabWnd::ItemMove() method. The method returns true if the tab position can be changed.
OnTabWndMeasureItemAreaMargins Called to measure margins around the tab item.
OnTabWndMouseTrackingHoverStart Invoked when the mouse pointer enters a tab/button and the tab window starts tracking its state. The method returns true if the event has been handled.
OnTabWndMouseTrackingHoverStop Invoked when the tab window finishes tracking the hovered state of a tab/button.
OnTabWndMouseTrackingPushedStart Invoked when the tab window starts tracking the pressed state of a tab/button. The method returns true if the event has been handled.
OnTabWndMouseTrackingPushedStop Called when the tab window finishes tracking the pressed state of a tab/button.
OnTabWndProcessDrag Called when the tab window detects that the drag-and-drop operation started in the tab window. The method returns true if the drag-and-drop algorithm has been executed.
OnTabWndQueryAlignFontBasedDifference Returns true if the tab has the same size both when selected (a bold font) and unselected ( a normal font).
OnTabWndQueryHoverChangingRedraw Returns true if tab items are repainted when their hovered state is changed.
OnTabWndQueryItemIcon Invoked to get a pointer to the icon object of the specified tab item.
OnTabWndQueryItemText Invoked to get text of the tab item.
OnTabWndQueryItemTooltipText This method is invoked to get the tooltip text of the tab item.
OnTabWndRemoveAllItems Called when all the tab items are to be removed and when they are completely removed.
OnTabWndRemoveItem Called when one or more the tab items are to be removed and when they are completely removed.
OnTabWndSelectionChange Invoked to notify that the selection is about to be changed or just changed. If the bPreSelectionTest parameter is set to true, the method is invoked before the selection is changed and the returned value indicates that the selection can be changed if it is true. If the bPreSelectionTest parameter is set to false, the method is invoked just to notify that the selection has been changed.
OnTabWndStartDrag Invoked before tab drag-and-drop starts. The method returns true if drag-and-drop of the specified tab item is allowed.
OnTabWndSyncVisibility Invoked to change the visibility of the tab window depending on any user-defined conditions. The method is used When MFC's internal WM_SIZEPARENT message is processed which allows the tab window to stick to the borders of its parent window and optionally switch the window visibility.
OnTabWndToolTipQueryEnabled Invoked to determine whether the standard tooltip control can be displayed for the tab items and buttons.
OnTabWndUpdateItemMeasure Invoked to change the default size of the tab item.

See Also

CExtTabWnd Overview | Hierarchy Chart