CrystalSpace

Public API Reference

awsEmbeddedComponent Class Reference

Class used to create new AWS components. More...

#include <iaws/awsecomp.h>

Inheritance diagram for awsEmbeddedComponent:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual void AddChild (iAwsComponent *child)
 Adds a child.
virtual void AddToLayout (iAwsComponent *cmp, iAwsComponentNode *settings)
 Adds a component to this component's layout.
virtual bool AddToTabOrder (iAwsComponent *cmp)
 Add child to parent tab order.
 awsEmbeddedComponent (iAws *mgr)
virtual void Broadcast (uint32 signal)
 Broadcasts a signal to all slots that are interested.
virtual iAwsComponentChildAt (int x, int y)
 Returns the highest child (if any) whose frame contains (x,y).
virtual void ClearFlag (unsigned int flag)
 Clears the flag (can handle multiple simultaneous clears).
virtual void clearPreferredSize ()
 Clear the manually set preferred size.
virtual csRect ClientFrame ()
 Get this component's client frame.
virtual iAwsComponentComponentAbove ()
 Get's the component above this one, 0 if there is none.
virtual iAwsComponentComponentBelow ()
 Get's the component below this one, 0 if there is none.
virtual bool Create (iAws *m, iAwsComponent *parent, iAwsComponentNode *settings)
 This function takes care of the creation tasks required to prepare this component for use.
virtual iAwsComponentDoFindChild (unsigned int id)
virtual bool Execute (const char *action, iAwsParmList *parmlist)
 Executes scriptable actions for this window.
virtual iAwsComponentFindChild (const char *name)
 Gets a child component by name, returns 0 on failure.
virtual unsigned int Flags ()
 Returns the current state of the flags.
virtual bool Focusable ()
 Returns component can focus.
virtual csRect Frame ()
 Get this component's frame.
virtual int GetChildCount ()
 Get's the number of children.
virtual iAwsComponentGetComponent ()
 Gets the component owner for this (sources are embedded).
virtual iAwsComponentGetFirstFocusableChild (iAwsComponent *comp)
 Returns first focusable component on this component.
virtual unsigned long GetID ()
 Get's the unique id of this component.
virtual csRect getInsets ()
 get the components insets, used by layout manager
iAwsGetManager ()
virtual bool GetMarkToDelete ()
 Return the delete mark.
virtual csRect getMinimumSize ()
 get the components minimal size, used by layout manager
virtual csRect getPreferredSize ()
 get the components preferred size, used by layout manager
virtual AWS_VOIDP_IS_WARNING
bool 
GetProperty (const char *name, void **parm)
 Gets a copy of the property, put it in parm.
virtual bool GetProperty (const char *name, intptr_t *parm)
 Gets the property specified, setting the parameter to a COPY of the property's value.
virtual iAwsComponentGetTabComponent (int index)
 Return component by tabindex.
virtual int GetTabLength ()
 Returns tab order length.
virtual iAwsComponentGetTopChild ()
 Get's a specific child.
virtual bool HandleEvent (iEvent &Event)
 Event dispatcher, demultiplexes events and sends them off to the proper event handler.
virtual bool HasChildren ()
 Returns true if this component has children.
virtual void Hide ()
 Hides a component.
virtual void Initialize (iAwsComponent *component)
 Sets the embedded component. MUST BE CALLED BEFORE ANY OTHER FUNCTION!
virtual void Invalidate (csRect area)
 Invalidation routine: allow component to be redrawn, but only part of it.
virtual void Invalidate ()
 Invalidation routine: allow the component to be redrawn when you call this.
virtual bool isDeaf ()
 does the component listen to events ?
virtual bool isFocused ()
 Return component is focused.
virtual bool isHidden ()
 Returns the state of the hidden flag.
virtual bool IsMaximized ()
 Returns true if the component is maximized.
virtual iAwsLayoutManagerLayout ()
 Gets the layout manager for this component.
virtual void LayoutChildren ()
 Resizes all the children of this component using the current layout.
void LinkAbove (iAwsComponent *c)
 Links a component into the hierarchy as a sibling above comp.
void LinkBelow (iAwsComponent *c)
 Links a component into the hierarchy as a sibling below comp.
virtual void Lower ()
 Moves this component below all its siblings.
