uiWindow Class Reference

Base class for GUI windows. More...

#include <uiWindow.h>

Inheritance diagram for uiWindow:
laLoadableObj uiSkinUser uiContainer uiHR uiIcon3D uiLabel uiProgress uiChoiceDialog uiDesktop uiInventory uiMenu_JR uiRadio uiSlidingButton uiWatch uiButton uiEdit uiSlider

Public Member Functions

 uiWindow (void)
 Class constructor.
M_BOOL isMouseInside ()
 Helpful function that checks if the mouse pointer is inside the window.
virtual void move (laPoint3 ptNewPos, unsigned nHReference=M_AL, unsigned nVReference=M_AT)
 Change window position.
Create/Destroy the window
virtual void create (laPoint3 pos, laPoint3 size)
 Create new empty window.
virtual void kill ()
 Discard window and all children.
virtual void load (class laFileParser *fp)
 Load a dialog layout form .cui file.
Implementation of interactivity and rendering for the GUI window
virtual void reply ()
 Handle input message.
virtual void draw ()
 Display the window.
Get/Set window flags
virtual void show ()
virtual void hide ()
bool isVisible ()
void enable ()
void disable ()
bool isEnabled ()
Get/Set window identifier
unsigned long getID ()
void setID (unsigned long id)
Getting window position and size
laPoint3 getPos ()
 Get relative window position with regard to parent.
laPoint3 getAbsolutePos ()
 Get absolute window position.
laPoint3 getSize ()
laPoint3 getDecorationSize ()
Virtual event handlers
virtual void onMouseIn ()
virtual void onMouseOut ()
virtual void onMouseMove (laPoint3 ptRelativePos)
virtual void onDown (unsigned nButton)
virtual void onUp (unsigned nButton)
virtual void onClick (unsigned nButton)
virtual void onCommand (unsigned long uID, unsigned long nCmd)
 Command event handler.

Protected Member Functions

laPoint3 getRelativePointerPos ()
 Get mouse pointer position relative to window position.

Static Protected Member Functions

static uiPointergetMousePointer ()
 Enables children to get a pointer to the mouse pointer, but not to change it.

Protected Attributes

 Pointer to parent window, if any.
bool _bVisible
 Window visibility flag.
bool _bEnabled
 Window interactivity flag.
Window poisiton and size
laPoint3 _ptPos
 Windos position (relative to parent)
laPoint3 _ptSize
 Window size.
laPoint3 _ptDecorationSize
 Size of border elements; defaults to 0.


class uiDesktop
class uiContainer
class uiSlider

Additional Inherited Members

- Static Protected Attributes inherited from uiSkinUser
static uiSkin_pSkin = NULL

Detailed Description

Base class for GUI windows.

This class implements the basic functionality of a GUI "window". It provides window positioning, sizing and hierachy functions; It tracks the input device and provides virtual event handlers for the mouse and for custom commands.

Atanas Ivaylov Laskov

Definition at line 45 of file uiWindow.h.

The documentation for this class was generated from the following files: