CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

iAws Struct Reference
[AWS]

Interface for the window manager. More...

#include <iaws/aws.h>

Inheritance diagram for iAws:

iBase List of all members.

Public Member Functions

virtual iAwsPrefManagerGetPrefMgr ()=0
 Get a pointer to the preference manager.
virtual iAwsSinkManagerGetSinkMgr ()=0
 Get a pointer to the sink manager.
virtual void SetPrefMgr (iAwsPrefManager *pmgr)=0
 Set the preference manager used by the window system.
virtual void RegisterComponentFactory (iAwsComponentFactory *factory, const char *name)=0
 Allows a component to register itself for dynamic template instatiation via definition files.
virtual iAwsComponentFactoryFindComponentFactory (const char *name)=0
 Find a component factory.
virtual iAwsComponentGetTopComponent ()=0
 Get the top component.
virtual void SetTopComponent (iAwsComponent *win)=0
 Set the top component.
virtual iAwsComponentGetFocusedComponent ()=0
 Get the focused component.
virtual void SetFocusedComponent (iAwsComponent *_focused)=0
 Set the focused component.
virtual iAwsComponentGetKeyboardFocusedComponent ()=0
 Get the component with the keyboard focus.
virtual iAwsComponentComponentAt (int x, int y)=0
 Finds the smallest visible component which contains the point (x,y).
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
 Redraw whatever portions of the screen need it.
virtual void Mark (const csRect &rect)=0
 Mark a region dirty.
virtual void Unmark (const csRect &rect)=0
 Mark a section of the screen clean.
virtual void Erase (const csRect &rect)=0
 Erase a section of the screen next round (only useful if AlwaysEraseWindows flag is set).
virtual void MaskEraser (const csRect &rect)=0
 Mask off a section that has been marked to erase.
virtual void InvalidateUpdateStore ()=0
 Tell the system to rebuild the update store.
virtual void CaptureMouse (iAwsComponent *comp)=0
 Capture all mouse events until release is called, no matter where the mouse is.
virtual void ReleaseMouse ()=0
 Release the mouse events to go where they normally would.
virtual void SetModal (iAwsComponent *comp)=0
 Set this compoment to be a modal dialog.
virtual void UnSetModal ()=0
 Set no active modal dialog.
virtual bool HandleEvent (iEvent &)=0
 Dispatches events to the proper components.
virtual bool SetupCanvas (iAwsCanvas *newCanvas, iGraphics2D *g2d=0, iGraphics3D *g3d=0)=0
 Sets up the canvas to draw on.
virtual iAwsCanvasGetCanvas ()=0
 Get the current context.
virtual iGraphics2DG2D ()=0
 Get the iGraphics2D interface so that components can use it.
virtual iGraphics3DG3D ()=0
 Get the iGraphics3D interface so that components can use it.
virtual iAwsComponentCreateWindowFrom (const char *defname)=0
 Instantiates a window based on a window definition.
virtual iAwsComponentCreateEmbeddableComponent (iAwsComponent *covercomp)=0
 Creates a new embeddable component.
virtual iAwsParmListCreateParmList ()=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 void SetFlag (unsigned int flags)=0
 Sets one or more flags for different operating modes.
virtual void ClearFlag (unsigned int flags)=0
 Clears one or more flags for different operating modes.
virtual unsigned int GetFlags ()=0
 Returns the current flags flags is a combination of AWSF_*.
virtual iObjectRegistryGetObjectRegistry ()=0
 Return object registry.
virtual bool AllWindowsHidden ()=0
 Returns true if all windows are presently hidden.
virtual bool ComponentIsInTransition (iAwsComponent *win)=0
 Checks if the specified component is currently going through a transition.
virtual void ComponentDestroyed (iAwsComponent *comp)=0
 Notify the manager about component destruction.

Detailed Description

Interface for the window manager.

Definition at line 249 of file aws.h.


Member Function Documentation

virtual bool iAws::AllWindowsHidden  )  [pure virtual]
 

Returns true if all windows are presently hidden.

virtual void iAws::CaptureMouse iAwsComponent comp  )  [pure virtual]
 

Capture all mouse events until release is called, no matter where the mouse is.

virtual void iAws::ClearFlag unsigned int  flags  )  [pure virtual]
 

Clears one or more flags for different operating modes.

flags is a combination of AWSF_*.

See also:
Window manager flags

virtual iAwsComponent* iAws::ComponentAt int  x,
int  y
[pure virtual]
 

Finds the smallest visible component which contains the point (x,y).

virtual void iAws::ComponentDestroyed iAwsComponent comp  )  [pure virtual]
 

Notify the manager about component destruction.

virtual bool iAws::ComponentIsInTransition iAwsComponent win  )  [pure virtual]
 

Checks if the specified component is currently going through a transition.

virtual iAwsComponent* iAws::CreateEmbeddableComponent iAwsComponent covercomp  )  [pure virtual]
 

Creates a new embeddable component.

virtual iAwsParmList* iAws::CreateParmList  )  [pure virtual]
 

Creates a new parameter list.

