AIPanelSuite Struct Reference
[API Suite List]

Provides functions for creating and managing panels. More...

#include <AIPanel.h>

Public Attributes
AIAPI AIErr(*	Create )(SPPluginRef inPluginRef, const ai::UnicodeString &inID, const ai::UnicodeString &inTitle, ai::int16 inStateCount, const AISize &inMinSize, AIBoolean isResizable, AIPanelFlyoutMenuRef inFlyoutMenu, AIPanelUserData inUserData, AIPanelRef &outPanel)
	Creates a new panel.
AIAPI AIErr(*	Destroy )(AIPanelRef inPanel)
	Deletes a panel object.
AIAPI AIErr(*	GetPlatformWindow )(AIPanelRef inPanel, AIPanelPlatformWindow &outPlatformWindow)
	Retrieves the platform-specific window/view used for the panel.
AIAPI AIErr(*	Show )(AIPanelRef inPanel, AIBoolean inShow)
	Shows or hides the panel.
AIAPI AIErr(*	IsShown )(AIPanelRef inPanel, AIBoolean &outIsShown)
	Reports the effective visibility of a panel.
AIAPI AIErr(*	GetUserData )(AIPanelRef inPanel, AIPanelUserData &outUserData)
	Retrieves developer-defined data from a panel.
AIAPI AIErr(*	SetUserData )(AIPanelRef inPanel, AIPanelUserData inUserData)
	Associates developer-defined data with a panel, which can be used in developer-defined callbacks.
AIAPI AIErr(*	SetTitle )(AIPanelRef inPanel, const ai::UnicodeString &inTitle)
	Sets a panel title.
AIAPI AIErr(*	GetTitle )(AIPanelRef inPanel, ai::UnicodeString &outTitle)
	Retrieves the panel title.
AIAPI AIErr(*	SetIcon )(AIPanelRef inPanel, const ai::AutoBuffer< const ai::uint8 * > &inPNGData, const ai::AutoBuffer< ai::uint32 > &inDataSize, const ai::AutoBuffer< const ai::uint8 * > &inPNGDarkData, const ai::AutoBuffer< ai::uint32 > &inDarkDataSize)
	Sets the icon to be used when a panel is collapsed.
AIAPI AIErr(*	SetIconResourceID )(AIPanelRef inPanel, const ai::AutoBuffer< ai::uint32 > &iconResId, const ai::AutoBuffer< ai::uint32 > &darkIconResId)
AIAPI AIErr(*	SetSVGIconResourceID )(AIPanelRef inPanel, ai::uint32 iconResId, ai::uint32 darkIconResId)
	Sets the SVG icon to be used when a panel is collapsed, using an existing resource.
AIAPI AIErr(*	GetSize )(AIPanelRef inPanel, AISize &outSize)
	Retrieves the inner dimensions of the current panel, which excludes the frame, title, and any platform-specific decorations.
AIAPI AIErr(*	SetMinimumSize )(AIPanelRef inPanel, const AISize &inMinimumSize)
	Sets the minimum size for a panel's inner dimensions.
AIAPI AIErr(*	GetMinimumSize )(AIPanelRef inPanel, AISize &outMinimumSize)
	Retrieves the minimum minimum size for a panel's inner dimensions.
AIAPI AIErr(*	SetMaximumSize )(AIPanelRef inPanel, const AISize &inMaximumSize)
	Sets the maximum size for a panel's inner dimensions.
AIAPI AIErr(*	GetMaximumSize )(AIPanelRef inPanel, AISize &outMaximumSize)
	Retrieves the maximum size for a panel's inner dimensions.
AIAPI AIErr(*	SetPreferredSizes )(AIPanelRef inPanel, const AISize &inPreferredSize)
	Sets both the constrained and unconstrained preferred sizes for a panel's inner dimensions.
AIAPI AIErr(*	SetSizes )(AIPanelRef inPanel, const AISize &inMinimumSize, const AISize &inPreferredUnconstrainedSize, const AISize &inPreferredConstrainedSize, const AISize &inMaximumSize)
	Sets all sizes at once for a panel's inner dimensions.
AIAPI AIErr(*	SetSize )(AIPanelRef inPanel, const AISize &inSize)
	For non-resizable panels, sets the minimum, maximum, preferred unconstrained, and preferred constrained sizes for a panel's inner dimensions to a single size value.
AIAPI AIErr(*	GetPreferredConstrainedSize )(AIPanelRef inPanel, AISize &outPreferredConstrainedSize)
	Retrieves the preferred constrained size for a panel's inner dimensions.
AIAPI AIErr(*	GetPreferredUnconstrainedSize )(AIPanelRef inPanel, AISize &outPreferredUnconstrainedSize)
	Retrieves the preferred unconstrained size for a panel's inner dimensions.
AIAPI AIErr(*	SetCurrentState )(AIPanelRef inPanel, ai::int16 inCurrentState)
	Sets the current state of a panel.
AIAPI AIErr(*	GetCurrentState )(AIPanelRef inPanel, ai::int16 &outCurrentState)
	Retrieves the current state of a panel.
AIAPI AIErr(*	SetStateCount )(AIPanelRef inPanel, ai::int16 inStateCount)
	Modifies the state count of a panel.
AIAPI AIErr(*	GetStateCount )(AIPanelRef inPanel, ai::int16 &outStateCount)
	Retrieves the state count of a panel.
AIAPI AIErr(*	SetVerticalStepSize )(AIPanelRef inPanel, AIReal inStepSize)
	Sets the vertical step size to use when a resizable panel is resized.
AIAPI AIErr(*	GetVerticalStepSize )(AIPanelRef inPanel, AIReal &outStepSize)
	Retrieves the vertical step size for a panel.
AIAPI AIErr(*	SetFlyoutMenu )(AIPanelRef inPanel, AIPanelFlyoutMenuRef inFlyoutMenu)
	Sets the flyout menu for a panel.
AIAPI AIErr(*	GetFlyoutMenu )(AIPanelRef inPanel, AIPanelFlyoutMenuRef &outFlyoutMenu)
	Retrieves the flyout menu for a panel.
AIAPI AIErr(*	IsMinimized )(AIPanelRef inPanel, AIBoolean &outIsMinimized)
	Reports the minimized state of a panel.
AIAPI AIErr(*	ChangeIsMinimized )(AIPanelRef inPanel, AIBoolean inIsMinimized)
	Modifies the minimized state of the panel.
AIAPI AIErr(*	Move )(AIPanelRef inPanel, AIPoint inPoint)
	Moves a panel to a specific screen location.
AIAPI AIErr(*	SetFlyoutMenuPreVisibilityProc )(AIPanelRef inPanel, AIPanelFlyoutMenuPreVisibilityProc inFlyoutMenuPreVisProc)
	Sets a callback procedure to be called before the flyout menu for a panel is shown.
AIAPI AIErr(*	SetFlyoutMenuProc )(AIPanelRef inPanel, AIPanelFlyoutMenuProc inFlyoutMenuProc)
	Sets a callback procedure to be called after the flyout menu for a panel has been shown.
AIAPI AIErr(*	SetVisibilityChangedNotifyProc )(AIPanelRef inPanel, AIPanelVisibilityChangedNotifyProc inVisibilityChangedNotifyProc)
	Sets a callback procedure to be called when the visibility of a panel is changed.
AIAPI AIErr(*	SetSizeChangedNotifyProc )(AIPanelRef inPanel, AIPanelSizeChangedNotifyProc inSizeChangedNotifyProc)
	Sets a callback procedure to be called when the size of a panel is changed.
AIAPI AIErr(*	SetStateChangedNotifyProc )(AIPanelRef inPanel, AIPanelStateChangedNotifyProc inStateChangedNotifyProc)
	Sets a callback procedure to be called when the state of a panel is changed.
AIAPI AIErr(*	SetClosedNotifyProc )(AIPanelRef inPanel, AIPanelClosedNotifyProc inPanelClosedNotifyProc)
	Set a callback procedure to be called when a panel is closed by clicking the close button.
AIAPI AIErr(*	GetPosition )(AIPanelRef inPanelRef, AIRealRect &outRect)
	Get Panel Global Rect.

Detailed Description

Provides functions for creating and managing panels.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIPanelSuite and kAIPanelSuiteVersion.

Member Data Documentation

AIAPI AIErr(* AIPanelSuite::ChangeIsMinimized)(AIPanelRef inPanel, AIBoolean inIsMinimized)

Modifies the minimized state of the panel.

Parameters:

	inPanel	The panel object.
	inIsMinimized	True to minimize the panel, false to return it to the unminimized state.

AIAPI AIErr(* AIPanelSuite::Create)(SPPluginRef inPluginRef, const ai::UnicodeString &inID, const ai::UnicodeString &inTitle, ai::int16 inStateCount, const AISize &inMinSize, AIBoolean isResizable, AIPanelFlyoutMenuRef inFlyoutMenu, AIPanelUserData inUserData, AIPanelRef &outPanel)

Creates a new panel.

Parameters:

	inPluginRef	The plug-in that creates the panel.
	inID	A unique identifier for the new panel.
	inTitle	The title of the panel.
	inStateCount	The number of host layouts for the panel; must be at least 1.
	inMinSize	Minimum size of the panel.
	isResizable	True to make the panel resizable.
	inFlyoutMenu	The flyout menu for the panel, or NULL to hide the flyout icon.
	inUserData	Developer-defined data to be associated with the panel.
	outPanel	[out] A buffer in which to return the new panel object.

AIAPI AIErr(* AIPanelSuite::Destroy)(AIPanelRef inPanel)

Deletes a panel object.

This must be called when the plug-in receives kAIApplicationShutdownNotifier.

Parameters:

inPanel

The panel object.

AIAPI AIErr(* AIPanelSuite::GetCurrentState)(AIPanelRef inPanel, ai::int16 &outCurrentState)

Retrieves the current state of a panel.

Parameters:

	inPanel	The panel object.
	outCurrentState	[out] A buffer in which to return the state value.

AIAPI AIErr(* AIPanelSuite::GetFlyoutMenu)(AIPanelRef inPanel, AIPanelFlyoutMenuRef &outFlyoutMenu)

Retrieves the flyout menu for a panel.

Parameters:

	inPanel	The panel object.
	outFlyoutMenu	[out] A buffer in which to return the flyout menu object.

See also:: AIPanelFlyoutMenuSuite.

AIAPI AIErr(* AIPanelSuite::GetMaximumSize)(AIPanelRef inPanel, AISize &outMaximumSize)

Retrieves the maximum size for a panel's inner dimensions.

Parameters:

	inPanel	The panel object.
	outMaximumSize	[out] A buffer in which to return the size value.

AIAPI AIErr(* AIPanelSuite::GetMinimumSize)(AIPanelRef inPanel, AISize &outMinimumSize)

Retrieves the minimum minimum size for a panel's inner dimensions.

Parameters:

	inPanel	The panel object.
	outMinimumSize	[out] A buffer in which to return the size value.

AIAPI AIErr(* AIPanelSuite::GetPlatformWindow)(AIPanelRef inPanel, AIPanelPlatformWindow &outPlatformWindow)

Retrieves the platform-specific window/view used for the panel.

Parameters:

	inPanel	The panel object.
	outPlatformWindow	The platform specific window/view of the panel

AIAPI AIErr(* AIPanelSuite::GetPosition)(AIPanelRef inPanelRef, AIRealRect &outRect)

Get Panel Global Rect.

Parameters:

	inPanel	The panel object.
	outRect	OutRect.

