iAws Struct Reference
[AWS, AWS]
Interface for the window manager.
More...
#include <iaws/aws.h>
Inheritance diagram for iAws:

Public Member Functions | |
virtual bool | AllWindowsHidden ()=0 |
Returns true if all windows are presently hidden. | |
virtual void | CaptureMouse (iAwsComponent *comp)=0 |
Capture all mouse events until release is called, no matter where the mouse is. | |
virtual void | ClearFlag (unsigned int flags)=0 |
Clears one or more flags for different operating modes. | |
virtual iAwsComponent * | ComponentAt (int x, int y)=0 |
Finds the smallest visible component which contains the point (x,y). | |
virtual void | ComponentDestroyed (iAwsComponent *comp)=0 |
Notify the manager about component destruction. | |
virtual bool | ComponentIsInTransition (iAwsComponent *win)=0 |
Checks if the specified component is currently going through a transition. | |
virtual iAwsComponent * | CreateEmbeddableComponent (iAwsComponent *covercomp)=0 |
Creates a new embeddable component. | |
virtual iAwsParmList * | CreateParmList ()=0 |
Creates a new parameter list. | |
virtual void | CreateTransition (iAwsComponent *win, unsigned transition_type, csTicks duration=250)=0 |
Creates and enables a transition for a window. | |
virtual void | CreateTransitionEx (iAwsComponent *win, unsigned transition_type, csTicks duration, csRect &user)=0 |
Creates and enables a transition for a window, using a user specified start or finish (transition type defines which). | |
virtual iAwsComponent * | CreateWindowFrom (const char *defname)=0 |
Instantiates a window based on a window definition. | |
virtual void | DeleteMarkedComponents ()=0 |
Call this if you want to delete marked components immediately. | |
virtual void | Erase (const csRect &rect)=0 |
Erase a section of the screen next round (only useful if AlwaysEraseWindows flag is set). | |
virtual iAwsComponentFactory * | FindComponentFactory (const char *name)=0 |
Find a component factory. | |
virtual iGraphics2D * | G2D ()=0 |
Get the iGraphics2D interface so that components can use it. | |
virtual iGraphics3D * | G3D ()=0 |
Get the iGraphics3D interface so that components can use it. | |
virtual iAwsCanvas * | GetCanvas ()=0 |
Get the current context. | |
virtual unsigned int | GetFlags ()=0 |
Returns the current flags flags is a combination of AWSF_*. | |
virtual iAwsComponent * | GetFocusedComponent ()=0 |
Get the focused component. | |
virtual iAwsComponent * | GetKeyboardFocusedComponent ()=0 |
Get the component with the keyboard focus. | |
virtual iObjectRegistry * | GetObjectRegistry ()=0 |
Return object registry. | |
virtual iAwsPrefManager * | GetPrefMgr ()=0 |
Get a pointer to the preference manager. | |
virtual iAwsSinkManager * | GetSinkMgr ()=0 |
Get a pointer to the sink manager. | |
virtual iStringSet * | GetStringTable ()=0 |
Get the shared string table. | |
virtual iAwsComponent * | GetTopComponent ()=0 |
Get the top component. | |
virtual bool | HandleEvent (iEvent &)=0 |
Dispatches events to the proper components. | |
virtual bool | HandleEvent (iEvent &)=0 |
Dispatches events to the proper components. | |
virtual bool | Initialize (iObjectRegistry *_object_reg)=0 |
Must be called before anything else. | |
virtual void | InvalidateUpdateStore ()=0 |
Tell the system to rebuild the update store. | |
virtual bool | Load (const scfString &_filename)=0 |
Load a definition file. | |
virtual void | Mark (const csRect &rect)=0 |
Mark a region dirty. | |
virtual void | MarkToDeleteRecursively (iAwsComponent *comp)=0 |
Mark the component and its sub-components to be deleted. | |
virtual void | MaskEraser (const csRect &rect)=0 |
Mask off a section that has been marked to erase. | |
virtual bool | MouseInComponent (int x, int y)=0 |
Returns true if the mouse is inside any of the top-level components. | |
virtual void | Print (iGraphics3D *g3d, uint8 Alpha=0)=0 |
Causes the current view of the window system to be drawn to the given graphics device. | |
virtual void | Redraw ()=0 |
Redraws all the windows into the current graphics contexts. | |
virtual void | Redraw ()=0 |
Redraw whatever portions of the screen need it. | |
virtual void | RegisterComponentFactory (iAwsComponentFactory *factory, const char *name)=0 |
Allows a component to register itself for dynamic template instatiation via definition files. | |
virtual void | ReleaseMouse ()=0 |
Release the mouse events to go where they normally would. | |
virtual void | SetDrawTarget (iGraphics2D *_g2d, iGraphics3D *_g3d)=0 |
Setup the drawing targets. | |
virtual void | SetFlag (unsigned int flags)=0 |
Sets one or more flags for different operating modes. | |
virtual void | SetFocusedComponent (iAwsComponent *_focused)=0 |
Set the focused component. | |
virtual void | SetModal (iAwsComponent *comp)=0 |
Set this compoment to be a modal dialog. | |
virtual void | SetPrefMgr (iAwsPrefManager *pmgr)=0 |
Set the preference manager used by the window system. | |
virtual void | SetTopComponent (iAwsComponent *win)=0 |
Set the top component. | |
virtual bool | SetupCanvas (iAwsCanvas *newCanvas, iGraphics2D *g2d=0, iGraphics3D *g3d=0)=0 |
Sets up the canvas to draw on. | |
virtual void | Unmark (const csRect &rect)=0 |
Mark a section of the screen clean. | |
virtual void | UnSetModal ()=0 |
Set no active modal dialog. | |
Public Attributes | |
csEventID | FrameStart |
csEventID | GainFocus |
csEventID | GroupOff |
csEventID | KeyboardDown |
csEventID | KeyboardUp |
csEventID | LoseFocus |
csEventID | MouseClick |
csEventID | MouseDown |
csEventID | MouseEnter |
csEventID | MouseExit |
csEventID | MouseMove |
csEventID | MouseUp |
csEventID | PreProcess |
Cached event names. These should be set up in the Initialize method. |
Detailed Description
Interface for the window manager.
Definition at line 276 of file aws.h.
Member Function Documentation
|
Returns true if all windows are presently hidden.
|
|
Capture all mouse events until release is called, no matter where the mouse is.
|
|
Clears one or more flags for different operating modes.
|
|
Finds the smallest visible component which contains the point (x,y).
|
|
Notify the manager about component destruction.
|
|
Checks if the specified component is currently going through a transition.
|
|
Creates a new embeddable component.
|
|
Creates a new parameter list.
|
|
Creates and enables a transition for a window.
|
|
Creates and enables a transition for a window, using a user specified start or finish (transition type defines which).
|
|
Instantiates a window based on a window definition.
|
|
Call this if you want to delete marked components immediately.
|
|
Erase a section of the screen next round (only useful if AlwaysEraseWindows flag is set).
|
|
Find a component factory.
|
|
Get the iGraphics2D interface so that components can use it.
|
|
Get the iGraphics3D interface so that components can use it.
|
|
Get the current context.
|
|
Returns the current flags
|
|
Get the focused component.
|
|
Get the component with the keyboard focus.
|
|
Return object registry.
|
|
Get a pointer to the preference manager.
Referenced by awsEmbeddedComponentFactory::RegisterConstant(). |
|
Get a pointer to the sink manager.
|
|
Get the shared string table.
|
|
Get the top component.
|
|
Dispatches events to the proper components.
|
|
Dispatches events to the proper components.
|
|
Must be called before anything else.
|
|
Tell the system to rebuild the update store.
|
|
Load a definition file.
|
|
Mark a region dirty.
|
|
Mark the component and its sub-components to be deleted.
|
|
Mask off a section that has been marked to erase. This part won't be erased. |
|
Returns true if the mouse is inside any of the top-level components.
|
|
Causes the current view of the window system to be drawn to the given graphics device.
|
|
Redraws all the windows into the current graphics contexts.
|
|
Redraw whatever portions of the screen need it.
|
|
Allows a component to register itself for dynamic template instatiation via definition files.
Referenced by awsEmbeddedComponentFactory::Register(). |
|
Release the mouse events to go where they normally would.
|
|
Setup the drawing targets.
|
|
Sets one or more flags for different operating modes.
|
|
Set the focused component.
|
|
Set this compoment to be a modal dialog.
|
|
Set the preference manager used by the window system.
|
|
Set the top component.
|
|
Sets up the canvas to draw on.
|
|
Mark a section of the screen clean.
|
|
Set no active modal dialog.
|
Member Data Documentation
|
Cached event names. These should be set up in the Initialize method.
|
The documentation for this struct was generated from the following files:
Generated for Crystal Space by doxygen 1.4.6