virtual void MarkToDelete ()
 Mark the component to be deleted in PreProcess phase of the next frame.
virtual void Maximize ()
 Maximizes this component.
virtual void Move (int delta_x, int delta_y)
 Moves a component.
virtual void MoveTo (int x, int y)
 Moves a component to an absolute location.
virtual void OnAdded ()
 Triggered when a child is added to the parent (triggered on the child).
virtual void OnChildHide ()
 Triggered when a child becomes hidden.
virtual void OnChildMoved ()
 Triggered when a child component has been moved.
virtual void OnChildShow ()
 Triggered when a child becomes shown.
virtual void OnDraw (csRect clip)
 Triggered when the component needs to draw.
virtual bool OnFrame ()
 Triggered at the start of each frame.
virtual bool OnGainFocus ()
 Triggered when the keyboard focus is gained.
virtual bool OnKeyboard (const csKeyEventData &eventData)
 Triggered when the user presses a key.
virtual bool OnLostFocus ()
 Triggered when the keyboard focus is lost.
virtual void OnLower ()
 Triggered when the Lower function is called.
virtual bool OnMouseClick (int button, int x, int y)
 Triggered when the user clicks the mouse.
virtual bool OnMouseDoubleClick (int button, int x, int y)
 Triggered when the user double clicks the mouse.
virtual bool OnMouseDown (int button, int x, int y)
 Triggered when the user presses a mouse button down.
virtual bool OnMouseEnter ()
 Triggered when this component gains mouse focus.
virtual bool OnMouseExit ()
 Triggered when this component loses mouse focus.
virtual bool OnMouseMove (int button, int x, int y)
 Triggered when the user moves the mouse.
virtual bool OnMouseUp (int button, int x, int y)
 Triggered when the user unpresses a mouse button.
virtual void OnRaise ()
 Triggered when the Raise function is called.
virtual void OnResized ()
 Triggered when a component is resized by the layout manager.
virtual void OnSetFocus ()
 Triggered when a child becomes focused.
virtual void OnUnsetFocus ()
 Triggered when a child looses focus.
virtual bool Overlaps (csRect &r)
 Returns true if this window overlaps the given rect.
iAwsComponentParent ()
 Get's the parent component of this component;.
virtual void Raise ()
 Moves this component above all its siblings.
virtual unsigned int RedrawTag ()
 Gets the value of the redraw tag.
virtual bool RegisterSlot (iAwsSlot *slot, unsigned long signal)
 Registers a slot for a signal.
virtual void RemoveChild (iAwsComponent *child)
 Removes a child.
virtual void Resize (int width, int height)
 Resizes a component.
virtual void ResizeTo (csRect newFrame)
 Resizes a component to an absolute rect.
virtual void SetComponentAbove (iAwsComponent *cmp)
 Set's the component above this one.
virtual void SetComponentBelow (iAwsComponent *cmp)
 Set's the component below this one.
virtual void SetDeaf (bool isDeaf)
 let the component listen to events or not
virtual void SetFlag (unsigned int flag)
 Sets the flag (can handle multiple simultaneous sets).
virtual void SetFocus ()
 Sets component focused.
virtual void SetFocusable (bool focusable)
 Set component can focus.
virtual void SetID (unsigned long id)
 Set's the unique id of this component.
virtual void SetLayout (iAwsLayoutManager *layoutMgr)
 Set the layout manager.
virtual void SetParent (iAwsComponent *parent)
 Sets the parent component of this component;.
virtual void setPreferredSize (const csRect &size)
 Set the preferred size of the component.
virtual AWS_VOIDP_IS_WARNING
bool 
SetProperty (const char *name, void *parm)
 Sets the property specified to whatever is in parm.
virtual bool SetProperty (const char *name, intptr_t parm)
 Sets the property specified, setting the proprty to whatever is in parm.
virtual void SetRedrawTag (unsigned int tag)
 Sets the value of the redraw tag.
virtual void SetTopChild (iAwsComponent *child)
 Sets the top child.
virtual bool Setup (iAws *wmgr, iAwsComponentNode *settings)
 Sets up component.
virtual void Show ()
 Shows a component.
virtual iAwsComponentTabNext (iAwsComponent *cmp)
 Returns next component in tab order.
virtual iAwsComponentTabPrev (iAwsComponent *cmp)
 Returns previous component in tab order.