AIAPI AIErr(* AIPanelSuite::GetPreferredConstrainedSize)(AIPanelRef inPanel, AISize &outPreferredConstrainedSize)

Retrieves the preferred constrained size for a panel's inner dimensions.

The constrained size is used when a dialog is frame docked.

Parameters:

	inPanel	The panel object.
	outPreferredConstrainedSize	[out] A buffer in which to return the size value.

AIAPI AIErr(* AIPanelSuite::GetPreferredUnconstrainedSize)(AIPanelRef inPanel, AISize &outPreferredUnconstrainedSize)

Retrieves the preferred unconstrained size for a panel's inner dimensions.

The unconstrained size is used when the dialog is floating.

Parameters:

	inPanel	The panel object.
	outPreferredUnconstrainedSize	[out] A buffer in which to return the size value.

AIAPI AIErr(* AIPanelSuite::GetSize)(AIPanelRef inPanel, AISize &outSize)

Retrieves the inner dimensions of the current panel, which excludes the frame, title, and any platform-specific decorations.

Parameters:

	inPanel	The panel object.
	outSize	[out] A buffer in which to return the size value.

AIAPI AIErr(* AIPanelSuite::GetStateCount)(AIPanelRef inPanel, ai::int16 &outStateCount)

Retrieves the state count of a panel.

Parameters:

	inPanel	The panel object.
	outStateCount	[out] A buffer in which to return the state-count value.

AIAPI AIErr(* AIPanelSuite::GetTitle)(AIPanelRef inPanel, ai::UnicodeString &outTitle)

Retrieves the panel title.

Parameters:

	inPanel	The panel object.
	outTitle	[out] A buffer in which to return the title string.

AIAPI AIErr(* AIPanelSuite::GetUserData)(AIPanelRef inPanel, AIPanelUserData &outUserData)

Retrieves developer-defined data from a panel.

Parameters:

	inPanel	The panel object.
	outUserData	[out] A buffer in which to return developer-defined data associated with the panel.

AIAPI AIErr(* AIPanelSuite::GetVerticalStepSize)(AIPanelRef inPanel, AIReal &outStepSize)

Retrieves the vertical step size for a panel.

Parameters:

	inPanel	The panel object.
	outStepSize	[out] A buffer in which to return the size value.

AIAPI AIErr(* AIPanelSuite::IsMinimized)(AIPanelRef inPanel, AIBoolean &outIsMinimized)

Reports the minimized state of a panel.

When a panel is minimized its content area is not visible, and the panel view has a visible height of 0.

Parameters:

	inPanel	The panel object.
	outIsMinimized	[out] A buffer in which to return true if the panel is minimized, false otherwise.

AIAPI AIErr(* AIPanelSuite::IsShown)(AIPanelRef inPanel, AIBoolean &outIsShown)

Reports the effective visibility of a panel.

If the panel is part of a tabbed group but is not the frontmost tab, it is not considered visible.

Parameters:

	inPanel	The panel object.
	outIsShown	[out] A buffer in which to return the Boolean output; True if the panel is effectively visible, False otherwise.

AIAPI AIErr(* AIPanelSuite::Move)(AIPanelRef inPanel, AIPoint inPoint)

Moves a panel to a specific screen location.

Has no effect if the panel is docked. If the panel is part of a tab group, the whole tab group is moved to the new location.

Parameters:

	inPanel	The panel object.
	inPoint	The new position in global screen coordinates.

AIAPI AIErr(* AIPanelSuite::SetClosedNotifyProc)(AIPanelRef inPanel, AIPanelClosedNotifyProc inPanelClosedNotifyProc)

Set a callback procedure to be called when a panel is closed by clicking the close button.

Parameters:

	inPanel	The panel object.
	inPanelClosedNotifyProc	The new callback procedure.

AIAPI AIErr(* AIPanelSuite::SetCurrentState)(AIPanelRef inPanel, ai::int16 inCurrentState)

