Woopsi 1.3
Nintendo DS Gui Framework
Classes | Public Member Functions | Protected Member Functions | Protected Attributes
WoopsiUI::AmigaWindow Class Reference

#include <libwoopsi/include/amigawindow.h>

Inheritance diagram for WoopsiUI::AmigaWindow:
WoopsiUI::Window WoopsiUI::GadgetEventHandler WoopsiUI::Gadget WoopsiUI::Alert WoopsiUI::ColourPicker WoopsiUI::FileRequester WoopsiUI::Requester

List of all members.

Classes

struct  AmigaWindowFlags

Public Member Functions

 AmigaWindow (s16 x, s16 y, u16 width, u16 height, const WoopsiString &title, bool showCloseButton, bool showDepthButton, GadgetStyle *style=NULL)
virtual void setBorderless (bool isBorderless)
virtual void handleReleaseEvent (const GadgetEventArgs &e)
virtual void showCloseButton ()
virtual void showDepthButton ()
virtual void hideCloseButton ()
virtual void hideDepthButton ()
virtual const bool hasCloseButton () const
virtual const bool hasDepthButton () const

Protected Member Functions

virtual void drawBorder (GraphicsPort *port)
virtual void onResize (u16 width, u16 height)
virtual void onFocus ()
virtual void onBlur ()
virtual void onClick (s16 x, s16 y)
virtual void createBorder ()
virtual void markBorderDirty ()
virtual ~AmigaWindow ()
 AmigaWindow (const AmigaWindow &amigaWindow)

Protected Attributes

AmigaWindowFlags _windowFlags
WindowBorderButton_closeButton
WindowBorderButton_depthButton

Detailed Description

Class providing a window that mimics the appearance of the windows from Amiga Workbench 3.x. It has a title bar and borders around the edge of the window, along with a depth button and (optional) close button.


Constructor & Destructor Documentation

WoopsiUI::AmigaWindow::AmigaWindow ( s16  x,
s16  y,
u16  width,
u16  height,
const WoopsiString title,
bool  showCloseButton,
bool  showDepthButton,
GadgetStyle style = NULL 
)

Constructor.

Parameters:
xThe x co-ordinate of the window, relative to its parent.
yThe y co-ordinate of the window, relative to its parent.
widthThe width of the window.
heightThe height of the window.
titleThe text that should appear in the title bar.
showCloseButtonTrue to show the window close button.
showDepthButtonTrue to show the z-order sorting button.
styleThe style that the gadget should use. If this is not specified, the gadget will use the values stored in the global defaultGadgetStyle object. The gadget will copy the properties of the style into its own internal style object.
virtual WoopsiUI::AmigaWindow::~AmigaWindow ( ) [inline, protected, virtual]

Destructor.

WoopsiUI::AmigaWindow::AmigaWindow ( const AmigaWindow amigaWindow) [inline, protected]

Copy constructor is protected to prevent usage.


Member Function Documentation

virtual void WoopsiUI::AmigaWindow::createBorder ( ) [protected, virtual]

Create the window's border.

virtual void WoopsiUI::AmigaWindow::drawBorder ( GraphicsPort port) [protected, virtual]

Draw the area of this gadget that falls within the clipping region. Called by the redraw() function to draw all visible regions.

Parameters:
portThe GraphicsPort to draw to.
See also:
redraw()

Reimplemented from WoopsiUI::Window.

virtual void WoopsiUI::AmigaWindow::handleReleaseEvent ( const GadgetEventArgs e) [virtual]

Handle events fired by decoration gadgets.

Parameters:
eEvent arguments to process.

Reimplemented from WoopsiUI::GadgetEventHandler.

Reimplemented in WoopsiUI::Alert, WoopsiUI::ColourPicker, WoopsiUI::FileRequester, and WoopsiUI::Requester.

virtual const bool WoopsiUI::AmigaWindow::hasCloseButton ( ) const [inline, virtual]

Does the window have a close button?

Returns:
True if the window has a close button.
virtual const bool WoopsiUI::AmigaWindow::hasDepthButton ( ) const [inline, virtual]

Does the window have a depth button?

Returns:
True if the window has a depth button.
virtual void WoopsiUI::AmigaWindow::hideCloseButton ( ) [virtual]

Hides the close button if it is visible. Has no effect if the window is borderless.

virtual void WoopsiUI::AmigaWindow::hideDepthButton ( ) [virtual]

Hides the depth button if it is hidden. Has no effect if the window is borderless.

virtual void WoopsiUI::AmigaWindow::markBorderDirty ( ) [protected, virtual]

Mark the visible border regions as dirty for redraw.

virtual void WoopsiUI::AmigaWindow::onBlur ( ) [protected, virtual]

Marks the borders for redraw,

Reimplemented from WoopsiUI::Gadget.

virtual void WoopsiUI::AmigaWindow::onClick ( s16  x,
s16  y 
) [protected, virtual]

Called when the gadget is clicked. Override this when creating new gadgets if the gadget should exhibit additional behaviour when it is clicked.

Parameters:
xThe x co-ordinate of the click.
yThe y co-ordinate of the click.

Reimplemented from WoopsiUI::Gadget.

virtual void WoopsiUI::AmigaWindow::onFocus ( ) [protected, virtual]

Raises the window to the top of the stack and marks its borders for redraw.

Reimplemented from WoopsiUI::Gadget.

virtual void WoopsiUI::AmigaWindow::onResize ( u16  width,
u16  height 
) [protected, virtual]

Resize the gadget to the new dimensions.

Parameters:
widthThe new width.
heightThe new height.

Reimplemented from WoopsiUI::Gadget.

Reimplemented in WoopsiUI::Alert, WoopsiUI::ColourPicker, WoopsiUI::FileRequester, and WoopsiUI::Requester.

virtual void WoopsiUI::AmigaWindow::setBorderless ( bool  isBorderless) [virtual]

Show or hide the Amiga borders.

Parameters:
isBorderlessTrue to enable borders, false to disable them.

Reimplemented from WoopsiUI::Gadget.

virtual void WoopsiUI::AmigaWindow::showCloseButton ( ) [virtual]

Shows the close button if it is hidden. Has no effect if the window is borderless.

virtual void WoopsiUI::AmigaWindow::showDepthButton ( ) [virtual]

Shows the depth button if it is hidden. Has no effect if the window is borderless.


Member Data Documentation

Pointer to the close button

Pointer to the depth button

AmigaWindow-specific flags


The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Enumerator