$treeview $search $mathjax
Stratagus  2.2.7
$projectbrief
$projectbrief
$searchbox
-->
         _________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

gcn::Window Class Reference

#include <window.h>

Inheritance diagram for gcn::Window:

gcn::BasicContainer gcn::MouseListener gcn::Widget Windows

List of all members.


Public Member Functions

 Window ()
 Window (const std::string &caption)
 Window (Widget *content, const std::string &caption="")
virtual ~Window ()
virtual void setCaption (const std::string &caption)
virtual const std::string & getCaption () const
virtual void setAlignment (unsigned int alignment)
virtual unsigned int getAlignment () const
virtual void setContent (Widget *widget)
virtual WidgetgetContent () const
virtual void setPadding (unsigned int padding)
virtual unsigned int getPadding () const
virtual void setTitleBarHeight (unsigned int height)
virtual unsigned int getTitleBarHeight ()
virtual void setMovable (bool movable)
virtual bool isMovable () const
virtual void resizeToContent ()
virtual void setOpaque (bool opaque)
virtual bool isOpaque ()
virtual void drawContent (Graphics *graphics)
virtual void moveToTop (Widget *widget)
virtual void moveToBottom (Widget *widget)
virtual void getDrawSize (int &width, int &height, Widget *widget)
virtual void _announceDeath (Widget *widget)
virtual void draw (Graphics *graphics)
virtual void drawBorder (Graphics *graphics)
virtual void logic ()
virtual void _mouseInputMessage (const MouseInput &mouseInput)
virtual void _mouseOutMessage ()
virtual void _setFocusHandler (FocusHandler *focusHandler)
virtual void mousePress (int x, int y, int button)
virtual void mouseRelease (int x, int y, int button)
virtual void mouseMotion (int x, int y)
virtual void setDirty (bool dirty)
virtual bool getDirty () const

Protected Member Functions

virtual void repositionContent ()
virtual Rectangle getContentDimension ()

Protected Attributes

std::string mCaption
unsigned int mAlignment
WidgetmContent
unsigned int mPadding
unsigned int mTitleBarHeight
bool mMouseDrag
int mMouseXOffset
int mMouseYOffset
bool mMovable
bool mOpaque

Detailed Description

A movable window which can conatin another Widget.

Constructor & Destructor Documentation

gcn::Window::Window (  ) 

Constructor.

gcn::Window::Window ( const std::string &  caption  ) 

Constructor.

Parameters:
caption the Window caption.

gcn::Window::Window ( Widget content,
const std::string &  caption = "" 
)

Constructor.

Parameters:
content the content Widget.
caption the Window caption.

gcn::Window::~Window (  )  [virtual]

Destructor.


Member Function Documentation

void gcn::Window::setCaption ( const std::string &  caption  )  [virtual]

Sets the Window caption.

Parameters:
caption the Window caption.

const std::string & gcn::Window::getCaption (  )  const [virtual]

Gets the Window caption.

Returns:
the Window caption.

void gcn::Window::setAlignment ( unsigned int  alignment  )  [virtual]

Sets the alignment for the caption.

Parameters:
alignment Graphics::LEFT, Graphics::CENTER or Graphics::RIGHT.

unsigned int gcn::Window::getAlignment (  )  const [virtual]

Gets the alignment for the caption.

Returns:
alignment of caption.

void gcn::Window::setContent ( Widget widget  )  [virtual]

Sets the content Widget.

Parameters:
widget the contant Widget.

Widget * gcn::Window::getContent (  )  const [virtual]

Gets the content Widget.

Returns:
the contant Widget.

void gcn::Window::setPadding ( unsigned int  padding  )  [virtual]

Sets the padding of the window which is the distance between the window border and the content.

Parameters:
padding the padding value.

unsigned int gcn::Window::getPadding (  )  const [virtual]

Gets the padding.

Returns:
the padding value.

void gcn::Window::setTitleBarHeight ( unsigned int  height  )  [virtual]

Sets the title bar height.

Parameters:
height the title height value.

unsigned int gcn::Window::getTitleBarHeight (  )  [virtual]

Gets the title bar height.

Returns:
the title bar height.

void gcn::Window::setMovable ( bool  movable  )  [virtual]

Sets the Window to be moveble.

Parameters:
movable true or false.

bool gcn::Window::isMovable (  )  const [virtual]

Check if the window is movable.

Returns:
true or false.

void gcn::Window::resizeToContent (  )  [virtual]

Resizes the window to fit the content.

void gcn::Window::setOpaque ( bool  opaque  )  [virtual]

Sets the Window to be opaque. If it's not opaque, the content area will not be filled with a color.

Parameters:
opaque true or false.

bool gcn::Window::isOpaque (  )  [virtual]

Checks if the Window is opaque.

Returns:
true or false.

void gcn::Window::drawContent ( Graphics graphics  )  [virtual]

Draws the content of the Window. This functions uses the getContentDimension to determin where to draw the content.

Parameters:
graphics a Graphics object to draw with.

void gcn::Window::moveToTop ( Widget widget  )  [virtual]

