IToolBarFrameWindow

The IToolBarFrameWindow class is used to contain floating toolbars.

IToolBarFrameWindows are created when a user constructs a toolbar with a location of floating or calls IToolBar::setLocation with a value of IToolBar::floating.

When a user closes a floating toolbar from the close item on the floating frame's system menu, the toolbar is hidden. This is done through a call to IToolBar::hide. Consequently, neither the floating frame, the toolbar, or the windows within the toolbar are destructed. You can re-show the toolbar with a call to IToolBar::show.

AIX Considerations

IToolBarFrameWindows do not contain the minimize or maximize/restore buttons. To expand and collapse the toolbar contained in the toolbar frame window, you must call IToolBar::expand:eref and IToolBar::collapse.

OS/2 Considerations

IToolBarFrameWindows are visually distinct from other frame windows in that the title bar height of IToolBarFrameWindows is smaller than other frame windows. In addition, there are two buttons that appear where the frame window's minimize and maximize buttons normally are.

The left button is a toggle button that allows you to pin or attach a toolbar frame window to its owning frame window. This has the effect that the toolbar stays in the same location relative to its owner when the owner is moved.

The right button allows you to expand and collapse the toolbar contained in the toolbar frame window. This allows you to shrink the toolbar to recover screen area when you are not actively using the toolbar and later expand the toolbar to show all toolbar controls.

Windows Considerations

The maximize/restore button on an IToolBarFrameWindow allows you to expand and collapse the toolbar contained in the toolbar frame window. This allows you to shrink the toolbar to recover screen area when you are not actively using the toolbar and later expand the toolbar to show all toolbar controls.


IToolBarFrameWindow - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IToolBarFrameWindow
public:
IToolBarFrameWindow( unsigned long windowId, IFrameWindow* owner )

Creates and IToolBarFrameWindow object with the specified window ID and the specified frame window as owner.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Styles

Use this function to convert style bits into a format recognized by the GUI.


[view class]
convertToGUIStyle
public:
virtual unsigned long convertToGUIStyle( const IBitFlag& style, bool extendedOnly = false ) const

Use this function to convert style bits into the style value that can be processed by the GUI. The default action is to return the base GUI style for the platform. Extended styles , those defined by the Open Class Library, can be returned by setting the extendedOnly parameter to true.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Title Text

Use these members to set or query the title text of an IToolBarFloatingFrame object.


[view class]
setTitleText

Sets the text of the toolbar frame's title bar.


Overload 1
public:
virtual IToolBarFrameWindow& setTitleText(const char* text)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
virtual IToolBarFrameWindow& setTitleText( const IResourceId& text )

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
titleText
public:
IString titleText() const

Returns the text of the toolbar frame's title bar.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IToolBarFrameWindow - Inherited Member Functions and Data

Inherited Public Functions

IFrameWindow
INotifier
IWindow

Inherited Public Data

IFrameWindow
IWindow
INotifier

Inherited Protected Functions

IFrameWindow
IWindow
INotifier

Inherited Protected Data

IFrameWindow