Library toolkit_lib: Class VerticalFlowLayout

All Classes, All Libraries

Index: A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

The VerticalFlowLayout class implements a layout manager that arranges components along a vertical line with a variety of spacing options.

#include <toolkit/lmvflow.h>

• Class Data and Methods
  • Inherited Data and Methods
• Ancestors
• Descendants
• OVERVIEW
• Descriptions of Class Data and Methods

Class Data and Methods

Back to the top of VerticalFlowLayout

Ancestors

• FlowLayout
  • LayoutManagerInterface

Back to the top of VerticalFlowLayout

Descendants

• InsetVerticalFlowLayout

Back to the top of VerticalFlowLayout

OVERVIEW

Horizontal alignment (LayoutManagerInterface::X_Align).

Specifies if the components should be left aligned, horizontally centered, or right aligned with respect to each other.

Vertical justification (VerticalFlowLayout::Y_Justify).

Specifies the vertical location of components within the container as a group and whether or not the spacing between them is fixed or variable.

Horizontal justification (VerticalFlowLayout::X_Justify).

Specifies the horizontal location of components within the container as a group

Back to the top of VerticalFlowLayout

These values control the vertical location of the components (as a group) within the container.

Y_JUSTIFY_TOP

Components are grouped near the top of the parent.

Y_JUSTIFY_CENTER

Components are grouped at the vertical center of the parent.

Y_JUSTIFY_BOTTOM

Components are grouped near the bottom of the parent.

Y_JUSTIFY_FULL

Components are spread out and all available vertical space is divided equally between them.

Y_JUSTIFY_FULL_WITH_ENDS

Same as Y_JUSTIFY_FULL, but an extra gap space is divided between the top/bottom ends of the flow. This preserves the center position of components if their sizes change.

Declared as:

enum {
        Y_JUSTIFY_TOP,
        Y_JUSTIFY_CENTER,
        Y_JUSTIFY_BOTTOM,
        Y_JUSTIFY_FULL,
        Y_JUSTIFY_FULL_WITH_ENDS
    } Y_Justify;

Back to the top of VerticalFlowLayout

enum X_Justify;

These values control the horizontal location of the components (as a group) within the container.

X_JUSTIFY_LEFT

Flow is grouped near the left edge.

X_JUSTIFY_CENTER

Flow is grouped at the vertical center.

X_JUSTIFY_RIGHT

Flow is grouped near the right edge.

Declared as:

enum {
        X_JUSTIFY_LEFT,
        X_JUSTIFY_CENTER,
        X_JUSTIFY_RIGHT
    } X_Justify;

Back to the top of VerticalFlowLayout

VerticalFlowLayout();

Constructs a VerticalFlowLayout with default settings.

Prototype:

    VerticalFlowLayout();

Back to the top of VerticalFlowLayout

VerticalFlowLayout(WinCoord gap, Y_Justify yjustify , X_Align align , X_Justify xjustify );

Constructs a VerticalFlowLayout with the specified settings.

Parameters:

in gap

Space to put between components.

in yjustify

Vertical justification of components.

in align

Horizontal alignment of components.

in xjustify

Horizontal justification of components.

Prototype:

    VerticalFlowLayout(WinCoord  gap,
                       Y_Justify yjustify = Y_JUSTIFY_CENTER,
                       X_Align   align    = X_ALIGN_CENTER,
                       X_Justify xjustify = X_JUSTIFY_CENTER);

Back to the top of VerticalFlowLayout

void EnforceMinimumSize(Boolean enforce);

Tells the flow whether to enforce a minimum size restriction on the container being laid out (it can't be smaller than the layout's preferred size). This is used for situations where the container might be resized by the user. If the minimum size is enforced, the user won't be able to make the container smaller than the layout but it could still be made larger if the container does not use its preferred size.

Parameters:

in enforce

TRUE to enforce minimum size.

Prototype:

    void EnforceMinimumSize(Boolean enforce);

Back to the top of VerticalFlowLayout

X_Align GetAlignment(void);

Returns the alignment being used.

Return value: X_Align value being used.

See also: SetAlignment()

Prototype:

    X_Align GetAlignment(void);

Back to the top of VerticalFlowLayout

X_Justify GetXJustification(void);

Returns the vertical justification being used.

Return value: Y_Justify value being used.

See also: SetXJustification()

Prototype:

    X_Justify GetXJustification(void);

Back to the top of VerticalFlowLayout

Y_Justify GetYJustification(void);

Returns the vertical justification being used.

Return value: Y_Justify value being used.

See also: SetYJustification()

Prototype:

    Y_Justify GetYJustification(void);

Back to the top of VerticalFlowLayout

Boolean IsMinimumSizeEnforced(void);

Finds out if the layout manager always enforces a minimum size (its preferred size) on the container. If a minimum size is enforced, the container can be larger but not smaller.

Return value: TRUE if minimum size is enforced.

See also: EnforceMinimumSize()

Prototype:

    Boolean IsMinimumSizeEnforced(void);

Back to the top of VerticalFlowLayout

void LayoutContainer(FlexContainer *parent);

Lays out a container.

Parameters:

in parent

Container to be laid out.

Prototype:

    virtual void LayoutContainer(FlexContainer *parent);

Back to the top of VerticalFlowLayout

Dimension MinimumLayoutSize(FlexContainer *parent);

Determines the minimum size of the passed container when laid out with this layout manager.

Parameters:

in parent

Pointer to the container to measure.

Overrides: LayoutManagerInterface::MinimumLayoutSize

Prototype:

    virtual Dimension MinimumLayoutSize(FlexContainer *parent);

Back to the top of VerticalFlowLayout

Dimension PreferredLayoutSize(FlexContainer *parent);

Determines the preferred size of the passed container when laid out with this layout manager.

Parameters:

in parent

Pointer to the container to measure.

Overrides: LayoutManagerInterface::PreferredLayoutSize

Prototype:

    virtual Dimension PreferredLayoutSize(FlexContainer *parent);

Back to the top of VerticalFlowLayout

void SetAlignment(X_Align align);

Sets the alignment to use.

Parameters:

in align

X_Align value to use.

Prototype:

    void SetAlignment(X_Align align);

Back to the top of VerticalFlowLayout

void SetXJustification(X_Justify xjustify);

Sets the horizontal justification to use.

Calling this will not cause the parent to become invalidated.

Parameters:

in xjustify

Horizontal justification of the components.

Prototype:

    void SetXJustification(X_Justify xjustify);

Back to the top of VerticalFlowLayout

void SetYJustification(Y_Justify yjustify);

Sets the vertical justification to use.

Calling this will not cause the parent to become invalidated.

Parameters:

in yjustify

Vertical justification of the components.

Prototype:

    void SetYJustification(Y_Justify yjustify);

Back to the top of VerticalFlowLayout

void SetOptions(X_Align align, Y_Justify yjustify, X_Justify xjustify , WinCoord gap );

Initializes an existing flow with the passed parameters. This does not cause any containers to become invalidated.

Parameters:

in align

Alignment of the flow components.

in yjustify

Vertical justification.

in xjustify

Horizontal justification.

in gap

Space to put between components.

Prototype:

    void SetOptions(X_Align   align, 
                    Y_Justify yjustify, 
                    X_Justify xjustify  = X_JUSTIFY_CENTER,
                    WinCoord  gap       = 5);

Back to the top of VerticalFlowLayout