$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::BasicContainer Class Reference

#include <basiccontainer.h>

Inheritance diagram for gcn::BasicContainer:

gcn::Widget gcn::Container gcn::DropDown gcn::ScrollArea gcn::Window MenuScreen DropDownWidget ListBoxWidget ScrollingWidget Windows

List of all members.


Public Member Functions

virtual ~BasicContainer ()
virtual void moveToTop (Widget *widget)=0
virtual void moveToBottom (Widget *widget)=0
virtual void getDrawSize (int &width, int &height, Widget *widget)=0
virtual void _announceDeath (Widget *widget)=0

Detailed Description

Containers base class. Contains basic container functions every container should have. Containers should inherit from this class and implement it's functions.

See also:
Container

Constructor & Destructor Documentation

virtual gcn::BasicContainer::~BasicContainer (  )  [inline, virtual]


Member Function Documentation

virtual void gcn::BasicContainer::moveToTop ( Widget widget  )  [pure 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.

Implemented in gcn::Container, gcn::DropDown, gcn::ScrollArea, and gcn::Window.

virtual void gcn::BasicContainer::moveToBottom ( Widget widget  )  [pure 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.

Implemented in gcn::Container, gcn::DropDown, gcn::ScrollArea, and gcn::Window.

virtual void gcn::BasicContainer::getDrawSize ( int &  width,
int &  height,
Widget widget 
) [pure 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.

Implemented in gcn::Container, gcn::DropDown, gcn::ScrollArea, and gcn::Window.

virtual void gcn::BasicContainer::_announceDeath ( Widget widget  )  [pure virtual]

Called when a child of the BasicContainer gets destroyed.

Parameters:
widget the destroyed Widget.

Implemented in gcn::Container, gcn::DropDown, gcn::ScrollArea, and gcn::Window.


The documentation for this class was generated from the following file:
(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.