virtual void iAws::CreateTransition iAwsComponent win,
unsigned  transition_type,
csTicks  duration = 250
[pure virtual]
 

Creates and enables a transition for a window.

transition_type is one of AWS_TRANSITION_*.

See also:
Window transitions

virtual void iAws::CreateTransitionEx iAwsComponent win,
unsigned  transition_type,
csTicks  duration,
csRect user
[pure virtual]
 

Creates and enables a transition for a window, using a user specified start or finish (transition type defines which).

transition_type is one of AWS_TRANSITION_*.

See also:
Window transitions

virtual iAwsComponent* iAws::CreateWindowFrom const char *  defname  )  [pure virtual]
 

Instantiates a window based on a window definition.

virtual void iAws::Erase const csRect rect  )  [pure virtual]
 

Erase a section of the screen next round (only useful if AlwaysEraseWindows flag is set).

virtual iAwsComponentFactory* iAws::FindComponentFactory const char *  name  )  [pure virtual]
 

Find a component factory.

virtual iGraphics2D* iAws::G2D  )  [pure virtual]
 

Get the iGraphics2D interface so that components can use it.

virtual iGraphics3D* iAws::G3D  )  [pure virtual]
 

Get the iGraphics3D interface so that components can use it.

virtual iAwsCanvas* iAws::GetCanvas  )  [pure virtual]
 

Get the current context.

virtual unsigned int iAws::GetFlags  )  [pure virtual]
 

Returns the current flags flags is a combination of AWSF_*.

See also:
Window manager flags

virtual iAwsComponent* iAws::GetFocusedComponent  )  [pure virtual]
 

Get the focused component.

virtual iAwsComponent* iAws::GetKeyboardFocusedComponent  )  [pure virtual]
 

Get the component with the keyboard focus.

virtual iObjectRegistry* iAws::GetObjectRegistry  )  [pure virtual]
 

Return object registry.

virtual iAwsPrefManager* iAws::GetPrefMgr  )  [pure virtual]
 

Get a pointer to the preference manager.

Referenced by awsEmbeddedComponentFactory::RegisterConstant().

virtual iAwsSinkManager* iAws::GetSinkMgr  )  [pure virtual]
 

Get a pointer to the sink manager.

virtual iAwsComponent* iAws::GetTopComponent  )  [pure virtual]
 

Get the top component.

virtual bool iAws::HandleEvent iEvent  )  [pure virtual]
 

Dispatches events to the proper components.

virtual void iAws::InvalidateUpdateStore  )  [pure virtual]
 

Tell the system to rebuild the update store.

virtual void iAws::Mark const csRect rect  )  [pure virtual]
 

Mark a region dirty.

virtual void iAws::MaskEraser const csRect rect  )  [pure virtual]
 

Mask off a section that has been marked to erase.

This part won't be erased.

virtual bool iAws::MouseInComponent int  x,
int  y
[pure virtual]
 

Returns true if the mouse is inside any of the top-level components.

virtual void iAws::Print iGraphics3D g3d,
uint8  Alpha = 0
[pure virtual]
 

Causes the current view of the window system to be drawn to the given graphics device.

virtual void iAws::Redraw  )  [pure virtual]
 

Redraw whatever portions of the screen need it.

virtual void iAws::RegisterComponentFactory iAwsComponentFactory factory,
const char *  name
[pure virtual]
 

Allows a component to register itself for dynamic template instatiation via definition files.

Referenced by awsEmbeddedComponentFactory::Register().

virtual void iAws::ReleaseMouse  )  [pure virtual]
 

Release the mouse events to go where they normally would.

virtual void iAws::SetFlag unsigned int  flags  )  [pure virtual]
 

Sets one or more flags for different operating modes.

flags is a combination of AWSF_*.

See also:
Window manager flags

virtual void iAws::SetFocusedComponent iAwsComponent _focused  )  [pure virtual]
 

Set the focused component.

virtual void iAws::SetModal iAwsComponent comp  )  [pure virtual]
 

Set this compoment to be a modal dialog.

virtual void iAws::SetPrefMgr iAwsPrefManager pmgr  )  [pure virtual]
 

Set the preference manager used by the window system.

virtual void iAws::SetTopComponent iAwsComponent win  )  [pure virtual]
 

Set the top component.

virtual bool iAws::SetupCanvas iAwsCanvas newCanvas,
iGraphics2D g2d = 0,
iGraphics3D g3d = 0
[pure virtual]
 

Sets up the canvas to draw on.

Parameters:
newCanvas The canvas to draw on. If this parameter is 0, then g2d and g3d MUST be present. AWS will use them to create a default, direct to screen canvas.
g2d A pointer to a valid iGraphics2D instance. (If newCanvas is NOT null, this param may be ommitted.)
g3d A pointer to a valid iGraphics3D instance. (If newCanvas is NOT null, this param may be ommitted.)
Returns:
True if everything works, False otherwise. If this function returns False AWS will NOT work.

virtual void iAws::Unmark const csRect rect  )  [pure virtual]
 

Mark a section of the screen clean.

virtual void iAws::UnSetModal  )  [pure virtual]
 

Set no active modal dialog.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1