class PInteractorLayout: public PInteractor

This class defines a user inteface entity that consists of a collection of zero or more other interactors.

Inheritance:


Public Methods

[more] PInteractorLayout ( PInteractor * parent )
Create a new empty layout.
[more] PInteractorLayout ( PInteractor * parent, PRESOURCE_ID resID )
Create a new layout by loading it from a resource.
[more]virtual ~PInteractorLayout ()
Destroy the interactor layout, releasing its data and all of its associated controls
[more]virtual void SetFocusInteractor ( PInteractor * interactor )
Set the child interactor that has the focus in the interactor layout.
[more]virtual PInteractor* GetFocusInteractor () const
Get the child interactor that has the focus in the interactor layout.
[more]PControl* GetControl ( PRESOURCE_ID id )
Get the child interactor control with the specifed ID.
[more]void UpdateControls ()
Update the value sof all controls from their attached value pointers using the notification function with the PControl::NotifyUpdate code.

Public

[more] Overrides from class PInteractor
[more] New functions for class

Protected Fields

[more]PInteractor* focusInteractor
The last interactor in layout with keyboard focus.

Protected Methods

[more]virtual void ConstructEnd ( PRESOURCE_ID resID )
Complete construction of an interactor layout.


Inherited from PInteractor:

Public Classes

oenum PositionOrigin
oenum CoordinateSystem
oenum AutoAdjustType

Public Fields

oPCursor cursor

Public Methods

ovirtual Comparison Compare( const PObject & obj ) const
oPInteractor* GetParent() const
oBOOL IsChild( PInteractor * parent ) const
oPINDEX GetNumChildren()
oPInteractor& operator[]( PINDEX index )
ovirtual void UpdateCommandSources()
ovirtual void SetFont( const PFont & newFont, BOOL toChildren = TRUE )
oconst PRealFont& GetFont()
oPDIMENSION ToPixelsDX( PDIMENSION x ) const
oPDIMENSION ToPixelsDY( PDIMENSION y ) const
oPORDINATE ToPixelsX( PORDINATE x ) const
oPORDINATE ToPixelsY( PORDINATE y ) const
oPDim ToPixels( const PDim & dim ) const
oPPoint ToPixels( const PPoint & pt ) const
oPRect ToPixels( const PRect & r ) const
oPDIMENSION FromPixelsDX( PDIMENSION x ) const
oPDIMENSION FromPixelsDY( PDIMENSION y ) const
oPORDINATE FromPixelsX( PORDINATE x ) const
oPORDINATE FromPixelsY( PORDINATE y ) const
oPDim FromPixels( const PDim & dim ) const
oPPoint FromPixels( const PPoint & pt ) const
oPRect FromPixels( const PRect & r ) const
ovoid SetPosition( PORDINATE x, PORDINATE y, PositionOrigin xOrigin = TopLeftParent, PositionOrigin yOrigin = TopLeftParent )
oPPoint GetPosition( CoordinateSystem coords ) const
oPPoint ToScreen( PORDINATE x, PORDINATE y, CoordinateSystem coords ) const
oPPoint FromScreen( PORDINATE x, PORDINATE y, CoordinateSystem coords ) const
ovoid SetDimensions( PDIMENSION width, PDIMENSION height, CoordinateSystem coords )
oPDim GetDimensions( CoordinateSystem coords ) const
oPRect GetStructureBounds( CoordinateSystem coords ) const
ovirtual PRect GetDrawingBounds( CoordinateSystem coords ) const
ovoid AutoAdjustBounds( PRect & bounds, AutoAdjustType type = AdjustBounds )
oBOOL ContainsPoint( const PPoint & pt, CoordinateSystem coords ) const
oPInteractor* FindInteractor( const PPoint & pt, CoordinateSystem coords ) const
ovirtual void Enable( BOOL enabled = TRUE )
ovoid Disable()
oBOOL IsEnabled() const
ovirtual void ShowAll()
ovirtual void Show( BOOL visible = TRUE )
ovoid Hide()
oBOOL IsVisible() const
ovirtual void BringToTop()
ovirtual BOOL IsOnTop() const
ovoid Invalidate( PORDINATE x, PORDINATE y, PDIMENSION width, PDIMENSION height, CoordinateSystem coords )
ovoid Validate( PORDINATE x, PORDINATE y, PDIMENSION width, PDIMENSION height, CoordinateSystem coords )
ovoid Update()
ovoid GrabMouse()
ovoid ReleaseMouse()
oBOOL HasMouse() const
ovoid GrabFocus()
oBOOL HasFocus() const
ovirtual void SetCursor( const PCursor & newCursor )
oPCursor GetCursor() const
ovoid SetCursorToParent( BOOL useParent = TRUE )
ovoid SetAllCursors( const PCursor & newCursor )
ovoid RestoreAllCursors()
ovoid SetWaitCursor()
ovoid SetCursorPos( PORDINATE x, PORDINATE y, CoordinateSystem coords )
oPPoint GetCursorPos( CoordinateSystem coords ) const
ovirtual void ShowCursor( BOOL show = TRUE )
ovoid HideCursor()
ovoid SetCaret( const PCaret & newCaret )
oPCaret GetCaret() const
ovoid SetCaretPos( PORDINATE x, PORDINATE y, CoordinateSystem coords )
oPPoint GetCaretPos( CoordinateSystem coords ) const
ovirtual void ShowCaret(BOOL show = TRUE)
ovoid HideCaret()
ovirtual void SetForegroundColour( const PColour & newColour )
oconst PColour& GetForegroundColour() const
ovirtual void SetBackgroundColour( const PColour & newColour )
oconst PColour& GetBackgroundColour() const
oPDim GetBorderSize() const
oconst PColour& GetBorderColour() const
oPCanvas* StartMouseTrack( BOOL wantsCanvas = FALSE )
ovirtual void OnMouseMove( PKeyCode button, const PPoint & where )
ovirtual void OnMouseDown( PKeyCode button, const PPoint & where, BOOL doubleClick )
ovirtual void OnMouseUp( PKeyCode button, const PPoint & where )
ovirtual BOOL OnKeyDown( PKeyCode key, unsigned repeat )
ovirtual void OnKeyUp( PKeyCode key )
ovirtual void OnKeyInput( const PString & str )
ovirtual void OnGainFocus()
ovirtual void OnLostFocus()
ovirtual void OnStartInput()
ovirtual BOOL OnEndInput()
ovirtual void OnRedraw( PCanvas & canvas )
ovirtual void OnControlNotify( PControl & control, int option )
ovirtual void OnSelectHelp()
ovirtual PBalloon* OnBalloonHelp()
ovirtual void OnMouseTrack( PCanvas * canvas, const PPoint & where, BOOL lastTrack )
ovirtual void _SetPosition( PORDINATE x, PORDINATE y, PositionOrigin xOrigin, PositionOrigin yOrigin )

