iAwsComponent Struct Reference
Interface that is the base of ALL components. More...
#include <aws.h>
Inheritance diagram for iAwsComponent:
Public Methods | |
| virtual bool | Setup (iAws *wmgr, awsComponentNode *settings)=0 |
| Sets up a component. | |
| virtual bool | HandleEvent (iEvent &Event)=0 |
| Event dispatcher, demultiplexes events and sends them off to the proper event handler. | |
| virtual bool | GetProperty (char *name, void **parm)=0 |
| Gets a copy of the property, put it in parm. Returns false if the property does not exist. | |
| virtual bool | SetProperty (char *name, void *parm)=0 |
| Sets the property specified to whatever is in parm. Returns false if there's no such property. | |
| virtual bool | Execute (char *action, iAwsParmList &parmlist)=0 |
| Executes a scriptable action. | |
| virtual void | Invalidate ()=0 |
| Invalidation routine: allow the component to be redrawn when you call this. | |
| virtual void | Invalidate (csRect area)=0 |
| Invalidation routine: allow component to be redrawn, but only part of it. | |
| virtual csRect& | Frame ()=0 |
| Get this component's frame. | |
| virtual char* | Type ()=0 |
| Returns the named TYPE of the component, like "Radio Button", etc. | |
| virtual void | SetFlag (unsigned int flag)=0 |
| Sets the flag (can handle multiple simultaneous sets). | |
| virtual void | ClearFlag (unsigned int flag)=0 |
| Clears the flag (can handle multiple simultaneous clears). | |
| virtual unsigned int | Flags ()=0 |
| Returns the current state of the flags. | |
| virtual iAwsWindow* | Window ()=0 |
| Gets the window that this component resides in. | |
| virtual iAwsComponent* | Parent ()=0 |
| Gets the parent component of this component. | |
| virtual awsLayoutManager* | Layout ()=0 |
| Gets the layout manager for this component. | |
| virtual void | SetWindow (iAwsWindow *win)=0 |
| Sets the window that this component resides in. | |
| virtual void | SetParent (iAwsComponent *parent)=0 |
| Sets the parent component of this component. | |
| virtual void | SetLayout (awsLayoutManager *layout)=0 |
| Sets the layout manager for this component. | |
| virtual csRect | getPreferredSize ()=0 |
| Gets the preferred size of the component. | |
| virtual csRect | getMinimumSize ()=0 |
| Gets the minimum size that the component can be. | |
| virtual csRect | getInsets ()=0 |
| Gets the inset amounts that are needed to fit components properly. | |
| virtual bool | Overlaps (csRect &r)=0 |
| Returns true if this window overlaps the given rect. | |
| virtual bool | isHidden ()=0 |
| Returns the state of the hidden flag. | |
| virtual void | Hide ()=0 |
| Hides a component. | |
| virtual void | Show ()=0 |
| Shows a component. | |
| virtual bool | isDeaf ()=0 |
| Returns the state of the DEAF flag. | |
| virtual void | SetDeaf (bool bDeaf)=0 |
| set deaf/not deaf. | |
| virtual unsigned long | GetID ()=0 |
| Get's the unique id of this component. | |
| virtual void | SetID (unsigned long _id)=0 |
| Set's the unique id of this component. Note: only to be used by window manager. | |
| virtual void | MoveChildren (int delta_x, int delta_y)=0 |
| Recursively moves children (and all nested children) by relative amount given. | |
| virtual void | AddChild (iAwsComponent *child, bool has_layout=false)=0 |
| Adds a child into this component. | |
| virtual void | RemoveChild (iAwsComponent *child)=0 |
| Removes a child from this component. | |
| virtual int | GetChildCount ()=0 |
| Get's the number of children. | |
| virtual iAwsComponent* | GetChildAt (int i)=0 |
| Get's a specific child. | |
| virtual bool | HasChildren ()=0 |
| Returns true if this component has children. | |
| virtual void | OnDraw (csRect clip)=0 |
| Triggered when the component needs to draw. | |
| virtual bool | OnMouseDown (int button, int x, int y)=0 |
| Triggered when the user presses a mouse button down. | |
| virtual bool | OnMouseUp (int button, int x, int y)=0 |
| Triggered when the user unpresses a mouse button. | |
| virtual bool | OnMouseMove (int button, int x, int y)=0 |
| Triggered when the user moves the mouse. | |
| virtual bool | OnMouseClick (int button, int x, int y)=0 |
| Triggered when the user clicks the mouse. | |
| virtual bool | OnMouseDoubleClick (int button, int x, int y)=0 |
| Triggered when the user double clicks the mouse. | |
| virtual bool | OnMouseExit ()=0 |
| Triggered when this component loses mouse focus. | |
| virtual bool | OnMouseEnter ()=0 |
| Triggered when this component gains mouse focus. | |
| virtual bool | OnKeypress (int key, int modifiers)=0 |
| Triggered when the user presses a key. | |
| virtual bool | OnLostFocus ()=0 |
| Triggered when the keyboard focus is lost. | |
| virtual bool | OnGainFocus ()=0 |
| Triggered when the keyboard focus is gained. | |
| virtual bool | OnFrame ()=0 |
| Triggered at the start of each frame. | |
| virtual void | OnAdded ()=0 |
| Triggered when a child is added to the parent (triggered on the child). | |
| virtual void | OnResized ()=0 |
| Triggered when a component is resized by the layout manager. | |
Detailed Description
Interface that is the base of ALL components.
The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000