BorderLayout Class Reference

#include <BorderLayout.hpp>

Inheritance diagram for BorderLayout:

Inheritance graph
[legend]
Collaboration diagram for BorderLayout:

Collaboration graph
[legend]
List of all members.

Detailed Description

Assists in arranging a new frame within a given one, with a margin.
Examples:

example11.cpp, and example13.cpp.

Definition at line 45 of file BorderLayout.hpp.

Public Member Functions

 BorderLayout (const Frame &frame, double marginSize)
 Constructor.
 BorderLayout (const Frame &frame, double xMarginSize, double yMarginSize)
 Constructor.
 BorderLayout (const Frame &frame, double leftMargin, double topMargin, double rightMargin, double bottomMargin)
 Constructor.
virtual int getFrameCount (void)
virtual Frame getFrame (int fnum)

Protected Attributes

std::vector< FrametargetList
 List containing the frames created in this layout.


Constructor & Destructor Documentation

BorderLayout const Frame frame,
double  marginSize
 

Constructor.

Parameters:
frame Outer frame.
marginSize Length in points between inner and outer frames

BorderLayout const Frame frame,
double  xMarginSize,
double  yMarginSize
 

Constructor.

Parameters:
frame Outer frame.
xMarginSize Border size between left and right parts of inner and outer frames
yMarginSize Border size between upper and lower parts of inner and outer frames

BorderLayout const Frame frame,
double  leftMargin,
double  topMargin,
double  rightMargin,
double  bottomMargin
 

Constructor.

Parameters:
frame Outer frame.
leftMargin Border size between left parts of inner and outer frames
topMargin Border size between upper parts of inner and outer frames
rightMargin Border size between right parts of inner and outer frames
bottomMargin Border size between bottom parts of inner and outer frames


Member Function Documentation

virtual Frame getFrame int  fnum  )  [inline, virtual]
 

Parameters:
fnum Frame index number
Returns:
The fnum-th frame

Reimplemented from Layout.

Definition at line 81 of file BorderLayout.hpp.

References targetList.

virtual int getFrameCount void   )  [inline, virtual]
 

Returns:
Number of frames contained in this layout.

Reimplemented from Layout.

Definition at line 78 of file BorderLayout.hpp.


Member Data Documentation

std::vector<Frame> targetList [protected]
 

List containing the frames created in this layout.

Definition at line 87 of file BorderLayout.hpp.

Referenced by getFrame().


The documentation for this class was generated from the following file:
Generated on Wed Feb 8 03:31:24 2012 for GPS ToolKit Software Library by  doxygen 1.3.9.1