![]() |
Public API Reference |
#include <aws.h>
Inheritance diagram for iAwsComponent:
Public Methods | |
virtual bool | Create (iAws *mgr, iAwsComponent *parent, iAwsComponentNode *settings)=0 |
This function takes care of the creation tasks required to prepare this component for use. More... | |
virtual bool | Setup (iAws *wmgr, iAwsComponentNode *settings)=0 |
Sets up a component. More... | |
virtual bool | HandleEvent (iEvent &Event)=0 |
Event dispatcher, demultiplexes events and sends them off to the proper event handler. More... | |
virtual bool | GetProperty (const char *name, void **parm)=0 |
Gets a copy of the property, put it in parm. Returns false if the property does not exist. More... | |
virtual bool | SetProperty (const char *name, void *parm)=0 |
Sets the property specified to whatever is in parm. Returns false if there's no such property. More... | |
virtual bool | Execute (const char *action, iAwsParmList *parmlist=NULL)=0 |
Executes a scriptable action. More... | |
virtual void | Invalidate ()=0 |
Invalidation routine: allow the component to be redrawn when you call this. More... | |
virtual void | Invalidate (csRect area)=0 |
Invalidation routine: allow component to be redrawn, but only part of it. More... | |
virtual csRect | Frame ()=0 |
Get this component's frame. More... | |
virtual csRect | ClientFrame ()=0 |
Get this component's client area. More... | |
virtual const char * | Type ()=0 |
Returns the named TYPE of the component, like "Radio Button", etc. More... | |
virtual void | SetFlag (unsigned int flag)=0 |
Sets the flag (can handle multiple simultaneous sets). More... | |
virtual void | ClearFlag (unsigned int flag)=0 |
Clears the flag (can handle multiple simultaneous clears). More... | |
virtual unsigned int | Flags ()=0 |
Returns the current state of the flags. More... | |
virtual iAws * | WindowManager ()=0 |
Should be used ONLY by this component, or an embedding object. More... | |
virtual iAwsComponent * | Parent ()=0 |
Gets the parent component of this component. More... | |
virtual iAwsComponent * | Window ()=0 |
Gets the window this component is in. More... | |
virtual iAwsLayoutManager * | Layout ()=0 |
Gets the layout manager for this component. More... | |
virtual void | SetParent (iAwsComponent *parent)=0 |
Sets the parent component of this component. More... | |
virtual void | SetLayout (iAwsLayoutManager *layout)=0 |
Sets the layout manager for this component. More... | |
virtual void | AddToLayout (iAwsComponent *cmp, iAwsComponentNode *settings)=0 |
Adds a component to this component's layout. More... | |
virtual csRect | getPreferredSize ()=0 |
Gets the preferred size of the component. More... | |
virtual csRect | getMinimumSize ()=0 |
Gets the minimum size that the component can be. More... | |
virtual csRect | getInsets ()=0 |
Gets the inset amounts that are needed to fit components properly. More... | |
virtual bool | Overlaps (csRect &r)=0 |
Returns true if this window overlaps the given rect. More... | |
virtual bool | isHidden ()=0 |
Returns the state of the hidden flag. More... | |
virtual bool | IsMaximized ()=0 |
Returns true if the component is maximized. More... | |
virtual void | Hide ()=0 |
Hides a component. More... | |
virtual void | Show ()=0 |
Shows a component. More... | |
virtual void | Move (int delta_x, int delta_y)=0 |
Moves a component. More... | |
virtual void | MoveTo (int x, int y)=0 |
Moves a component to an absolute location. More... | |
virtual void | Resize (int width, int height)=0 |
Resizes a component. More... | |
virtual void | ResizeTo (csRect newFrame)=0 |
Resizes a component to an absolute rect. More... | |
virtual void | Maximize ()=0 |
Maximizes this component. More... | |
virtual void | UnMaximize ()=0 |
Returns the component to its unmaximized size. More... | |
virtual void | LayoutChildren ()=0 |
Resizes all the children of this component using the current layout. More... | |
virtual bool | isDeaf ()=0 |
Returns the state of the DEAF flag. More... | |
virtual void | SetDeaf (bool bDeaf)=0 |
set deaf/not deaf. More... | |
virtual unsigned long | GetID ()=0 |
Get's the unique id of this component. More... | |
virtual void | SetID (unsigned long _id)=0 |
Set's the unique id of this component. Note: only to be used by window manager. More... | |
virtual iAwsComponent * | FindChild (const char *name)=0 |
Gets a child component by name, returns NULL on failure. More... | |
virtual iAwsComponent * | DoFindChild (unsigned id)=0 |
Gets a child component by id, returns NULL on failure. More... | |
virtual iAwsComponent * | ChildAt (int x, int y)=0 |
Returns the highest child (if any) whose frame contains (x,y). More... | |
virtual void | AddChild (iAwsComponent *child)=0 |
Adds a child into this component. More... | |
virtual void | RemoveChild (iAwsComponent *child)=0 |
Removes a child from this component. More... | |
virtual int | GetChildCount ()=0 |
Get's the number of children. More... | |
virtual iAwsComponent * | GetTopChild ()=0 |
Get's a specific child. More... | |
virtual iAwsComponent * | ComponentAbove ()=0 |
Get's the component above this one, NULL if there is none. More... | |
virtual iAwsComponent * | ComponentBelow ()=0 |
Get's the component below this one, NULL if there is none. More... | |
virtual void | SetComponentAbove (iAwsComponent *comp)=0 |
Set's the component above this one. More... | |
virtual void | SetComponentBelow (iAwsComponent *comp)=0 |
Set's the component below this one. More... | |
virtual void | Raise ()=0 |
Moves this component above all its siblings. More... | |
virtual void | Lower ()=0 |
Moves this component below all its siblings. More... | |
virtual bool | HasChildren ()=0 |
Returns true if this component has children. More... | |
virtual void | SetRedrawTag (unsigned int tag)=0 |
Sets the value of the redraw tag. More... | |
virtual unsigned int | RedrawTag ()=0 |
Gets the value of the redraw tag. More... | |
virtual void | OnDraw (csRect clip)=0 |
Triggered when the component needs to draw. More... | |
virtual bool | OnMouseDown (int button, int x, int y)=0 |
Triggered when the user presses a mouse button down. More... | |
virtual bool | OnMouseUp (int button, int x, int y)=0 |
Triggered when the user unpresses a mouse button. More... | |
virtual bool | OnMouseMove (int button, int x, int y)=0 |
Triggered when the user moves the mouse. More... | |
virtual bool | OnMouseClick (int button, int x, int y)=0 |
Triggered when the user clicks the mouse. More... | |
virtual bool | OnMouseDoubleClick (int button, int x, int y)=0 |
Triggered when the user double clicks the mouse. More... | |
virtual bool | OnMouseExit ()=0 |
Triggered when this component loses mouse focus. More... | |
virtual bool | OnMouseEnter ()=0 |
Triggered when this component gains mouse focus. More... | |
virtual bool | OnKeypress (int key, int cha, int modifiers)=0 |
Triggered when the user presses a key. More... | |
virtual bool | OnLostFocus ()=0 |
Triggered when the keyboard focus is lost. More... | |
virtual bool | OnGainFocus ()=0 |
Triggered when the keyboard focus is gained. More... | |
virtual bool | OnFrame ()=0 |
Triggered at the start of each frame. More... | |
virtual void | OnAdded ()=0 |
Triggered when a child is added to the parent (triggered on the child). More... | |
virtual void | OnResized ()=0 |
Triggered when a component is resized by the layout manager. More... | |
virtual void | OnChildMoved ()=0 |
Triggered when a child component has been moved. More... | |
virtual void | OnRaise ()=0 |
Triggered when the Raise function is called. More... | |
virtual void | OnLower ()=0 |
Triggered when the Lower function is called. More... | |
virtual void | OnChildHide ()=0 |
Triggered when a child becomes hidden. More... | |
virtual void | OnChildShow ()=0 |
Triggered when a child becomes shown. More... | |
virtual void | Unlink ()=0 |
Removes a component from the hierarchy. More... | |
virtual void | LinkAbove (iAwsComponent *comp)=0 |
Links a component into the hierarchy as a sibling above comp. More... | |
virtual void | LinkBelow (iAwsComponent *comp)=0 |
Links a component into the hierarchy as a sibling below comp. More... | |
virtual void | SetTopChild (iAwsComponent *child)=0 |
Sets the top child. More... |
Definition at line 603 of file aws.h.
|
Adds a child into this component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::AddChild, and awsEmbeddedComponent::Create. |
|
Adds a component to this component's layout.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::AddToLayout. |
|
Returns the highest child (if any) whose frame contains (x,y).
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::ChildAt. |
|
Clears the flag (can handle multiple simultaneous clears).
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::ClearFlag. |
|
Get this component's client area.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::ClientFrame. |
|
Get's the component above this one, NULL if there is none.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::ComponentAbove. |
|
Get's the component below this one, NULL if there is none.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::ComponentBelow. |
|
This function takes care of the creation tasks required to prepare this component for use. If you create a component via the window manager's creation functions then you should not call this, the window manager has done it for you. If you create components programatically then you are encouraged to call this func to make setup easier. For component developers, you should not need to override Create but rather do your setup work in Setup. If it returns false then the component was not able to initialize properly and shouldn't be used. Implemented in awsEmbeddedComponent. |
|
Gets a child component by id, returns NULL on failure.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::DoFindChild. |
|
Executes a scriptable action.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Execute. |
|
Gets a child component by name, returns NULL on failure.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::FindChild. |
|
Returns the current state of the flags.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Flags. |
|
Get this component's frame.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Frame. |
|
Get's the number of children.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::GetChildCount. |
|
Get's the unique id of this component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::GetID. |
|
Gets the inset amounts that are needed to fit components properly.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::getInsets. |
|
Gets the minimum size that the component can be.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::getMinimumSize. |
|
Gets the preferred size of the component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::getPreferredSize. |
|
Gets a copy of the property, put it in parm. Returns false if the property does not exist.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::GetProperty. |
|
Get's a specific child.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::GetTopChild. |
|
Event dispatcher, demultiplexes events and sends them off to the proper event handler.
Implemented in awsEmbeddedComponent. |
|
Returns true if this component has children.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::HasChildren. |
|
Hides a component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Hide. |
|
Invalidation routine: allow component to be redrawn, but only part of it.
Implemented in awsEmbeddedComponent. |
|
Invalidation routine: allow the component to be redrawn when you call this.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Invalidate. |
|
Returns the state of the DEAF flag.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::isDeaf. |
|
Returns the state of the hidden flag.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::isHidden. |
|
Returns true if the component is maximized.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::IsMaximized. |
|
Gets the layout manager for this component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Create, and awsEmbeddedComponent::Layout. |
|
Resizes all the children of this component using the current layout.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::LayoutChildren. |
|
Links a component into the hierarchy as a sibling above comp.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::LinkAbove. |
|
Links a component into the hierarchy as a sibling below comp.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::LinkBelow. |
|
Moves this component below all its siblings.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Lower. |
|
Maximizes this component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Maximize. |
|
Moves a component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Move. |
|
Moves a component to an absolute location.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::MoveTo. |
|
Triggered when a child is added to the parent (triggered on the child).
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnAdded. |
|
Triggered when a child becomes hidden.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnChildHide. |
|
Triggered when a child component has been moved.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnChildMoved. |
|
Triggered when a child becomes shown.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnChildShow. |
|
Triggered when the component needs to draw.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnDraw. |
|
Triggered at the start of each frame.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnFrame. |
|
Triggered when the keyboard focus is gained.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnGainFocus. |
|
Triggered when the user presses a key.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnKeypress. |
|
Triggered when the keyboard focus is lost.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnLostFocus. |
|
Triggered when the Lower function is called.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnLower. |
|
Triggered when the user clicks the mouse.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnMouseClick. |
|
Triggered when the user double clicks the mouse.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnMouseDoubleClick. |
|
Triggered when the user presses a mouse button down.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnMouseDown. |
|
Triggered when this component gains mouse focus.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnMouseEnter. |
|
Triggered when this component loses mouse focus.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnMouseExit. |
|
Triggered when the user moves the mouse.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnMouseMove. |
|
Triggered when the user unpresses a mouse button.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnMouseUp. |
|
Triggered when the Raise function is called.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnRaise. |
|
Triggered when a component is resized by the layout manager.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::OnResized. |
|
Returns true if this window overlaps the given rect.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Overlaps. |
|
Gets the parent component of this component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Parent. |
|
Moves this component above all its siblings.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Raise. |
|
Gets the value of the redraw tag.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::RedrawTag. |
|
Removes a child from this component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::RemoveChild. |
|
Resizes a component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Resize. |
|
Resizes a component to an absolute rect.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::ResizeTo. |
|
Set's the component above this one.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetComponentAbove. |
|
Set's the component below this one.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetComponentBelow. |
|
set deaf/not deaf.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetDeaf. |
|
Sets the flag (can handle multiple simultaneous sets).
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetFlag. |
|
Set's the unique id of this component. Note: only to be used by window manager.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetID. |
|
Sets the layout manager for this component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetLayout. |
|
Sets the parent component of this component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetParent. |
|
Sets the property specified to whatever is in parm. Returns false if there's no such property.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetProperty. |
|
Sets the value of the redraw tag.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetRedrawTag. |
|
Sets the top child.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::SetTopChild. |
|
Sets up a component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Setup. |
|
Shows a component.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Show. |
|
Returns the named TYPE of the component, like "Radio Button", etc.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Type. |
|
Removes a component from the hierarchy.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Unlink. |
|
Returns the component to its unmaximized size.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::UnMaximize. |
|
Gets the window this component is in.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::Window, and awsEmbeddedComponent::WindowManager. |
|
Should be used ONLY by this component, or an embedding object.
Implemented in awsEmbeddedComponent. Referenced by awsEmbeddedComponent::WindowManager. |