Public

Overrides from class PObject

System callback functions.

Protected Fields

oPApplication* owner
oPInteractor* parent
oPInteractorList children
oPRealFont font
oPCursor savedCursor
oPCaret caret
oPPoint caretPosition
oint caretVisible
oPColour foregroundColour
oPColour backgroundColour
oPInteractor* mouseTrackInteractor
oPInteractorCanvas* mouseTrackCanvas

Protected Methods

ovirtual void _SetDimensions( PDIMENSION width, PDIMENSION height, CoordinateSystem coords )
ovirtual void _Invalidate( PORDINATE x, PORDINATE y, PDIMENSION width, PDIMENSION height, CoordinateSystem coords )
ovirtual void _Validate( PORDINATE x, PORDINATE y, PDIMENSION width, PDIMENSION height, CoordinateSystem coords )
ovirtual void _SetCursorPos( PORDINATE x, PORDINATE y, CoordinateSystem coords )
ovirtual void _SetCaretPos( PORDINATE x, PORDINATE y, CoordinateSystem coords )
ovirtual void UpdateMyCommandSources()

Protected

o Flag to indicate that the parent interactor layouts cursor should be used with this interactor.


Documentation

This class defines a user inteface entity that consists of a collection of zero or more other interactors. These interactors are expected to be descendents of the PControl class. Controls allow information to be transferred between the user and the application.

The external and internal layout of an instance of this class is usually described using application resources.

This class, while not actually abstract, is usually descended from before use. The descendents such as PDialog will add more functionality and may visually appear different. An interactor layout has no title or border as these are usually added by the descendent.

o PInteractorLayout( PInteractor * parent )
Create a new empty layout. There are no controls contained within the layout and it is expected that these are to added manually by the application.
Parameters:
parent - Interactor that owns the layout.

o PInteractorLayout( PInteractor * parent, PRESOURCE_ID resID )
Create a new layout by loading it from a resource. The resource description determines the position, dimensions of the layout as well as the position, dimensions, title and other options for all of the controls in the layout.
Parameters:
parent - Interactor that owns the layout.
resID - Resource identifier for loading controls.

ovirtual ~PInteractorLayout()
Destroy the interactor layout, releasing its data and all of its associated controls

o Overrides from class PInteractor

ovirtual void SetFocusInteractor( PInteractor * interactor )
Set the child interactor that has the focus in the interactor layout.

This interactor is the one that will receive the focus whenever the layout itself receives the focus. As a layout does not handle keyboard input directly it passes the focus on to a child control within itself.

Parameters:
interactor - Interactor that hash received the focus.

ovirtual PInteractor* GetFocusInteractor() const
Get the child interactor that has the focus in the interactor layout.

Returns:
last interactor in layout with focus.

o New functions for class

oPControl* GetControl( PRESOURCE_ID id )
Get the child interactor control with the specifed ID.

Returns:
control with specified ID, or NULL if none present.
Parameters:
id - Identifier for the control. This was usually the arbitrary, and unique, number given to the control specification in the resource file.

ovoid UpdateControls()
Update the value sof all controls from their attached value pointers using the notification function with the PControl::NotifyUpdate code. The default function for each control type transfers from its internal value pointer (if not NULL) to the controls representation.

ovirtual void ConstructEnd( PRESOURCE_ID resID )
Complete construction of an interactor layout. This is primarily used by the PWRC resource compiler generated code.

As the resource compiler generates the constructor for the layout or dialog, it is impossible for the user to add extra construction code there. To circumvent this problem, the last thing the generated code does is to call the ConstructEnd() function, which the user can override and add extra construction code.

The default implementation of this function is platform dependent, for example in MS-Windows it initialises list boxes from a resource containing their string list values.

Note that when overriding this function, the ancestor version must always be called.

Parameters:
resID - Resource identifier for loading controls.

oPInteractor* focusInteractor
The last interactor in layout with keyboard focus.


Direct child classes:
PWizardPage
PWizardFrame
PToolBar
PDialog

Alphabetic index HTML hierarchy of classes or Java



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