Library toolkit_lib: Class FlexContainer

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

FlexContainer is the base class for all Toolkit objects that can have children.

#include <toolkit/containr.h>

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

Class Data and Methods

Back to the top of FlexContainer

Ancestors

• FlexComponent

Back to the top of FlexContainer

Descendants

• AppBase
  • ShellAppBase
• FlexList
• FlexPanel
  • FlexHorizontalPanel
  • FlexVerticalPanel
• FlexScrollPane
• FlexTable
• FlexWindow
  • FlexDialog
  • FlexFrame

Back to the top of FlexContainer

USAGE

Back to the top of FlexContainer

Class constructor.

Parameters:

in isVisible

Set this to TRUE to make the FlexContainer visible.

Prototype:

    FlexContainer(Boolean isVisible = TRUE);

Back to the top of FlexContainer

~FlexContainer(void);

Class destructor. This calls RemoveLayout() to unlink the layout manager if any (without deleting it). It also removes AND deletes all of the external children (children added via the public API).

If a subclass supports internal children, the destructor for the subclass should take care of removing and deleting them.

Prototype:

    virtual ~FlexContainer(void);

Back to the top of FlexContainer

Result Add(FlexComponent *child);

Appends a child object to this container.

A child object can be added until the system runs out of memory or the maximun number of children (2^32-1) is reached.

This will invalidate the geometry of the container.

Parameters:

in child

The FlexComponent class object to add.

See also: Remove(), RemoveAll()

Prototype:

    virtual Result Add(FlexComponent *child);

Back to the top of FlexContainer

Result Add(FlexComponent *child, uint32 position);

Adds a child object to this container at the specified position. If the position is larger than the number of components in the container, the new child is appended.

A child object can be added until the system runs out of memory or the maximun number of children (2^32-1) is reached.

This will invalidate the geometry of the container.

Parameters:

in child

The component to add.

in position

The child`s index (zero-based).

See also: Remove(), RemoveAll()

Prototype:

    virtual Result Add(FlexComponent *child, uint32 position);

Back to the top of FlexContainer

Result Add(LayoutTagType tag, FlexComponent *child);

Adds a child object to this container using the specified layout tag.

Parameters:

in layoutTag

Enumerated type that tells the associated layout manager how to lay out this object.

in child

The component to add.

See also: Remove(), RemoveAll()

Prototype:

    virtual Result Add(LayoutTagType tag, FlexComponent *child);

Back to the top of FlexContainer

Result AddContainerListener(ContainerListenerInterface& listener);

Add a container listener to the FlexContainer object. The listener must be derived from ContainerListenerInterface in some form.

Parameters:

in listener

A ContainerListenerInterface object that is subclassed to intercept ContainerEvents.

See also: RemoveContainerListener()

Prototype:

    Result AddContainerListener(ContainerListenerInterface& listener);

Back to the top of FlexContainer

void DoLayout(void);

Lays out the container using the associated layout manager. This method has no effect if the container does not have a layout manager.

Application writers should avoid calling this method because it can interfere with the correct operation of the Geometry Management System.

This method is called when the container is validated as part of the Geometry Management Mechanism (an automated mechanism for keeping the UI properly laid out).

Specific UI writers may call this if a layout must be forced in order to solve some visual nuance problem.

See also: SetLayout(), GetLayout(), Validate()

Prototype:

    virtual void DoLayout(void);

Back to the top of FlexContainer

uint32 FindFlexComponent(FlexComponent *child);

Finds the index of the specified child.

Parameters:

in child

A pointer to a FlexComponent class object.

Prototype:

    uint32 FindFlexComponent(FlexComponent *child);

Back to the top of FlexContainer

FlexComponent *GetFlexComponent(uint32 position);

Returns the component at the specified position.

Parameters:

in position

The child`s index (zero-based).

See also: GetFlexComponents()

Prototype:

    virtual FlexComponent *GetFlexComponent(uint32 position);

Back to the top of FlexContainer

