Library toolkit_lib: Class FlexLabel

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

A component that displays a single line of read-only text.

This is an abstract class and cannot be directly instantiated.

#include <toolkit/label.h>

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

Class Data and Methods

Back to the top of FlexLabel

Ancestors

• FlexComponent

Back to the top of FlexLabel

Descendants

Back to the top of FlexLabel

The FlexLabelAlignment enum is used to set and get the default alignment of the label text.

FLA_LEFT

Left-align the label text.

FLA_CENTER

Center the label text.

FLA_RIGHT

Right-align the label text.

Declared as:

    enum FlexLabelAlignment {
	FLA_LEFT,
	FLA_CENTER,
	FLA_RIGHT
    };

Back to the top of FlexLabel

FlexLabel();

Class constructor.

Prototype:

    FlexLabel();

Back to the top of FlexLabel

Result AddTitleListener(TitleListenerInterface& listener);

Adds a TitleListener to receive draw events on the label. A TitleEvent is sent when the label needs to be drawn.

Parameters:

in listener

The TitleListener to add.

See also: RemoveTitleListener()

Prototype:

    Result AddTitleListener(TitleListenerInterface& listener);

Back to the top of FlexLabel

FlexLabelAlignment GetAlignment(void) const;

Returns the alignment of the label.

Return value: The alignment of the label.

See also: SetAlignment()

Prototype:

    FlexLabelAlignment GetAlignment(void) const;

Back to the top of FlexLabel

Dimension GetPreferredSize(void) ;

The GetPreferredSize method returns the preferred size of this component. The preferred size changes depending on the label text.

Return value: The preferred size of the label.

Prototype:

    virtual Dimension GetPreferredSize(void) = 0;

Back to the top of FlexLabel

const TCHAR *GetText(void);

The GetText method retrieves the label text.

Parameters:

Return value: A pointer to the label's text.

See also: SetText()

Prototype:

    const TCHAR *GetText(void);

Back to the top of FlexLabel

void RemoveTitleListener(TitleListenerInterface& listener);

Removes a TitleListener from this label component.

Parameters:

in listener

TitleListener to remove.

Prototype:

    void RemoveTitleListener(TitleListenerInterface& listener);

Back to the top of FlexLabel

void SetAlignment(const FlexLabelAlignment alignment);

Sets the alignment for this label to the specified alignment. Setting the alignment does not force a redraw of the component.

The default value is FLA_LEFT.

Parameters:

in alignment

The new FlexLabelAlignment.

Prototype:

    void SetAlignment(const FlexLabelAlignment alignment);

Back to the top of FlexLabel

void SetText(const TCHAR *text);

The SetText method sets the label text. The user is responsible for maintaining the memory for the text. There is no maximum length for the new label text. Setting the text will cause the FlexLabel to repaint. NULL is a legal parameter and causes a repaint of the FlexLabel with no text.

Parameters:

in *text

Points to the new label text.

Prototype:

    void SetText(const TCHAR *text);

Back to the top of FlexLabel