IFlyText

The IFlyText class displays short help messages for the window that the mouse is currently over.

The IFlyText control displays help messages in a bordered window that is sized just large enough to contain the help text. The window is positioned just below and to the right of the mouse pointer if possible. The text is displayed using one row and is not reflowed. The default font used to display the help messages is 8-point Helvetica.


IFlyText - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


[view class]
~IFlyText
public:
virtual ~IFlyText()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IFlyText
public:
IFlyText(unsigned long identifier, IWindow* owner)

Use this function to construct objects of the IFlyText class from a window identifier and an owning window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes

OS/2 Considerations

When running in an environment that supports bidirectional languages, such as Hebrew or Arabic, the bidirectional attributes of the window are copied from the owner window.

Windows Considerations

When running in an environment that supports bidirectional languages, such as Hebrew or Arabic, the text orientation of the window is copied from the owner window.


Colors

Use these members to set colors used by the IFlyText control.


[view class]
setBackgroundColor
public:
virtual IFlyText& setBackgroundColor(const IColor& color)

Set the background color for the flyover help text.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setForegroundColor
public:
virtual IFlyText& setForegroundColor(const IColor& color)

Set the foreground color for the flyover help text.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Text

Use these members to set the text of the IFlyText control.


[view class]
setText

Sets the control window text.


Overload 1
public:
virtual IFlyText& setText(const char* text)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
virtual IFlyText& setText(const IResourceId& text)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
text
Returns the flyover help text.
public:
virtual IString text() const
This function returns the current text for flyover help.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes

AIX Considerations
This is an AIX function only.

Window Painting

Use these members to determine the visibility of the control window.


[view class]
hide
public:
virtual IWindow& hide()

Hides the control window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Window Positioning

Use these members to get and set the position that the IFlyText control will position itself relative to.


[view class]
relativeWindowRect
public:
virtual IRectangle relativeWindowRect() const

Returns the rectangle of the control that the IFlyText control is positioned relative to.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setRelativeWindowRect
public:
virtual IFlyText& setRelativeWindowRect( const IRectangle& rect )

Sets the rectangle of the window for which the IFlyText control will position itself relative to. This rectangle should be relative to the desktop window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IFlyText - Inherited Member Functions and Data

Inherited Public Functions

IControl
INotifier
ITextControl
IWindow

Inherited Public Data

IWindow
INotifier
ITextControl

Inherited Protected Functions

IWindow
INotifier
IControl
ITextControl

Inherited Protected Data