SkyGI::StyleView Class Reference

Inheritance diagram for SkyGI::StyleView:
[legend]
Collaboration diagram for SkyGI::StyleView:
[legend]
List of all members.

Public Member Functions

 StyleView (Window *pParent, const Rect rFrame, unsigned int nWindowLayoutFlags)
 ~StyleView ()
virtual void MouseDown (const InputEvent &nInputEvent)
virtual void MouseUp (const InputEvent &nInputEvent)
virtual void MouseEnter (const InputEvent &nInputEvent)
virtual void MouseLeave (const InputEvent &nInputEvent)
virtual void Paint (const Rect &rDirty)
void KeyDown (const InputEvent &nInputEvent)
void KeyUp (const InputEvent &nInputEvent)
bool LoadDocument (const String &szPath)
void Clear ()
void Add (const String &szText)

Classes

class  Private

Detailed Description

Examples:

styleview.cpp.


Constructor & Destructor Documentation

StyleView::StyleView ( Window pParent,
const Rect  rFrame,
unsigned int  nWindowLayoutFlags 
)

StyleView::~StyleView (  ) 


Member Function Documentation

void StyleView::MouseDown ( const InputEvent nInputEvent  )  [virtual]

Mouse pressed

Description:
This function gets called when a mouse press occured inside this window.
Overload this member function to react on mouse presses.
Parameters:
nButton - MouseButton which was pressed
nMouseButtonMask - Mask showing which mouse buttons were pressed when the mouse press occured
nInputEvent - INPUT_EVENT_MOUSE_PRESS for a single and INPUTE_EVENT_MOUSE_DOUBLECLICK for a doubleclick

Reimplemented from SkyGI::Window.

void StyleView::MouseUp ( const InputEvent nInputEvent  )  [virtual]

Mouse release

Description:
This function gets called when a mouse release occured inside this window.
Overload this member function to react on mouse releases.
Parameters:
nButton - MouseButton which was released
nMouseButtonMask - Mask showing which additional mouse buttons were pressed when the mouse release occured
nInputEvent - INPUT_EVENT_MOUSE_RELEASE

Reimplemented from SkyGI::Window.

void StyleView::MouseEnter ( const InputEvent nInputEvent  )  [virtual]

Mouse enter

Description:
This function gets called when the mouse first enters the window.
Overload this member function to react on mouse enter events.
Parameters:
pPosEnter - Position the mouse cursor entered the window
nMouseButtonMask - Mask showing which mouse buttons were pressed when the mouse enter occured

Reimplemented from SkyGI::Window.

void StyleView::MouseLeave ( const InputEvent nInputEvent  )  [virtual]

Mouse leave

Description:
This function gets called when the mouse leaves the window.
Overload this member function to react on mouse leave events.
Parameters:
pPosLeave - Position the mouse cursor leaved the window at
nMouseButtonMask - Mask showing which mouse buttons were pressed when the mouse leave occured

Reimplemented from SkyGI::Window.

void StyleView::Paint ( const Rect rDirty  )  [virtual]

Paint window content

Description:
This function gets called whenever an area of the window has to be redrawn. Usually you should only draw from inside the Paint function. If you need to redraw a window (when lets say some content must be updated), simply call Invalidate() which will then (asynchronly) call this paint function.

Usually you should draw the background using Window::DrawBackground(rDirty) and the border with DrawBorder(rRect). This way the user has full control over the appearance of your window, meaning he can change the background and border style.
The window content area itself is defined by the border margin and the window margin. Every window may define a margin. If you draw content into this window always make sure to not draw into the margin area. Additionally, the border has a margin too. As the user has full control to select any border for your window make sure to user the current borders margin when drawing window content. the dra Window::Paint() just redraws the background using DrawBackground. Overload this member function to add custom dawing code
Overload this member function to add custom dawing code
Parameters:
rDirty - Dirty rectangular region which has to be redrawn. Prior entering this function the painters clip region is automatically set to this dirty region.
See also:
DrawBorder, DrawBackground, Border, GetBorder, GetBorder::Margin, GetMargin

Reimplemented from SkyGI::Window.

void StyleView::KeyDown ( const InputEvent nInputEvent  )  [virtual]

Reimplemented from SkyGI::Window.

void StyleView::KeyUp ( const InputEvent nInputEvent  )  [virtual]

Reimplemented from SkyGI::Window.

bool StyleView::LoadDocument ( const String szPath  ) 

void StyleView::Clear (  ) 

void StyleView::Add ( const String szText  ) 


Generated on Thu Dec 13 18:14:44 2007 for SkyGI by  doxygen 1.5.1-p1