CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csGridBagConstraint Class Reference
[Layouting]

Subclass of csLayoutConstraint for use with csGridBagLayout. More...

#include <csbaglay.h>

Inheritance diagram for csGridBagConstraint:

csLayoutConstraint List of all members.

Public Methods

csLayoutConstraintClone ()
 make a copy of this constraint


Public Attributes

int gridx
 gridx set column for next cell to add: RELATIVE ...

int gridy
 gridx set row for next cell to aad: RELATIVE ...

int gridwidth
 Set gridwidth to define the number of columns the cell spans.

int gridheight
 Set gridheight to define the number of rows the cell spans.

float weightx
 weightx defines how much space is added or substracted to a cell if the layout size changes.

float weighty
 weighty defines how much space is added or substracted to a cell if the layout size changes.

int anchor
 If you choose to not size the component to fit in a cell you can set the position of the component in a cell.

int fill
 To size the component to fit in cell set fill to BOTH.

csRect insets
 This adds additional space to the component width and height.

int ipadx
 ipadx preserves ipadx pixels between component and cell left and right edges.

int ipady
 ipady preserves ipady pixels between component and cell upper and lower edges.


Detailed Description

Subclass of csLayoutConstraint for use with csGridBagLayout.

Definition at line 38 of file csbaglay.h.


Member Function Documentation

csLayoutConstraint* csGridBagConstraint::Clone   [virtual]
 

make a copy of this constraint

Reimplemented from csLayoutConstraint.


Member Data Documentation

int csGridBagConstraint::anchor
 

If you choose to not size the component to fit in a cell you can set the position of the component in a cell.

Use the following values: CENTER ... center component in the middle of cell
WEST ... align component left horizontally and center vertically
NORTH ... center component horizontally and align on top of cell
EAST ... align component right horizontally and center vertically
SOUTH ... center component horizontally and align on bottom of cell to put it in the corner of the cell use the following
NORTHWEST ... upper left corner
NORTHEAST ... upper right corner
SOUTHEAST ... lower right corner
SOUTHWEST ... lower left corner

Definition at line 100 of file csbaglay.h.

int csGridBagConstraint::fill
 

To size the component to fit in cell set fill to BOTH.

This will scale the component vertical and horizontal. Set to HORIZONTAL or VERTICAL to scale component horizontal and vertical resp. To disallow scaling at all set to NONE.

Definition at line 107 of file csbaglay.h.

int csGridBagConstraint::gridheight
 

Set gridheight to define the number of rows the cell spans.

Set to REMAINDER to be the last cell on a column.

Definition at line 71 of file csbaglay.h.

int csGridBagConstraint::gridwidth
 

Set gridwidth to define the number of columns the cell spans.

Set to REMAINDER to be the last cell on a row.

Definition at line 66 of file csbaglay.h.

int csGridBagConstraint::gridx
 

gridx set column for next cell to add: RELATIVE ...

right behind last added
> 0 ... absolute column

Definition at line 54 of file csbaglay.h.

int csGridBagConstraint::gridy
 

gridx set row for next cell to aad: RELATIVE ...

same as last added or the next row if last gridwidth == REMAINDER
> 0 ... absolute row

Definition at line 61 of file csbaglay.h.

csRect csGridBagConstraint::insets
 

This adds additional space to the component width and height.

Definition at line 111 of file csbaglay.h.

int csGridBagConstraint::ipadx
 

ipadx preserves ipadx pixels between component and cell left and right edges.

Definition at line 116 of file csbaglay.h.

int csGridBagConstraint::ipady
 

ipady preserves ipady pixels between component and cell upper and lower edges.

Definition at line 121 of file csbaglay.h.

float csGridBagConstraint::weightx
 

weightx defines how much space is added or substracted to a cell if the layout size changes.

Additional space is given columnwise. For this the largest weightx in a column is determined and used for all cells in the column.

Definition at line 78 of file csbaglay.h.

float csGridBagConstraint::weighty
 

weighty defines how much space is added or substracted to a cell if the layout size changes.

Additional space is given rowwise. For this the largest weighty in a row is determined and used for all cells in the row.

Definition at line 85 of file csbaglay.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18