Sets the current state of a panel.

Parameters:

	inPanel	The panel object.
	inCurrentState	The new current state, must be at least 1.

AIAPI AIErr(* AIPanelSuite::SetFlyoutMenu)(AIPanelRef inPanel, AIPanelFlyoutMenuRef inFlyoutMenu)

Sets the flyout menu for a panel.

Parameters:

	inPanel	The panel object.
	inFlyoutMenu	The new menu, or NULL to hide the menu icon.

See also:: AIPanelFlyoutMenuSuite.

AIAPI AIErr(* AIPanelSuite::SetFlyoutMenuPreVisibilityProc)(AIPanelRef inPanel, AIPanelFlyoutMenuPreVisibilityProc inFlyoutMenuPreVisProc)

Sets a callback procedure to be called before the flyout menu for a panel is shown.

Parameters:

	inPanel	The panel object.
	inFlyoutMenuPreVisProc	The new callback procedure.

AIAPI AIErr(* AIPanelSuite::SetFlyoutMenuProc)(AIPanelRef inPanel, AIPanelFlyoutMenuProc inFlyoutMenuProc)

Sets a callback procedure to be called after the flyout menu for a panel has been shown.

Parameters:

	inPanel	The panel object.
	inFlyoutMenuPostVisProc	The new callback procedure.

AIAPI AIErr(* AIPanelSuite::SetIcon)(AIPanelRef inPanel, const ai::AutoBuffer< const ai::uint8 * > &inPNGData, const ai::AutoBuffer< ai::uint32 > &inDataSize, const ai::AutoBuffer< const ai::uint8 * > &inPNGDarkData, const ai::AutoBuffer< ai::uint32 > &inDarkDataSize)

Sets the icon to be used when a panel is collapsed.

Only PNG icons can be used.

Parameters:

	inPanel	The panel object.
	inPNGData	The PNG resource data for the icon.
	inDataSize	The size of the resource data in bytes.
	inPNGDarkData	The PNG resource data for an alternate icon, to be used in "dark" mode.
	inDarkDataSize	The size of the alternate resource data in bytes.

AIAPI AIErr(* AIPanelSuite::SetIconResourceID)(AIPanelRef inPanel, const ai::AutoBuffer< ai::uint32 > &iconResId, const ai::AutoBuffer< ai::uint32 > &darkIconResId)

Deprecated:: . Use AIPanelSuite::SetSVGIconResourceID() Sets the icon to be used when a panel is collapsed, using an existing resource. Only PNG icons can be used.

Parameters:

	inPanel	The panel object.
	iconResId	The resource identifier of a PNG icon.
	darkIconcResId	The resource identifier of an alternate PNG icon for "dark" mode.

AIAPI AIErr(* AIPanelSuite::SetMaximumSize)(AIPanelRef inPanel, const AISize &inMaximumSize)

Sets the maximum size for a panel's inner dimensions.

Parameters:

	inPanel	The panel object.
	inMaximumSize	The size value.

AIAPI AIErr(* AIPanelSuite::SetMinimumSize)(AIPanelRef inPanel, const AISize &inMinimumSize)

Sets the minimum size for a panel's inner dimensions.

Parameters:

	inPanel	The panel object.
	inMinimumSize	The size value.

AIAPI AIErr(* AIPanelSuite::SetPreferredSizes)(AIPanelRef inPanel, const AISize &inPreferredSize)

Sets both the constrained and unconstrained preferred sizes for a panel's inner dimensions.

The constrained size is used when a dialog is frame docked. The unconstrained size is used when the dialog is floating.

Parameters:

	inPanel	The panel object.
	inPreferredSize	The new preferred size value.

AIAPI AIErr(* AIPanelSuite::SetSize)(AIPanelRef inPanel, const AISize &inSize)

For non-resizable panels, sets the minimum, maximum, preferred unconstrained, and preferred constrained sizes for a panel's inner dimensions to a single size value.