virtual const char * Type ()
 Returns the named TYPE of the component, like "Radio Button", etc.
virtual void Unlink ()
 Removes a component from the hierarchy.
virtual void UnMaximize ()
 Returns the component to its unmaximized size.
virtual bool UnregisterSlot (iAwsSlot *slot, unsigned long signal)
 Unregisters a slot for a signal.
virtual void UnsetFocus ()
 Unsets component focused.
iAwsComponentWindow ()
 Get's the window that this component resides in.
iAwsWindowManager ()
 Get's this components idea of the window manager.
virtual ~awsEmbeddedComponent ()

Detailed Description

Class used to create new AWS components.

To create component from scratch, you need to subclass from awsEmbeddedComponent. After instantiating from that object, you need to call Initialize() with a component gotten from iAWS::CreateEmbeddableComponent(). After writing the code for that component, you need to subclass from awsEmbeddedComponentFactory. Do your constant registrations, etc. At runtime you simply need to instantiate the derived factory, which handles registration and creation for you. The instantiation of the component needs to happen in the Factory in a function called Create().

Definition at line 42 of file awsecomp.h.


Member Function Documentation

virtual void awsEmbeddedComponent::AddChild iAwsComponent child  )  [inline, virtual]
 

Adds a child.

Implements iAwsComponent.

Definition at line 304 of file awsecomp.h.

virtual void awsEmbeddedComponent::AddToLayout iAwsComponent cmp,
iAwsComponentNode settings
[inline, virtual]
 

Adds a component to this component's layout.

Implements iAwsComponent.

Definition at line 256 of file awsecomp.h.

virtual bool awsEmbeddedComponent::AddToTabOrder iAwsComponent cmp  )  [inline, virtual]
 

Add child to parent tab order.

Implements iAwsComponent.

Definition at line 280 of file awsecomp.h.

virtual void awsEmbeddedComponent::Broadcast uint32  signal  )  [inline, virtual]
 

Broadcasts a signal to all slots that are interested.

Implements iAwsSource.

Definition at line 71 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::ChildAt int  x,
int  y
[inline, virtual]
 

Returns the highest child (if any) whose frame contains (x,y).

Implements iAwsComponent.

Definition at line 323 of file awsecomp.h.

virtual void awsEmbeddedComponent::ClearFlag unsigned int  flag  )  [inline, virtual]
 

Clears the flag (can handle multiple simultaneous clears).

Implements iAwsComponent.

Definition at line 164 of file awsecomp.h.

virtual void awsEmbeddedComponent::clearPreferredSize  )  [inline, virtual]
 

Clear the manually set preferred size.

Implements iAwsComponent.

Definition at line 439 of file awsecomp.h.

virtual csRect awsEmbeddedComponent::ClientFrame  )  [inline, virtual]
 

Get this component's client frame.

Implements iAwsComponent.

Definition at line 184 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::ComponentAbove  )  [inline, virtual]
 

Get's the component above this one, 0 if there is none.

Implements iAwsComponent.

Definition at line 347 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::ComponentBelow  )  [inline, virtual]
 

Get's the component below this one, 0 if there is none.

Implements iAwsComponent.

Definition at line 351 of file awsecomp.h.

virtual bool awsEmbeddedComponent::Create iAws m,
iAwsComponent parent,
iAwsComponentNode settings
[inline, virtual]
 

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.

Reproducing the create code here is a temporary fix until I can find a better solution. Currently you can not properly embed the menu and popupMenu components like this.

Implements iAwsComponent.

Definition at line 98 of file awsecomp.h.

virtual bool awsEmbeddedComponent::Execute const char *  action,
iAwsParmList parmlist
[inline, virtual]
 

Executes scriptable actions for this window.

Implements iAwsComponent.

Definition at line 156 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::FindChild const char *  name  )  [inline, virtual]
 

Gets a child component by name, returns 0 on failure.

Implements iAwsComponent.

Definition at line 237 of file awsecomp.h.

virtual unsigned int awsEmbeddedComponent::Flags  )  [inline, virtual]
 

Returns the current state of the flags.

Implements iAwsComponent.

Definition at line 168 of file awsecomp.h.

virtual bool awsEmbeddedComponent::Focusable  )  [inline, virtual]
 

Returns component can focus.

