ui::layout::LayoutManager Class Reference

Inheritance diagram for ui::layout::LayoutManager:

Inheritance graph
[legend]
Collaboration diagram for ui::layout::LayoutManager:

Collaboration graph
[legend]
List of all members.

Detailed Description

Basic 'interface' for all LayoutManagers. LayoutManagers define and calculate how Components are laid out in a Container.


Public Member Functions

 LayoutManager ()
 LayoutManager (const LayoutManager &rhs)
LayoutManageroperator= (const LayoutManager &rhs)
void swap (LayoutManager &rhs) throw ()
virtual ~LayoutManager ()
int getVgap () const
int getHgap () const
void setHgap (int hGap)
void setVgap (int vGap)
virtual void layoutContainer (Container *parent)
virtual void addLayoutComponent (Component *comp, int constraint)
virtual void removeLayoutComponent (Component *comp)
virtual const util::Dimension preferredLayoutSize (const Container *parent) const


Constructor & Destructor Documentation

ui::layout::LayoutManager::LayoutManager  ) 
 

Creates a new LayoutManager.

ui::layout::LayoutManager::LayoutManager const LayoutManager rhs  ) 
 

Copy constructor.

ui::layout::LayoutManager::~LayoutManager  )  [virtual]
 

Destructor.


Member Function Documentation

LayoutManager & ui::layout::LayoutManager::operator= const LayoutManager rhs  ) 
 

Assignment operator.

void ui::layout::LayoutManager::swap LayoutManager rhs  )  throw ()
 

Swaps the contents of a LayoutManager.

int ui::layout::LayoutManager::getVgap  )  const
 

Returns the vertical spacing between Components.

int ui::layout::LayoutManager::getHgap  )  const
 

Returns the horizontal spacing between Components.

void ui::layout::LayoutManager::setHgap int  hGap  ) 
 

Sets the horizontal spacing between Components.

void ui::layout::LayoutManager::setVgap int  vGap  ) 
 

Sets the vertical spacing between Components.

virtual void ui::layout::LayoutManager::layoutContainer Container parent  )  [inline, virtual]
 

Lays out the Components in the given Container.

Parameters:
parent The Container which children need to be laid out.

Reimplemented in ui::layout::BorderLayout, ui::layout::FlowLayout, ui::layout::GridLayout, and ui::layout::PopupLayout.

virtual void ui::layout::LayoutManager::addLayoutComponent Component comp,
int  constraint
[inline, virtual]
 

Adds a Component to the LayoutManager with a specific constraint.

Parameters:
comp Component to be added to the LayoutManager.
constraint the constraint to use while laying out the Component.

Reimplemented in ui::layout::BorderLayout, and ui::layout::PopupLayout.

virtual void ui::layout::LayoutManager::removeLayoutComponent Component comp  )  [inline, virtual]
 

Removes the Component from this LayoutManager.

Parameters:
comp Component to remove from the LayoutManager.

Reimplemented in ui::layout::BorderLayout, and ui::layout::PopupLayout.

virtual const util::Dimension ui::layout::LayoutManager::preferredLayoutSize const Container parent  )  const [inline, virtual]
 

Returns the preferred Dimension the Container likes to have. This is used to calculate the preferredSize. It is not guarenteed to be used, but it could happen (one happy customer).

Parameters:
container Container to calculate and return the preferredSize from.
Returns:
The preferred size for the given Container.

Reimplemented in ui::layout::BorderLayout, ui::layout::FlowLayout, ui::layout::GridLayout, and ui::layout::PopupLayout.


Generated on Mon Jun 20 19:42:02 2005 for UI by doxygen 1.3.1 using KingsTools