For resizable panels, sets only the preferred unconstrained and constrained sizes to the given size.

Parameters:

	inPanel	The panel object.
	inSize	The new size value.

AIAPI AIErr(* AIPanelSuite::SetSizeChangedNotifyProc)(AIPanelRef inPanel, AIPanelSizeChangedNotifyProc inSizeChangedNotifyProc)

Sets a callback procedure to be called when the size of a panel is changed.

Parameters:

	inPanel	The panel object.
	inSizeChangedNotifyProc	The new callback procedure.

AIAPI AIErr(* AIPanelSuite::SetSizes)(AIPanelRef inPanel, const AISize &inMinimumSize, const AISize &inPreferredUnconstrainedSize, const AISize &inPreferredConstrainedSize, const AISize &inMaximumSize)

Sets all sizes at once for a panel's inner dimensions.

Parameters:

	inPanel	The panel object.
	inMinimumSize	Minimum panel size.
	inPreferredUnconstrainedSize	Preferred unconstrained panel size. .
	inPreferredConstrainedSize	Preferred constrained panel size.
	inMaximumSize	Maximum panel size.

Returns:: error

AIAPI AIErr(* AIPanelSuite::SetStateChangedNotifyProc)(AIPanelRef inPanel, AIPanelStateChangedNotifyProc inStateChangedNotifyProc)

Sets a callback procedure to be called when the state of a panel is changed.

Parameters:

	inPanel	The panel object.
	inStateChangedNotifyProc	The new callback procedure.

AIAPI AIErr(* AIPanelSuite::SetStateCount)(AIPanelRef inPanel, ai::int16 inStateCount)

Modifies the state count of a panel.

Parameters:

	inPanel	The panel object.
	inStateCount	The new state count; must be at least 1

AIAPI AIErr(* AIPanelSuite::SetSVGIconResourceID)(AIPanelRef inPanel, ai::uint32 iconResId, ai::uint32 darkIconResId)

Sets the SVG icon to be used when a panel is collapsed, using an existing resource.

Parameters:

	inPanel	The panel object.
	iconResId	The resource identifier of a SVG icon in 2x scale factor.
	darkIconResId	The resource identifier of a SVG icon for "dark" mode in 2x scale factor.

AIAPI AIErr(* AIPanelSuite::SetTitle)(AIPanelRef inPanel, const ai::UnicodeString &inTitle)

Sets a panel title.

Parameters:

	inPanel	The panel object.
	inTitle	The new title of the panel

AIAPI AIErr(* AIPanelSuite::SetUserData)(AIPanelRef inPanel, AIPanelUserData inUserData)

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

Parameters:

	inPanel	The panel object.
	inUserData	The developer-defined data.

AIAPI AIErr(* AIPanelSuite::SetVerticalStepSize)(AIPanelRef inPanel, AIReal inStepSize)

Sets the vertical step size to use when a resizable panel is resized.

The panel height is constrained to be its minimum height plus a multiple of the vertical step size. By default, this is 1, making the panel sizable to any height.

Parameters:

	inPanel	The panel object.
	inStepSize	The new step size.

AIAPI AIErr(* AIPanelSuite::SetVisibilityChangedNotifyProc)(AIPanelRef inPanel, AIPanelVisibilityChangedNotifyProc inVisibilityChangedNotifyProc)

Sets a callback procedure to be called when the visibility of a panel is changed.

Parameters:

	inPanel	The panel object.
	inVisibilityChangedNotifyProc	The new callback procedure.

AIAPI AIErr(* AIPanelSuite::Show)(AIPanelRef inPanel, AIBoolean inShow)

Shows or hides the panel.

If the panel is part of a tab group, the whole group is affected

Parameters:

	inPanel	The panel object.
	inShow	True to make panel visible, false to hide it

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

AIPanel.h

AIPanelSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIPanelSuite Struct Reference
[API Suite List]