Implements iAwsComponent.

Definition at line 264 of file awsecomp.h.

virtual csRect awsEmbeddedComponent::Frame  )  [inline, virtual]
 

Get this component's frame.

Implements iAwsComponent.

Definition at line 180 of file awsecomp.h.

virtual int awsEmbeddedComponent::GetChildCount  )  [inline, virtual]
 

Get's the number of children.

Implements iAwsComponent.

Definition at line 312 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::GetComponent  )  [inline, virtual]
 

Gets the component owner for this (sources are embedded).

Implements iAwsSource.

Definition at line 56 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::GetFirstFocusableChild iAwsComponent comp  )  [inline, virtual]
 

Returns first focusable component on this component.

Implements iAwsComponent.

Definition at line 300 of file awsecomp.h.

References iAwsComponent::GetFirstFocusableChild().

virtual unsigned long awsEmbeddedComponent::GetID  )  [inline, virtual]
 

Get's the unique id of this component.

Implements iAwsComponent.

Definition at line 227 of file awsecomp.h.

virtual csRect awsEmbeddedComponent::getInsets  )  [inline, virtual]
 

get the components insets, used by layout manager

Implements iAwsComponent.

Definition at line 447 of file awsecomp.h.

virtual bool awsEmbeddedComponent::GetMarkToDelete  )  [inline, virtual]
 

Return the delete mark.

Implements iAwsComponent.

Definition at line 519 of file awsecomp.h.

virtual csRect awsEmbeddedComponent::getMinimumSize  )  [inline, virtual]
 

get the components minimal size, used by layout manager

Implements iAwsComponent.

Definition at line 443 of file awsecomp.h.

virtual csRect awsEmbeddedComponent::getPreferredSize  )  [inline, virtual]
 

get the components preferred size, used by layout manager

Implements iAwsComponent.

Definition at line 431 of file awsecomp.h.

virtual AWS_VOIDP_IS_WARNING bool awsEmbeddedComponent::GetProperty const char *  name,
void **  parm
[inline, virtual]
 

Gets a copy of the property, put it in parm.

Returns false if the property does not exist.

Deprecated:
For proper 64-bit platform support, use the intptr_t version of GetProperty().

Implements iAwsComponent.

Definition at line 132 of file awsecomp.h.

virtual bool awsEmbeddedComponent::GetProperty const char *  name,
intptr_t parm
[inline, virtual]
 

Gets the property specified, setting the parameter to a COPY of the property's value.

Returns false if there's no such property.

Implements iAwsComponent.

Definition at line 121 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::GetTabComponent int  index  )  [inline, virtual]
 

Return component by tabindex.

Implements iAwsComponent.

Definition at line 296 of file awsecomp.h.

virtual int awsEmbeddedComponent::GetTabLength  )  [inline, virtual]
 

Returns tab order length.

Implements iAwsComponent.

Definition at line 292 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::GetTopChild  )  [inline, virtual]
 

Get's a specific child.

Implements iAwsComponent.

Definition at line 316 of file awsecomp.h.

virtual bool awsEmbeddedComponent::HandleEvent iEvent Event  )  [inline, virtual]
 

Event dispatcher, demultiplexes events and sends them off to the proper event handler.

Implements iAwsComponent.

Definition at line 112 of file awsecomp.h.

virtual bool awsEmbeddedComponent::HasChildren  )  [inline, virtual]
 

Returns true if this component has children.

Implements iAwsComponent.

Definition at line 320 of file awsecomp.h.

virtual void awsEmbeddedComponent::Hide  )  [inline, virtual]
 

Hides a component.

Implements iAwsComponent.

Definition at line 203 of file awsecomp.h.

virtual void awsEmbeddedComponent::Initialize iAwsComponent component  )  [inline, virtual]
 

Sets the embedded component. MUST BE CALLED BEFORE ANY OTHER FUNCTION!

Definition at line 76 of file awsecomp.h.

virtual void awsEmbeddedComponent::Invalidate csRect  area  )  [inline, virtual]
 

Invalidation routine: allow component to be redrawn, but only part of it.

Implements iAwsComponent.

Definition at line 176 of file awsecomp.h.

References csRef< T >::Invalidate().

virtual void awsEmbeddedComponent::Invalidate  )  [inline, virtual]
 

Invalidation routine: allow the component to be redrawn when you call this.