FlexComponent *GetFlexComponent(uint32 position, LayoutTagType& tag);

Returns the component at the specified position.

The tag output parameter will contain the layout tag associated with the returned child. If there is no child at the specified position, the tag parameter will be NT_NULL (which is not to be interpreted as an error value).

Parameters:

out tag

The layout tag of the returned component.

in position

The child`s index (zero-based).

See also: GetFlexComponents()

Prototype:

    virtual FlexComponent *GetFlexComponent(uint32 position,
                        LayoutTagType& tag);

Back to the top of FlexContainer

uint32 GetFlexComponentCount(void);

Gets the number of children in this container.

Return value: The number of children.

Prototype:

    virtual uint32 GetFlexComponentCount(void);

Back to the top of FlexContainer

FlexComponent** GetFlexComponents(void);

Gets a list of all children in the container. This list is in the form of an array of FlexComponent pointers. The caller must free the array.

Return value: The array of FlexComponent pointers, or NULL if the container has no children.

See also: GetFlexComponent()

Prototype:

    virtual FlexComponent** GetFlexComponents(void);

Back to the top of FlexContainer

FocusManagerInterface *GetFocusManager(void);

Gets the focus manager used by this container.

Return value: A pointer to the focus manager, or NULL if no focus manager is in use by the container.

Prototype:

    FocusManagerInterface *GetFocusManager(void);

Back to the top of FlexContainer

LayoutManagerInterface *GetLayout(void);

Gets the layout manager used by this container.

Return value: A pointer to the layout manager, or NULL if no layout manager is in use.

See also: SetLayout(), DoLayout()

Prototype:

    LayoutManagerInterface *GetLayout(void);

Back to the top of FlexContainer

LayoutTagType GetLayoutTag(uint32 position);

Returns the layout tag for the component at the specified position.

Parameters:

in position

Index of the component.

See also: SetLayoutTag(), Add()

Prototype:

    LayoutTagType GetLayoutTag(uint32 position);

Back to the top of FlexContainer

Insets GetInsets(void);

Gets the Insets used by this container. Insets are the border spaces at the top, left, right, and bottom edges of a container. These spaces are usually reserved for the FlexUI to draw the container`s title bar, menu bar, and visible borders.

Note: The insets value is set by the specific user interface and cannot be changed by the application writer.

Return value: Insets object.

Prototype:

    virtual Insets GetInsets(void);

Back to the top of FlexContainer

Result GetRelativeBounds(FlexComponent *descendant, WinRectangle &bounds);

Converts the bounds of a descendant into bounds relative to this container. A descendant is a component that is our child or a descendant of a child.

Parameters:

in descendant

A descendant within this container.

out bounds

Bounds of the component with respect to our coordinate system.

Prototype:

    Result GetRelativeBounds(FlexComponent *descendant,
                 WinRectangle &bounds);

Back to the top of FlexContainer

Result GetRelativeLocation(FlexComponent *descendant, WinXYPoint point, WinXYPoint &location);

Converts a location relative to a descendant into a location relative to this container. A descendant is a component that is our child or a descendant of a child.

Parameters:

in descendant

A descendant within this container.

in point

A point in the descendant coordinates.

out location

The location of the point with respect to our coordinate system.

Prototype:

    Result GetRelativeLocation(FlexComponent *descendant,
                   WinXYPoint point,
                   WinXYPoint &location);

Back to the top of FlexContainer

Boolean IsAncestorOf(FlexComponent *child);

Finds out if the specified component lies somewhere within this container`s child hierarchy (not necessarily as a direct child).

Parameters:

in child

Pointer to the component to test for.

Prototype:

    virtual Boolean IsAncestorOf(FlexComponent *child);

Back to the top of FlexContainer

FlexComponent *Remove(FlexComponent *child);

Removes a child from this container. This will invalidate the geometry of the container and the removed child.

Parameters:

in child

Pointer to component we`re removing.

See also: Add(), RemoveAll()

