$treeview $search $mathjax
Stratagus
2.2.6
$projectbrief
|
$projectbrief
|
$searchbox |
_________ __ __ / _____// |_____________ _/ |______ ____ __ __ ______ \_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/ / \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \ /_______ /|__| |__| (____ /__| (____ /\___ /|____//____ > \/ \/ \//_____/ \/ ______________________ ______________________ T H E W A R B E G I N S Stratagus - A free fantasy real time strategy game engine
#include <window.h>
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 Widget * | getContent () 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 |
Widget * | mContent |
unsigned int | mPadding |
unsigned int | mTitleBarHeight |
bool | mMouseDrag |
int | mMouseXOffset |
int | mMouseYOffset |
bool | mMovable |
bool | mOpaque |
gcn::Window::Window | ( | ) |
Constructor.
gcn::Window::Window | ( | const std::string & | caption | ) |
gcn::Window::Window | ( | Widget * | content, | |
const std::string & | caption = "" | |||
) |
gcn::Window::~Window | ( | ) | [virtual] |
Destructor.
void gcn::Window::setCaption | ( | const std::string & | caption | ) | [virtual] |
const std::string & gcn::Window::getCaption | ( | ) | const [virtual] |
void gcn::Window::setAlignment | ( | unsigned int | alignment | ) | [virtual] |
Sets the alignment for the caption.
alignment | Graphics::LEFT, Graphics::CENTER or Graphics::RIGHT. |
unsigned int gcn::Window::getAlignment | ( | ) | const [virtual] |
Gets the alignment for the caption.
void gcn::Window::setContent | ( | Widget * | widget | ) | [virtual] |
Widget * gcn::Window::getContent | ( | ) | const [virtual] |
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.
padding | the padding value. |
unsigned int gcn::Window::getPadding | ( | ) | const [virtual] |
Gets the padding.
void gcn::Window::setTitleBarHeight | ( | unsigned int | height | ) | [virtual] |
Sets the title bar height.
height | the title height value. |
unsigned int gcn::Window::getTitleBarHeight | ( | ) | [virtual] |
Gets the title bar height.
void gcn::Window::setMovable | ( | bool | movable | ) | [virtual] |
bool gcn::Window::isMovable | ( | ) | const [virtual] |
Check if the window is movable.
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.
opaque | true or false. |
bool gcn::Window::isOpaque | ( | ) | [virtual] |
void gcn::Window::drawContent | ( | Graphics * | graphics | ) | [virtual] |
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
std::string gcn::Window::mCaption [protected] |
unsigned int gcn::Window::mAlignment [protected] |
Widget* gcn::Window::mContent [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] |