Public Types | Public Member Functions | Protected Member Functions | Protected Attributes

fl7::faces::Collection Class Reference

#include <Collection.h>

Inheritance diagram for fl7::faces::Collection:
fl7::faces::Face fl7::faces::Container fl7::faces::Fusion fl7::faces::GroupBox fl7::faces::DropDownBox fl7::faces::ListBox fl7::faces::Scrollable fl7::faces::ScrollBar fl7::faces::Window fl7::faces::Frame fl7::faces::Popup cyber::editor::gui::BaseWnd fl7::faces::Dialog fl7Wnd gui::ControlPanelWnd gui::FileMenuWnd gui::SettingsWnd gui::ToolboxWnd pl7::console::ConsoleWnd pl7::console::HintBox

List of all members.

Public Types

typedef std::vector< Face * > Childs
typedef std::vector< Face * >
::iterator 
ChildIterator

Public Member Functions

float GetChildLeft () const
float GetChildTop () const
float GetChildRight () const
float GetChildBottom () const
float GetChildWidth () const
float GetChildHeight () const
virtual ml7::Vector2 GetChildOffset () const
virtual ml7::Vector2 GetChildSize () const

Protected Member Functions

 Collection (const unsigned face_class_id, Shell *const shell, const Config::Face &cfg)
virtual ~Collection (void)
size_t _GetChildCount () const
Face_GetChild (size_t index) const
size_t _FindChild (Face *child) const
bool _ContainsChild (Face *child) const
bool _AddChild (Face *child)
bool _RemoveChild (Face *child)
void _RemoveAllChilds ()
Face_GetChildAt (const ml7::Vector2 &client_position) const
void InitializeChildFaces ()

Protected Attributes

float _child_left
float _child_top
float _child_right
float _child_bottom

Detailed Description

The base class for collections (containers such as windows, group boxes, etc.; and fusions like scroll bars, drop down boxes, etc.).


Member Typedef Documentation

typedef std::vector<Face*>::iterator fl7::faces::Collection::ChildIterator
typedef std::vector<Face*> fl7::faces::Collection::Childs

Constructor & Destructor Documentation

fl7::faces::Collection::Collection ( const unsigned  face_class_id,
Shell *const   shell,
const Config::Face cfg 
) [explicit, protected]

Explicit constructor.

fl7::faces::Collection::~Collection ( void   )  [protected, virtual]

Destructor.


Member Function Documentation

bool fl7::faces::Collection::_AddChild ( Face child  )  [protected]

Adds a given face as child face.

bool fl7::faces::Collection::_ContainsChild ( Face child  )  const [protected]

Checks whether a given face is contained as child face.

size_t fl7::faces::Collection::_FindChild ( Face child  )  const [protected]

Finds a given face if it is contained as child face and returns its index.

Face* fl7::faces::Collection::_GetChild ( size_t  index  )  const [inline, protected]

Returns a child face given by its index.

Face * fl7::faces::Collection::_GetChildAt ( const ml7::Vector2 client_position  )  const [protected]

Returns the ("first" visible) face at a given position in client coordinates.

size_t fl7::faces::Collection::_GetChildCount (  )  const [inline, protected]

Returns the number of underlying faces.

void fl7::faces::Collection::_RemoveAllChilds (  )  [protected]

Removes all child faces from this container.

bool fl7::faces::Collection::_RemoveChild ( Face child  )  [protected]

Removes a given child face.

float fl7::faces::Collection::GetChildBottom (  )  const [inline]

Returns the bottom offset of the child area.

float fl7::faces::Collection::GetChildHeight (  )  const [inline]

Returns the height of the child area.

float fl7::faces::Collection::GetChildLeft (  )  const [inline]

Returns the left offset of the child area.

virtual ml7::Vector2 fl7::faces::Collection::GetChildOffset (  )  const [inline, virtual]

Returns the offset of the child area in relation to the upper-left corner.

float fl7::faces::Collection::GetChildRight (  )  const [inline]

Returns the right offset of the child area.

virtual ml7::Vector2 fl7::faces::Collection::GetChildSize (  )  const [inline, virtual]

Returns the size of the child area.

float fl7::faces::Collection::GetChildTop (  )  const [inline]

Returns the top offset of the child area.

float fl7::faces::Collection::GetChildWidth (  )  const [inline]

Returns the width of the child area.

void fl7::faces::Collection::InitializeChildFaces (  )  [protected]

Call this method from the constructors of derived classes for initialization purposes of the child faces of this collection. This method also calls UpdateDisplay automatically. Unfortunately, InitializeChildFaces cannot be called automatically from the constructor of this collection base class, because it would then be called earlier than the constructor of any derived class. So, the concrete object instance would not have been constructed completely.


Member Data Documentation

The bottom offset of the child area.

The left offset of the child area.

The right offset of the child area.

The top offset of the child area.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines