class PMDIFrameWindow: public PTopLevelWindow

A class representing a top level window "frame" for Multiple Document Interface child windows.

Inheritance:


Public Methods

[more] PMDIFrameWindow ( unsigned CanDo=CanClose|CanGrow|CanIconify|CanZoom )
Construct a new MDI style top level window.
[more]PMDIDocWindow* GetActiveDocument ()
Get the MDI document window that is the frontmost or "target" MDI child window.
[more]virtual void CascadeDocuments ()
Reposition and resize all child documents in a cascading fashion.
[more]virtual void TileDocuments ( BOOL vertically = FALSE )
Reposition and resize all child documents in a tiled fashion.
[more]virtual void ArrangeIcons ()
Reposition all child documents that are currently iconic.
[more]void SetDocumentArea ( const PRect & rect, CoordinateSystem coords )
Set the area in the frames client area that child document windows are limited to.
[more]PRect GetDocumentArea ( CoordinateSystem coords ) const
Get the area in the frames client area that child document windows are limited to.
[more]PSubMenu& GetWindowMenu ()
Get the standard "Window" sub-menu which contains a list of all the active child windows as well as the standard Cascade, Tile and Arrange Icons menu items.

Public

[more] New functions for class

Protected Fields

[more]PRect documentArea
Area within the MDI frame that MDI child windows may exist.


Documentation

A class representing a top level window "frame" for Multiple Document Interface child windows. This is the "main" window that the application creates when an MDI is required. On some platforms, eg MS-Windows variants, this encloses the MDI child windows. On
o PMDIFrameWindow( unsigned CanDo=CanClose|CanGrow|CanIconify|CanZoom )
Construct a new MDI style top level window.
Parameters:
CanDo - Titled window flags.

o New functions for class

oPMDIDocWindow* GetActiveDocument()
Get the MDI document window that is the frontmost or "target" MDI child window.

Returns:
pointer to active MDI child or NULL if there is none.

ovirtual void CascadeDocuments()
Reposition and resize all child documents in a cascading fashion.

ovirtual void TileDocuments( BOOL vertically = FALSE )
Reposition and resize all child documents in a tiled fashion. The parameter indicates the preference for tiling multiple windows.
Parameters:
vertically - Tiling orientation.

ovirtual void ArrangeIcons()
Reposition all child documents that are currently iconic.

ovoid SetDocumentArea( const PRect & rect, CoordinateSystem coords )
Set the area in the frames client area that child document windows are limited to.

These bounds are used if areas of the frame are not to be obscured by the document child windows, eg when tool bars are used. The tiling and cascading, as well as maximising the child, are limited to this area.

If this rectangle is empty then the document area is the entire frame window.

Parameters:
rect - Bounds for child windows.
coords - Coordinate system to use.

oPRect GetDocumentArea( CoordinateSystem coords ) const
Get the area in the frames client area that child document windows are limited to.

These bounds are used if areas of the frame are not to be obscured by the document child windows, eg when tool bars are used. The tiling and cascading, as well as maximising the child, are limited to this area.

If this rectangle is empty then the document area is the entire frame window.

Returns:
bounds area for MDI child windows.
Parameters:
coords - Coordinate system to use.

oPSubMenu& GetWindowMenu()
Get the standard "Window" sub-menu which contains a list of all the active child windows as well as the standard Cascade, Tile and Arrange Icons menu items.

Returns:
reference to a sub-menu for the the MDI "Windows" menu.

oPRect documentArea
Area within the MDI frame that MDI child windows may exist.


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.