AIControlBarSuite Struct Reference
[API Suite List]

This suite provides functions for creating and managing control bars. More...

#include <AIControlBar.h>

Public Attributes
AIAPI AIErr(*	Create )(SPPluginRef inPluginRef, const AISize &inControlBarSize, AIReal inMinWidth, AIReal inMaxWidth, AIControlBarUserData inUserData, AIControlBarRef &outControlBar)
	Creates a new control-bar object.
AIAPI AIErr(*	Destroy )(AIControlBarRef inControlBar)
	Deletes a control bar object.
AIAPI AIErr(*	GetUserData )(AIControlBarRef inControlBar, AIControlBarUserData &outUserData)
	Retrieves developer-defined data associates with a control bar.
AIAPI AIErr(*	SetUserData )(AIControlBarRef inControlBar, AIControlBarUserData inUserData)
	Associates developer-defined data with a control bar, which can be used in developer-defined callbacks.
AIAPI AIErr(*	GetPlatformWindow )(AIControlBarRef inControlBar, AIControlBarPlatformWindow &outControlBarPlatformWindow)
	Retrieves the platform-specific window or view used for the control bar.
AIAPI AIErr(*	Show )(AIControlBarRef inControlBar, AIBoolean inShow)
	Shows or hides a control bar.
AIAPI AIErr(*	IsShown )(AIControlBarRef inControlBar, AIBoolean &outIsShown)
	Reports the current visibility state of a control bar.
AIAPI AIErr(*	GetWidth )(AIControlBarRef inControlBar, AIReal &outControlBarWidth)
	Retrieves the current width of control bar.
AIAPI AIErr(*	SetWidth )(AIControlBarRef inControlBar, AIReal inControlBarWidth)
	Sets the width of control bar.
AIAPI AIErr(*	GetMinimumWidth )(AIControlBarRef inControlBar, AIReal &outMinWidth)
	Retrieves the current minimum width of a control bar.
AIAPI AIErr(*	SetMinimumWidth )(AIControlBarRef inControlBar, AIReal inMinWidth)
	Sets the minimum width of a control bar.
AIAPI AIErr(*	GetMaximumWidth )(AIControlBarRef inControlBar, AIReal &outMaxWidth)
	Retrieves the current maximum width of a control bar.
AIAPI AIErr(*	SetMaximumWidth )(AIControlBarRef inControlBar, AIReal inMaxWidth)
	Sets the maximum width of a control bar.
AIAPI AIErr(*	Move )(AIControlBarRef inControlBar, const AIPoint &inPoint)
	Moves a control bar to a specific location.
AIAPI AIErr(*	SetVisibilityChangedNotifyProc )(AIControlBarRef inControlBar, AIControlBarVisibilityChangedNotifyProc inVisibilityChangedNotifyProc)
	Sets a callback procedure to call when the visibility of a control bar has changed.
AIAPI AIErr(*	SetSizeChangedNotifyProc )(AIControlBarRef inControlBar, AIControlBarSizeChangedNotifyProc inSizeChangedNotifyProc)
	Sets a callback procedure to call when the size of a control bar has changed.

Detailed Description

This suite provides functions for creating and managing control bars.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIControlBarSuite and kAIControlBarSuiteVersion.

Member Data Documentation

AIAPI AIErr(* AIControlBarSuite::Create)(SPPluginRef inPluginRef, const AISize &inControlBarSize, AIReal inMinWidth, AIReal inMaxWidth, AIControlBarUserData inUserData, AIControlBarRef &outControlBar)

Creates a new control-bar object.

Parameters:

	inPluginRef	The plug-in that is creating the control bar.
	inControlBarSize	Size of the new control bar.
	inMinWidth	Minimum width of the new control bar.
	inMaxWidth	Maximum width of the new control bar.
	inUserData	Developer-defined data to be associated with the control bar.
	outControlBar	[out] A buffer in which to return the new control-bar object.

AIAPI AIErr(* AIControlBarSuite::Destroy)(AIControlBarRef inControlBar)

Deletes a control bar object.

This must be called when the plug-in receives a shutdown notification, kAIApplicationShutdownNotifier.

Parameters:

inControlBar

The control bar object.

AIAPI AIErr(* AIControlBarSuite::GetMaximumWidth)(AIControlBarRef inControlBar, AIReal &outMaxWidth)

Retrieves the current maximum width of a control bar.

Parameters:

	inControlBar	The control bar object.
	outMaxWidth	[out] A buffer in which to return the maximum width value in pixels.

