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

Properties

g_bAnimationAccelerated Flag specifying the type of expanding animation: accelerated animation if true; otherwise, linear animation
g_ctAnimationStepClocks Time between animation steps, in milliseconds.
g_nAnimationStepCount Number of steps for expanding/contacting a page.

Classes

CanDoLayoutMouseScrolling Returns a boolean value specifying whether the page scrolling according to the styles set in the container window can be performed.
CExtPageContainerWnd Default constructor.
Create The method creates the page container window and returns a value indicating whether the window created successfully.
GetContentExpandWnd Returns a reference to the content pop-up window, which is used for displaying partially visible page captions.
GetEditorHWND Returns a window handle of the page caption editor. If no editing is being performed, the method returns NULL.
GetPageContainerStyle Returns styles of the page container window.
GetToolTipCtrl Returns a reference to the tooltip window, which is used for displaying tooltips.
HaveScrollPosArea Returns a boolean value specifying whether the page container window has a scrolling area.
IsDragScrolling Returns a boolean value specifying whether the user is scrolling the pages at the moment.
IsHorizontalLayout Returns a boolean value specifying whether the layout of pages in the page container window is horizontal.
IsInExpandingAnimation Returns a boolean value specifying whether the page container is in the "expanding/contracting page" animation mode at the moment.
ModifyPageContainerStyle Modifies styles of the page container window.
PageEnsureVisible Performs the layout scrolling to make the page specified with nIndex at most visible. The method does nothing if scrolling is unavailable. It returns true if succeeded and the page became completely visible. The method returns NULL in case of a non-valid nIndex parameter or the page is invisible. It also returns NULL if the container window does not hold this page.
PageExpand Expands or contracts the page specified with nIndex. The returned boolean value indicates whether the method succeeded.
PageFind Returns an index of the page specified with hWnd. The method returns a negative value if none of the pages in the page container window has the window handle equal to hWnd.
PageGetCount Returns the number of pages in the page container window.
PageGetIndexOf Returns an index of the page whose properties described with the pPageInfo parameter. The method returns NULL in case of a non-valid nIndex parameter or if there are no pages in the container. It also returns NULL if the container window does not hold this page.
PageGetInfo Returns a pointer to the CExtPageContainerWnd::PAGE_ITEM_INFO object, which stores properties of the page specified with nIndex. The method returns NULL in case of a non-valid nIndex parameter or if there are no pages in the container.
PageGetLayoutRectInfo Returns some rectangular areas of the page specified with nIndex. The method returns empty values in cases of a non-valid index or a shortcut without an icon and/or text. The method returns NULL in case of a non-valid nIndex parameter or if there are no pages in the container.
PageGetNext Returns an index of the next or previous page according to the conditions specified in the parameters. The method returns -1 if the page is not found.
PageHitTest Performs hit-testing within the page container window. The method returns the reference to the _pht object, whose properties are changed in the method. To hit-test the page, the m_ptClient property of pht should be filled in with attributes of the point in client coordinates of the page container window. All other properties of pht are filled in by PageHitTest().
PageInsert Inserts a page into the page container window.
PageIsExpanded Returns a boolean value indicating whether the page specified with nIndex is expanded or contracted.
PageIsVisible Returns a boolean value indicating whether the page specified with nIndex is visible or hidden.
PageRemove Removes pages from the page container window. The method returns the number of removed pages, which must be greater than or equal to zero and less than or equal to the nCount parameter.
PageRemoveAll Removes all the pages from the page container window.
PageShow Shows or hides the page specified with nIndex. The returned boolean value indicates whether the method succeeded.
RegisterPageContainerWndClass The method registers the page container window class and returns a boolean value indicating whether the registration completed successfully.
ScrollPosAdjust Changes the scrolling position by the zDelta value. If zDelta is less than zero, the position moves up/right; if zDelta is greater than zero, the position moves down/left.
ScrollPosGet Returns the scrolling position, which must be greater than or equal 0 and less than or equal the value returned by ScrollSizeGet(). The method returns 0 if scrolling is unavailable.
ScrollSizeGet Returns the scrolling size, which must be greater than 0. The method returns 0 if scrolling is unavailable.
UpdatePageContainerWnd Recalculates the layout of all pages in the container window and redraws the control.

Overridables