Prototype:

    virtual FlexComponent *Remove(FlexComponent *child);

Back to the top of FlexContainer

FlexComponent *Remove(uint32 position);

Removes the child at the specified position from this container. This will invalidate the geometry of the container and the removed child.

Parameters:

in position

Index of child to remove (zero-based).

See also: Add(), RemoveAll()

Prototype:

    virtual FlexComponent *Remove(uint32 position);

Back to the top of FlexContainer

void RemoveAll(void);

Removes all children from this container. This will invalidate the geometry of the container and the removed children.

See also: Add(), Remove()

Prototype:

    virtual void RemoveAll(void);

Back to the top of FlexContainer

void RemoveContainerListener(ContainerListenerInterface& listener);

Remove a container listener that has been added to this FlexContainer.

Parameters:

in listener

The container listener object that is being removed from this container.

See also: AddContainerListener()

Prototype:

    void RemoveContainerListener(ContainerListenerInterface& listener);

Back to the top of FlexContainer

FocusManagerInterface *RemoveFocusManager(void);

If this container has a focus manager, this method removes it and returns a pointer to it. This method does not delete the focus manager. It is the responsibility of the client using a container to free any focus managers allocated by that client.

Containers created through the UI factory might have a default focus manager. A client can remove this focus manager and replace it without having to delete the default focus manager. The UI factory will track and delete any focus managers that are provided by default.

Return value: A pointer to the focus manager that was removed, or NULL if the container does not have one.

Prototype:

    FocusManagerInterface *RemoveFocusManager(void);

Back to the top of FlexContainer

LayoutManagerInterface *RemoveLayout(void);

If this container has a layout manager, this method removes it and returns a pointer to it. This method does not delete the layout manager. It is the responsibility of the client using a container to free any layout managers allocated by that client.

Containers created through the UI factory might have a default layout manager. A client can remove this layout manager and replace it without having to delete the default layout manager. The UI factory will track and delete any layout managers that are provided by default.

Return value: A pointer to the layout manager that was removed, or NULL if the container does not have one.

See also: SetLayout(), GetLayout(), DoLayout()

Prototype:

    LayoutManagerInterface *RemoveLayout(void);

Back to the top of FlexContainer

void SetFocusManager(FocusManagerInterface *focusManager);

Sets the focus manager used by this container. This has no effect if the container already has a focus manager. You must remove an existing focus manager before setting a new one.

Parameters:

in focusManager

A pointer to the focus manager.

Prototype:

    void SetFocusManager(FocusManagerInterface *focusManager);

Back to the top of FlexContainer

void SetLayout(LayoutManagerInterface *layoutManager);

Sets the layout manager used by this container. This has no effect if the container already has a layout manager. You must remove an existing layout manager before setting a new one.

Parameters:

in layoutManager

A pointer to the layout manager.

Prototype:

    void SetLayout(LayoutManagerInterface *layoutManager);

Back to the top of FlexContainer

void SetLayoutTag(LayoutTagType tag, uint32 position);

Sets the layout tag for the component at the specified position.

Parameters:

in tag

Layout tag to set.

in position

Index of the affected child.

Prototype:

    void SetLayoutTag(LayoutTagType tag, uint32 position);

Back to the top of FlexContainer

void Validate(void);

Validates this FlexContainer and all of its children. When a container is validated, its DoLayout() method is called.

Application writers should avoid calling this method because it can interfere with the correct operation of the Geometry Management System.

This method is called by the Geometry Management Mechanism (an automated mechanism for keeping the UI laid out properly).

See also: FlexComponent::Invalidate(), DoLayout()

Prototype:

    virtual void Validate(void);

Back to the top of FlexContainer

void ProcessContainerEvent(ContainerEvent& containerEvent);

Process the container event for this container, passing the events to any registered ContainerEvent listeners.

Parameters:

in containerEvent

ContainerEvent object to describe the event.

Prototype:

    virtual void ProcessContainerEvent(ContainerEvent& containerEvent);

Back to the top of FlexContainer