AIAPI AIErr(* AIControlBarSuite::GetMinimumWidth)(AIControlBarRef inControlBar, AIReal &outMinWidth)

Retrieves the current minimum width of a control bar.

Parameters:

	inControlBar	The control bar object.
	outMinWidth	[out] A buffer in which to return the minimum width value in pixels.

AIAPI AIErr(* AIControlBarSuite::GetPlatformWindow)(AIControlBarRef inControlBar, AIControlBarPlatformWindow &outControlBarPlatformWindow)

Retrieves the platform-specific window or view used for the control bar.

Parameters:

	inControlBar	The control bar object.
	outControlBarPlatformWindow	[out] A buffer in which to return the platform-specific window or view.

AIAPI AIErr(* AIControlBarSuite::GetUserData)(AIControlBarRef inControlBar, AIControlBarUserData &outUserData)

Retrieves developer-defined data associates with a control bar.

Parameters:

	inControlBar	The control Bar object.
	outUserData	[out] A buffer in which to return the developer-defined data.

AIAPI AIErr(* AIControlBarSuite::GetWidth)(AIControlBarRef inControlBar, AIReal &outControlBarWidth)

Retrieves the current width of control bar.

Parameters:

	inControlBar	The control bar object.
	outControlBarWidth	[out] A buffer in which to return the width value in pixels.

AIAPI AIErr(* AIControlBarSuite::IsShown)(AIControlBarRef inControlBar, AIBoolean &outIsShown)

Reports the current visibility state of a control bar.

Parameters:

	inControlBar	The control bar object.
	outIsShown	[out] A buffer in which to return true if the control bar is visible, false otherwise.

AIAPI AIErr(* AIControlBarSuite::Move)(AIControlBarRef inControlBar, const AIPoint &inPoint)

Moves a control bar to a specific location.

If the control bar is docked, does nothing.

Parameters:

	inControlBar	The control bar object.
	inPoint	The new position in global screen coordinates.

AIAPI AIErr(* AIControlBarSuite::SetMaximumWidth)(AIControlBarRef inControlBar, AIReal inMaxWidth)

Sets the maximum width of a control bar.

Parameters:

	inControlBar	The control bar object.
	inMaxWidth	The new maximum width in pixels; must be >= minWidth.

AIAPI AIErr(* AIControlBarSuite::SetMinimumWidth)(AIControlBarRef inControlBar, AIReal inMinWidth)

Sets the minimum width of a control bar.

Parameters:

	inControlBar	The control bar object.
	inMinWidth	The new minimum width in pixels; must be > 0 and <= maxWidth.

AIAPI AIErr(* AIControlBarSuite::SetSizeChangedNotifyProc)(AIControlBarRef inControlBar, AIControlBarSizeChangedNotifyProc inSizeChangedNotifyProc)

Sets a callback procedure to call when the size of a control bar has changed.

Parameters:

	inControlBar	The control bar object.
	inSizeChangedNotifyProc	The new callback procedure.

AIAPI AIErr(* AIControlBarSuite::SetUserData)(AIControlBarRef inControlBar, AIControlBarUserData inUserData)

Associates developer-defined data with a control bar, which can be used in developer-defined callbacks.

Parameters:

	inControlBar	The control bar object.
	inUserData	The developer-defined data.

AIAPI AIErr(* AIControlBarSuite::SetVisibilityChangedNotifyProc)(AIControlBarRef inControlBar, AIControlBarVisibilityChangedNotifyProc inVisibilityChangedNotifyProc)

Sets a callback procedure to call when the visibility of a control bar has changed.

Parameters:

	inControlBar	The control bar object.
	inVisibilityChangedNotifyProc	The new callback procedure.

AIAPI AIErr(* AIControlBarSuite::SetWidth)(AIControlBarRef inControlBar, AIReal inControlBarWidth)

Sets the width of control bar.

If the width is out of allowed bounds, returns an error.

Parameters:

	inControlBar	The control bar object.
	inControlBarWidth	The new width value in pixels. Must be >= minWidth and <= maxWidth.

AIAPI AIErr(* AIControlBarSuite::Show)(AIControlBarRef inControlBar, AIBoolean inShow)

Shows or hides a control bar.

Parameters:

	inControlBar	The control bar object.
	inShow	True to make the control bar visible, false to hide it.

The documentation for this struct was generated from the following file:

AIControlBar.h

AIControlBarSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIControlBarSuite Struct Reference
[API Suite List]