Implements iAwsComponent.

Definition at line 172 of file awsecomp.h.

References csRef< T >::Invalidate().

virtual bool awsEmbeddedComponent::isDeaf  )  [inline, virtual]
 

does the component listen to events ?

Implements iAwsComponent.

Definition at line 451 of file awsecomp.h.

virtual bool awsEmbeddedComponent::isFocused  )  [inline, virtual]
 

Return component is focused.

Implements iAwsComponent.

Definition at line 268 of file awsecomp.h.

virtual bool awsEmbeddedComponent::isHidden  )  [inline, virtual]
 

Returns the state of the hidden flag.

Implements iAwsComponent.

Definition at line 199 of file awsecomp.h.

virtual bool awsEmbeddedComponent::IsMaximized  )  [inline, virtual]
 

Returns true if the component is maximized.

Implements iAwsComponent.

Definition at line 243 of file awsecomp.h.

virtual iAwsLayoutManager* awsEmbeddedComponent::Layout  )  [inline, virtual]
 

Gets the layout manager for this component.

Implements iAwsComponent.

Definition at line 423 of file awsecomp.h.

virtual void awsEmbeddedComponent::LayoutChildren  )  [inline, virtual]
 

Resizes all the children of this component using the current layout.

Implements iAwsComponent.

Definition at line 253 of file awsecomp.h.

void awsEmbeddedComponent::LinkAbove iAwsComponent c  )  [inline, virtual]
 

Links a component into the hierarchy as a sibling above comp.

Implements iAwsComponent.

Definition at line 499 of file awsecomp.h.

void awsEmbeddedComponent::LinkBelow iAwsComponent c  )  [inline, virtual]
 

Links a component into the hierarchy as a sibling below comp.

Implements iAwsComponent.

Definition at line 495 of file awsecomp.h.

virtual void awsEmbeddedComponent::Lower  )  [inline, virtual]
 

Moves this component below all its siblings.

Implements iAwsComponent.

Definition at line 367 of file awsecomp.h.

virtual void awsEmbeddedComponent::MarkToDelete  )  [inline, virtual]
 

Mark the component to be deleted in PreProcess phase of the next frame.

Implements iAwsComponent.

Definition at line 515 of file awsecomp.h.

virtual void awsEmbeddedComponent::Maximize  )  [inline, virtual]
 

Maximizes this component.

Implements iAwsComponent.

Definition at line 246 of file awsecomp.h.

virtual void awsEmbeddedComponent::Move int  delta_x,
int  delta_y
[inline, virtual]
 

Moves a component.

Implements iAwsComponent.

Definition at line 211 of file awsecomp.h.

virtual void awsEmbeddedComponent::MoveTo int  x,
int  y
[inline, virtual]
 

Moves a component to an absolute location.

Implements iAwsComponent.

Definition at line 215 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnAdded  )  [inline, virtual]
 

Triggered when a child is added to the parent (triggered on the child).

Implements iAwsComponent.

Definition at line 463 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnChildHide  )  [inline, virtual]
 

Triggered when a child becomes hidden.

Implements iAwsComponent.

Definition at line 483 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnChildMoved  )  [inline, virtual]
 

Triggered when a child component has been moved.

Implements iAwsComponent.

Definition at line 471 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnChildShow  )  [inline, virtual]
 

Triggered when a child becomes shown.

Implements iAwsComponent.

Definition at line 487 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnDraw csRect  clip  )  [inline, virtual]
 

Triggered when the component needs to draw.

Implements iAwsComponent.

Definition at line 379 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnFrame  )  [inline, virtual]
 

Triggered at the start of each frame.

Implements iAwsComponent.

Definition at line 459 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnGainFocus  )  [inline, virtual]
 

Triggered when the keyboard focus is gained.

Implements iAwsComponent.

Definition at line 419 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnKeyboard const csKeyEventData eventData  )  [inline, virtual]
 

Triggered when the user presses a key.

Implements iAwsComponent.

Definition at line 411 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnLostFocus  )  [inline, virtual]
 

Triggered when the keyboard focus is lost.

Implements iAwsComponent.

Definition at line 415 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnLower  )  [inline, virtual]
 

Triggered when the Lower function is called.

Implements iAwsComponent.