OnPageContainerActivateContentExpandWnd Use this method when you need to display the content pop-up window for the caption whose content is partially visible.
OnPageContainerAdjustMouseWheelParms Use this method when you need to measure the scrolling increment specified with one step of the mouse wheel.
OnPageContainerCancelItemEditor Use this method when you need to deactivate a caption edit window.
OnPageContainerCanDoCaptionDrag Use this method when you need to determine whether you can start drag-n-dropping the page caption, which is in a pressed state. Returns true if you can start drag-n-dropping and after that the OnPageContainerStartCaptionDrag() method should be called.
OnPageContainerCanDoHoverActions Use this method when you need to determine whether the appearance of a page container window item can be changed when the mouse pointer is over that item. It returns true if the appearance can be changed; otherwise, false.
OnPageContainerCaptionHoverStart The method is called when the mouse pointer is over the page caption.
OnPageContainerCaptionHoverStop The method is called when the mouse pointer is moved away from the page caption.
OnPageContainerCaptionPressedStart The method is called when the mouse button has been pressed over the page caption.
OnPageContainerCaptionPressedStop The method is called when the mouse button has been released over the page caption.
OnPageContainerDeactivateEditor This method is called from the caption edit window after finishing editing.
OnPageContainerDoItemTextChanging Use this method when you need to change the page caption text.
OnPageContainerDrawCaption Use this method when you need to redraw the content of the caption of the page in the page container window.
OnPageContainerDrawEntire Use this method when you need to redraw the content of the entire page container window.
OnPageContainerDrawItem Use this method when you need to redraw the content of one page in the page container window.
OnPageContainerDrawScrollPosArea Use this method when you need to redraw the content of the scrolling position area in the page container window.
OnPageContainerEraseCaption Use this method when you need to redraw the background of the caption of the page in the page container window.
OnPageContainerEraseEntire Use this method when you need to redraw the background of the entire page container window.
OnPageContainerEraseItem Use this method when you need to redraw the background of one page in the page container window.
OnPageContainerEraseScrollPosArea Use this method when you need to redraw the background of the area for displaying the scrolling position in the page container window.
OnPageContainerHitTest The method is called for hit-testing.
OnPageContainerHookPageWndMsg Use this method when you need to intercept a window message for the pPageInfo child window. The method returns true if the message has been handed; otherwise, false.
OnPageContainerIsDragablePosition Use this method when you need to determine whether the scrolling can be started by pressing the left mouse button at the ptScreen point.
OnPageContainerItemExpanded Called after the page has been expanded or contracted.
OnPageContainerItemExpanding Called before the page gets expanded or contracted. The method returns true is the action is cancelled.
OnPageContainerItemRemoved The method is called after a page has been removed from the page container window.
OnPageContainerItemInserted The method is called when a new page is inserted to the page container window.
OnPageContainerItemRemoving The method is called when a page is about to be removed from the page container window. It returns true if the page can be removed at any moment.
OnPageContainerMeasureCaptionSize Use this method is when you need measure the caption and caption text of the page.
OnPageContainerMeasurePageBorderInfo Use this method when you need to get characteristics of the page border.
OnPageContainerQueryCancelExpandAnimation The method is used when you need to determine whether the page expanding/contacting animation can be cancelled. The return of true means canceling animation; otherwise, false.
OnPageContainerQueryItemFont Use this method when you need the font used for displaying the page caption text.
OnPageContainerQueryItemGlyph Use this method when you need the graphic image of the expanded/contracted page.
OnPageContainerQueryItemIcon Use this method when you need the icon in the page caption.
OnPageContainerQueryItemText Use this method when you need the page caption text.
OnPageContainerSetCursorOnCaption Use this method when you need to set the mouse pointer over the page caption. Returns true if the mouse pointer has been set; otherwise, false.
OnPageContainerSetCursorOnDragableArea Use this method when you need to set the mouse pointer over the position where drag-n-drop scrolling can be performed. Returns true if the mouse pointer has been set; otherwise, false.
OnPageContainerStartCaptionDrag The method is called for starting drag-n-dropping the page caption.
OnPageContainerStartItemEditor Use this method when you need to create and activate a caption edit window, which can be of any type. It returns a handle of the edit window. In the page container window this method creates the edit control.

See Also

CExtPageContainerWnd Overview | Hierarchy Chart