Moves a Widget to the top of the BasicContainer. The widget will be drawn above all other Widgets in the BasicContainer.

Parameters:
widget the Widget to move.

Implements gcn::BasicContainer.

void gcn::Window::moveToBottom ( Widget widget  )  [virtual]

Moves a widget to the bottom of the BasicContainer. The Widget will be drawn below all other Widgets in the BasicContainer.

Parameters:
widget the Widget to move.

Implements gcn::BasicContainer.

void gcn::Window::getDrawSize ( int &  width,
int &  height,
Widget widget 
) [virtual]

Gets the drawing space size a Widget has in the BasicContainer. It may not be the same size as the Widgets width and height.

NOTE: Size is not checked recursively all the way back to the top Widget. If the BasicContainer itself is clipped, the size may be inaccurate.

Parameters:
width the width the Widget's draw space has.
height the height the Widget's draw space has.
widget the Widget calling the function.

Implements gcn::BasicContainer.

void gcn::Window::_announceDeath ( Widget widget  )  [virtual]

Called when a child of the BasicContainer gets destroyed.

Parameters:
widget the destroyed Widget.

Implements gcn::BasicContainer.

void gcn::Window::draw ( Graphics graphics  )  [virtual]

Draws the Widget. It is called by the parent widget when it is time for the Widget to draw itself. The graphics object is set up so that all drawing is relative to the Widget, i.e coordinate (0,0) is the top-left corner of the Widget. It is not possible to draw outside of a Widgets dimension.

Parameters:
graphics a Graphics object to draw with.

Implements gcn::Widget.

void gcn::Window::drawBorder ( Graphics  )  [virtual]

Draws a the Widget border. A border is drawn around a Widget. The width and height of the border is therefore the Widgets height+2*bordersize. Think of a painting that has a certain size, the border surrounds the painting.

Parameters:
graphics a Graphics object to draw with.

Reimplemented from gcn::Widget.

void gcn::Window::logic (  )  [virtual]

Called for all Widgets in the gui each time Gui::logic is called. You can do logic stuff here like playing an animation.

See also:
Gui

Reimplemented from gcn::Widget.

void gcn::Window::_mouseInputMessage ( const MouseInput mouseInput  )  [virtual]

Called when a Widget recieves a MouseInput.

WARNING: This function is used internally to handle all mouse messages. Don't call or overload it unless you know what you are doing.

Parameters:
mouseInput the MouseInput message.

Reimplemented from gcn::Widget.

void gcn::Window::_mouseOutMessage (  )  [virtual]

Called when the mouse leaves the Widget area.

WARNING: This function is used internally be to handle mouse out messages. Don't call or overload this function unless you know what you are doing.

Reimplemented from gcn::Widget.

void gcn::Window::_setFocusHandler ( FocusHandler focusHandler  )  [virtual]

Sets the FocusHandler to be used.

WARNING: This function is used internally and should not be called or overloaded unless you know what you are doing.

Parameters:
focusHandler the FocusHandler to use.

Reimplemented from gcn::Widget.

void gcn::Window::mousePress ( int  ,
int  ,
int   
) [virtual]

Called when a mouse button is pressed when the mouse is in the Widget area or if the Widget has focus.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters:
x the x coordinate of the mouse relative to the Widget itself.
y the y coordinate of the mouse relative to the Widget itself.
button the button pressed.

Reimplemented from gcn::MouseListener.

void gcn::Window::mouseRelease ( int  ,
int  ,
int   
) [virtual]

Called when a mouse button is released when the mouse is in the Widget area or if the Widget has focus.

Parameters:
x the x coordinate of the mouse relative to the Widget itself.
y the y coordinate of the mouse relative to the Widget itself.
button the button released.

Reimplemented from gcn::MouseListener.

void gcn::Window::mouseMotion ( int  ,
int   
) [virtual]

Called when the mouse moves and the mouse is in the Widget area or if the Widget has focus.

Parameters:
x the x coordinate of the mouse relative to the Widget itself.
y the y coordinate of the mouse relative to the Widget itself.

Reimplemented from gcn::MouseListener.

void gcn::Window::setDirty ( bool  dirty  )  [virtual]

Reimplemented from gcn::Widget.

bool gcn::Window::getDirty (  )  const [virtual]

Reimplemented from gcn::Widget.

void gcn::Window::repositionContent (  )  [protected, virtual]

Moves the content to the top left corner of the window, uses getContentDimension to get the offset

Rectangle gcn::Window::getContentDimension (  )  [protected, virtual]

Gets the area in the window that the content occupies.


Member Data Documentation

std::string gcn::Window::mCaption [protected]

unsigned int gcn::Window::mAlignment [protected]

unsigned int gcn::Window::mPadding [protected]

unsigned int gcn::Window::mTitleBarHeight [protected]

bool gcn::Window::mMouseDrag [protected]

int gcn::Window::mMouseXOffset [protected]

int gcn::Window::mMouseYOffset [protected]

bool gcn::Window::mMovable [protected]

bool gcn::Window::mOpaque [protected]


The documentation for this class was generated from the following files:
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.