Definition at line 479 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnMouseClick int  button,
int  x,
int  y
[inline, virtual]
 

Triggered when the user clicks the mouse.

Implements iAwsComponent.

Definition at line 395 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnMouseDoubleClick int  button,
int  x,
int  y
[inline, virtual]
 

Triggered when the user double clicks the mouse.

Implements iAwsComponent.

Definition at line 399 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnMouseDown int  button,
int  x,
int  y
[inline, virtual]
 

Triggered when the user presses a mouse button down.

Implements iAwsComponent.

Definition at line 383 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnMouseEnter  )  [inline, virtual]
 

Triggered when this component gains mouse focus.

Implements iAwsComponent.

Definition at line 407 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnMouseExit  )  [inline, virtual]
 

Triggered when this component loses mouse focus.

Implements iAwsComponent.

Definition at line 403 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnMouseMove int  button,
int  x,
int  y
[inline, virtual]
 

Triggered when the user moves the mouse.

Implements iAwsComponent.

Definition at line 391 of file awsecomp.h.

virtual bool awsEmbeddedComponent::OnMouseUp int  button,
int  x,
int  y
[inline, virtual]
 

Triggered when the user unpresses a mouse button.

Implements iAwsComponent.

Definition at line 387 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnRaise  )  [inline, virtual]
 

Triggered when the Raise function is called.

Implements iAwsComponent.

Definition at line 475 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnResized  )  [inline, virtual]
 

Triggered when a component is resized by the layout manager.

Implements iAwsComponent.

Definition at line 467 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnSetFocus  )  [inline, virtual]
 

Triggered when a child becomes focused.

Implements iAwsComponent.

Definition at line 507 of file awsecomp.h.

virtual void awsEmbeddedComponent::OnUnsetFocus  )  [inline, virtual]
 

Triggered when a child looses focus.

Implements iAwsComponent.

Definition at line 511 of file awsecomp.h.

virtual bool awsEmbeddedComponent::Overlaps csRect r  )  [inline, virtual]
 

Returns true if this window overlaps the given rect.

Implements iAwsComponent.

Definition at line 195 of file awsecomp.h.

iAwsComponent* awsEmbeddedComponent::Parent  )  [inline, virtual]
 

Get's the parent component of this component;.

Implements iAwsComponent.

Definition at line 339 of file awsecomp.h.

virtual void awsEmbeddedComponent::Raise  )  [inline, virtual]
 

Moves this component above all its siblings.

Implements iAwsComponent.

Definition at line 363 of file awsecomp.h.

virtual unsigned int awsEmbeddedComponent::RedrawTag  )  [inline, virtual]
 

Gets the value of the redraw tag.

Implements iAwsComponent.

Definition at line 375 of file awsecomp.h.

virtual bool awsEmbeddedComponent::RegisterSlot iAwsSlot slot,
unsigned long  signal
[inline, virtual]
 

Registers a slot for a signal.

Implements iAwsSource.

Definition at line 63 of file awsecomp.h.

virtual void awsEmbeddedComponent::RemoveChild iAwsComponent child  )  [inline, virtual]
 

Removes a child.

Implements iAwsComponent.

Definition at line 308 of file awsecomp.h.

virtual void awsEmbeddedComponent::Resize int  width,
int  height
[inline, virtual]
 

Resizes a component.

Implements iAwsComponent.

Definition at line 219 of file awsecomp.h.

virtual void awsEmbeddedComponent::ResizeTo csRect  newFrame  )  [inline, virtual]
 

Resizes a component to an absolute rect.

Implements iAwsComponent.

Definition at line 223 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetComponentAbove iAwsComponent cmp  )  [inline, virtual]
 

Set's the component above this one.

Implements iAwsComponent.

Definition at line 355 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetComponentBelow iAwsComponent cmp  )  [inline, virtual]
 

Set's the component below this one.

Implements iAwsComponent.

Definition at line 359 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetDeaf bool  isDeaf  )  [inline, virtual]
 

let the component listen to events or not

Implements iAwsComponent.

Definition at line 455 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetFlag unsigned int  flag  )  [inline, virtual]
 

Sets the flag (can handle multiple simultaneous sets).

Implements iAwsComponent.

Definition at line 160 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetFocus  )  [inline, virtual]
 

Sets component focused.

Implements iAwsComponent.

