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

Properties

m_hWndNotificationReceiver Specifies the window which receives the notification messages. By default, they are sent to the parent window.

Classes

CExtPageNavigatorWnd Default constructor.
Create Creates the page navigator window.
EnableSplitter Makes the horizontal splitter, which divides the page area and the expanded/collapsed shortcut list, enabled or disabled. When the splitter is disabled you cannot drag the splitter bar up or down to move the buttons from one list to another. The method returns the previous state.
HitTest Determines which part of the page navigator control, if any, is at a specified point on the screen.
HitTestItem Performs hit testing and returns a pointer to the object with information about the button from expanded/collapsed shortcut list at a specified point. Returns NULL if there is no button at a specified point.
IsSplitterEnabled Returns true if the horizontal splitter, which divides the page area and the expanded/collapsed shortcut list, is enabled; false otherwise. When the splitter is disabled you cannot drag the splitter bar up or down to move the buttons from one list to another.
IsSplitterVisible Returns true if the horizontal splitter, which divides the page area and the expanded/collapsed shortcut list, is visible; false otherwise.
ItemEnabledGet Call this method to retrieve the item status. The method returns true if the item is enabled (visible in the page navigator); false if disabled (not visible).
ItemEnabledSet Call this method to change the item status. The method returns the previous status.
ItemFind Finds the page by its name or by the user-defined data associated and returns a zero-based index of the page if successful or -1 if the page is not found.
ItemGetCollapsedCount Retrieves the number of pages which are currently accessed with the buttons in the collapsed shortcut list.
ItemGetCount Retrieves the total number of pages.
ItemGetEnabledCount Retrieves the number of pages selected to be shown.
ItemGetExpandedCount Retrieves the number of pages which are currently accessed with the buttons in the expanded shortcut list.
ItemGetIndex Returns an index of the specified page.
ItemGetInfo Retrieves a pointer to the object that keeps information about the page with a specified index. Returns NULL if no page is found.
ItemGetPressed Retrieves a pointer to the object that keeps information about the page whose button is currently pressed with the mouse pointer. Returns NULL if no page is found.
ItemGetVisibleCount Retrieves the number of pages whose associated buttons are currently visible (i.e. their buttons are displayed either in the expanded shortcut list or in the collapsed shortcut list).
ItemInsert Inserts a page to the page navigator control.
ItemMove Moves the specified item to a new position.
ItemRemove Removes the page identified with a specified index from the page navigator control.
ItemRemoveAll Removes all pages from the page navigator control.
ItemSetExpandedCount Sets the number of buttons in the expanded shortcut list.
ItemsSwap Swaps two items in the list.
MinPageAreaHeightGet Retrieves the minimum height, in pixels, of the page area.
MinPageAreaHeightSet Sets the minimum height of the page area.
RegisterWndClass Registers a new window class for the page navigator control.
SelectionGet Retrieves an index of currently selected page.
SelectionSet Selects the page with a specified index.
ShowSplitter Changes the visibility state of the horizontal splitter, which divides the page area and the expanded/collapsed shortcut list. The method returns the previous visibility state of the splitter.
StateLoad Loads the GUI state of the page navigator object from the registry. The serialized GUI state is specified by the number of expanded items, the number of enabled items, and the item order.
StateReset Resets the GUI state (the number of expanded items, the number of enabled items, and the item order) of the page navigator to default.
StateSave Saves the GUI state of the page navigator object to the registry. The serialized GUI state is specified by the number of expanded items, the number of enabled items, and the item order.
StateSerialize Resets the GUI state (the number of expanded items, the number of enabled items, and the item order) of the page navigator to default.
UpdatePageNavigatorWnd Recalculates the layout of the page navigator control and redraws the window.

Overridables

OnPageItemPaneDrawCaption Use this method when you need to redraw the pane caption of the page navigator window.
OnPageNavigatorDrawBorder Use this method when you need to redraw the border of the navigator window.
OnPageNavigatorDrawCollapsedItemsArea Use this method when you need to redraw the content of the collapsed shortcuts list.
OnPageNavigatorDrawEntire Use this method when you need to redraw the content of the entire page navigator window.
OnPageNavigatorDrawExpandedItemsArea Use this method when you need to redraw the content of the expanded shortcuts list.
OnPageNavigatorDrawItemCaptionArea Use this method when you need to redraw the caption of the page navigator window.
OnPageNavigatorDrawSplitter Use this method when you need to redraw the horizontal splitter of the page navigator window.
OnPageNavigatorEraseClientArea Use this method when you need to redraw the background of the entire page navigator window.
OnPageNavigatorGetNotificationReceiver Returns a handle to the window that receives notification messages, which is a handle of the parent window by default. You can specify your own window to receive notification messages. Set a valid window handle to the m_hWndNotificationReceiver property.
OnQueryCollapsedAreaHeight Returns the height of the area occupied by the collapsed shortcut list.
OnQueryCollapsedItemSize Returns the size of the button in the collapsed items list.
OnQueryItemCaptionHeight Returns the height of the area occupied by the item caption.
OnQueryItemHeight Returns the height of the area occupied by the item in the expanded items list.
OnQueryItemPageCaptionHeight Returns the height of the area occupied by the pane caption in the page.
OnQuerySplitterHeight Returns the splitter height.

See Also

CExtPageNavigatorWnd Overview | Hierarchy Chart