Definition at line 272 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetFocusable bool  focusable  )  [inline, virtual]
 

Set component can focus.

Implements iAwsComponent.

Definition at line 260 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetID unsigned long  id  )  [inline, virtual]
 

Set's the unique id of this component.

Note: only to be used by window manager.

Implements iAwsComponent.

Definition at line 234 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetLayout iAwsLayoutManager layoutMgr  )  [inline, virtual]
 

Set the layout manager.

Implements iAwsComponent.

Definition at line 427 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetParent iAwsComponent parent  )  [inline, virtual]
 

Sets the parent component of this component;.

Implements iAwsComponent.

Definition at line 343 of file awsecomp.h.

virtual void awsEmbeddedComponent::setPreferredSize const csRect size  )  [inline, virtual]
 

Set the preferred size of the component.

Implements iAwsComponent.

Definition at line 435 of file awsecomp.h.

virtual AWS_VOIDP_IS_WARNING bool awsEmbeddedComponent::SetProperty const char *  name,
void *  parm
[inline, virtual]
 

Sets the property specified to whatever is in parm.

Returns false if there's no such property.

Deprecated:
For proper 64-bit platform support, use the intptr_t version of SetProperty().

Implements iAwsComponent.

Definition at line 151 of file awsecomp.h.

virtual bool awsEmbeddedComponent::SetProperty const char *  name,
intptr_t  parm
[inline, virtual]
 

Sets the property specified, setting the proprty to whatever is in parm.

Returns false if there's no such property.

Implements iAwsComponent.

Definition at line 140 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetRedrawTag unsigned int  tag  )  [inline, virtual]
 

Sets the value of the redraw tag.

Implements iAwsComponent.

Definition at line 371 of file awsecomp.h.

virtual void awsEmbeddedComponent::SetTopChild iAwsComponent child  )  [inline, virtual]
 

Sets the top child.

Implements iAwsComponent.

Definition at line 503 of file awsecomp.h.

virtual bool awsEmbeddedComponent::Setup iAws wmgr,
iAwsComponentNode settings
[inline, virtual]
 

Sets up component.

Implements iAwsComponent.

Definition at line 105 of file awsecomp.h.

virtual void awsEmbeddedComponent::Show  )  [inline, virtual]
 

Shows a component.

Implements iAwsComponent.

Definition at line 207 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::TabNext iAwsComponent cmp  )  [inline, virtual]
 

Returns next component in tab order.

Implements iAwsComponent.

Definition at line 284 of file awsecomp.h.

virtual iAwsComponent* awsEmbeddedComponent::TabPrev iAwsComponent cmp  )  [inline, virtual]
 

Returns previous component in tab order.

Implements iAwsComponent.

Definition at line 288 of file awsecomp.h.

virtual const char* awsEmbeddedComponent::Type  )  [inline, virtual]
 

Returns the named TYPE of the component, like "Radio Button", etc.

This should always be overridden.

Implements iAwsComponent.

Definition at line 191 of file awsecomp.h.

virtual void awsEmbeddedComponent::Unlink  )  [inline, virtual]
 

Removes a component from the hierarchy.

Implements iAwsComponent.

Definition at line 491 of file awsecomp.h.

virtual void awsEmbeddedComponent::UnMaximize  )  [inline, virtual]
 

Returns the component to its unmaximized size.

Implements iAwsComponent.

Definition at line 249 of file awsecomp.h.

virtual bool awsEmbeddedComponent::UnregisterSlot iAwsSlot slot,
unsigned long  signal
[inline, virtual]
 

Unregisters a slot for a signal.

Implements iAwsSource.

Definition at line 67 of file awsecomp.h.

virtual void awsEmbeddedComponent::UnsetFocus  )  [inline, virtual]
 

Unsets component focused.

Implements iAwsComponent.

Definition at line 276 of file awsecomp.h.

iAwsComponent* awsEmbeddedComponent::Window  )  [inline, virtual]
 

Get's the window that this component resides in.

Implements iAwsComponent.

Definition at line 335 of file awsecomp.h.

iAws* awsEmbeddedComponent::WindowManager  )  [inline, virtual]
 

Get's this components idea of the window manager.

Should be used internally by the component ONLY, or by embedding classes.

Implements iAwsComponent.

Definition at line 331 of file awsecomp.h.


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