AIPanelFlyoutMenuSuite Struct Reference
[API Suite List]

Provides functions for creating and managing panel flyout menus. More...

#include <AIPanel.h>

Public Attributes
AIAPI AIErr(*	Create )(AIPanelFlyoutMenuRef &outFlyOutMenu)
	Creates a new panel flyout menu or submenu.
AIAPI AIErr(*	Destroy )(AIPanelFlyoutMenuRef inFlyOutMenu)
	Deletes a panel flyout menu object.
AIAPI AIErr(*	Size )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 &outSize)
	Retrieves the number of items in a flyout menu.
AIAPI AIErr(*	AppendItem )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inNewItemID, const ai::UnicodeString &inItemText)
	Inserts a new item at the end of a panel flyout menu.
AIAPI AIErr(*	AppendSeparator )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inNewItemID)
	Inserts a separator in a panel flyout menu.
AIAPI AIErr(*	InsertItem )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inBeforeItemID, ai::uint32 inNewItemID, const ai::UnicodeString &inItemText)
	Inserts a new item at a specific relative position in a panel flyout menu.
AIAPI AIErr(*	InsertSeparator )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inBeforeItemID, ai::uint32 inNewItemID)
	Inserts a separator at a specific relative position in a panel flyout menu.
AIAPI AIErr(*	RemoveItem )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID)
	Removes an item or separator from a panel flyout menu.
AIAPI AIErr(*	SetItemEnabled )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIBoolean inEnabled)
	Enables or disables an item in a panel flyout menu.
AIAPI AIErr(*	GetItemEnabled )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIBoolean &outEnabled)
	Retrieves the enabled status of an item in a panel flyout menu.
AIAPI AIErr(*	SetItemMark )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIPanelFlyoutMenuItemMark inItemMark)
	Sets a mark on an item in a panel flyout menu.
AIAPI AIErr(*	GetItemMark )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIPanelFlyoutMenuItemMark &outItemMark)
	Retrieves the type of mark on an item in a panel flyout menu.
AIAPI AIErr(*	SetItemText )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, const ai::UnicodeString &inItemText)
	Sets the display text for an item in a panel flyout menu.
AIAPI AIErr(*	GetItemText )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, ai::UnicodeString &outItemText)
	Retrieves the display text for an item in a panel flyout menu.
AIAPI AIErr(*	IsItemSeparator )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemIndex, AIBoolean &outIsItemSeparator)
	Reports whether an item in a panel flyout menu is a separator.
AIAPI AIErr(*	SetItemSubMenu )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIPanelFlyoutMenuRef inSubMenu)
	Associates a submenu with an item in a panel flyout menu.
AIAPI AIErr(*	GetItemSubMenu )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIPanelFlyoutMenuRef &outSubMenu)
	Retrieves the submenu associated with an item in a panel flyout menu.
AIAPI AIErr(*	DetachItemSubMenu )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID)
	Removes any submenu associated with an item in a panel flyout menu.
AIAPI AIErr(*	SetItemID )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemIndex, ai::uint32 inNewItemID)
	Sets the unique identifier of an item in a panel flyout menu.
AIAPI AIErr(*	GetItemID )(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemIndex, ai::uint32 &outItemID)
	Retrieves the unique identifier of an item in a panel flyout menu.

Detailed Description

Provides functions for creating and managing panel flyout menus.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIPanelFlyoutMenuSuite and kAIPanelFlyoutMenuSuiteVersion.

Member Data Documentation

AIAPI AIErr(* AIPanelFlyoutMenuSuite::AppendItem)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inNewItemID, const ai::UnicodeString &inItemText)

Inserts a new item at the end of a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inNewItemID	The unique non-zero identifier for the new item.
	inItemText	The display text for the new item.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::AppendSeparator)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inNewItemID)

Inserts a separator in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inNewItemID	The unique non-zero identifier for the new separator.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::Create)(AIPanelFlyoutMenuRef &outFlyOutMenu)

Creates a new panel flyout menu or submenu.

Parameters:

outFlyOutMenu

[out] A buffer in which to return the new panel flyout menu object.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::Destroy)(AIPanelFlyoutMenuRef inFlyOutMenu)

Deletes a panel flyout menu object.

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

Parameters:

inFlyOutMenu

The panel flyout menu object.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::DetachItemSubMenu)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID)

Removes any submenu associated with an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::GetItemEnabled)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIBoolean &outEnabled)

Retrieves the enabled status of an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.
	outEnabled	[out] A buffer in which to return true if the item is enabled, false otherwise.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::GetItemID)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemIndex, ai::uint32 &outItemID)

Retrieves the unique identifier of an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemIndex	The 0-based index of the item.
	outItemID	[out] A buffer in which to return the ID

AIAPI AIErr(* AIPanelFlyoutMenuSuite::GetItemMark)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIPanelFlyoutMenuItemMark &outItemMark)

Retrieves the type of mark on an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.
	outItemMark	[out] A buffer in which to return the type constant (check, bullet, dash, or none).

AIAPI AIErr(* AIPanelFlyoutMenuSuite::GetItemSubMenu)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIPanelFlyoutMenuRef &outSubMenu)

Retrieves the submenu associated with an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.
	outSubMenu	[out] A buffer in which to return the submenu object.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::GetItemText)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, ai::UnicodeString &outItemText)

Retrieves the display text for an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.
	outItemText	[out] A buffer in which to return the text string.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::InsertItem)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inBeforeItemID, ai::uint32 inNewItemID, const ai::UnicodeString &inItemText)

Inserts a new item at a specific relative position in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inBeforeItemID	The ID of an existing item before which to insert the new item.
	inNewItemID	The unique non-zero identifier for the new item.
	inItemText	TThe display text for the new item.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::InsertSeparator)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inBeforeItemID, ai::uint32 inNewItemID)

Inserts a separator at a specific relative position in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inAfterID	The ID of an exsiting item after which to insert the separator, or -1 to append the separator to the end of the menu.
	inNewItemID	The unique non-zero identifier for the new separator.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::IsItemSeparator)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemIndex, AIBoolean &outIsItemSeparator)

Reports whether an item in a panel flyout menu is a separator.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemIndex	The 0-based index of the item.
	outIsItemSeparator	[out] A buffer in which to return true if the item is a separator, false otherwise.

Returns:: error

AIAPI AIErr(* AIPanelFlyoutMenuSuite::RemoveItem)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID)

Removes an item or separator from a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item or separator.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::SetItemEnabled)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIBoolean inEnabled)

Enables or disables an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.
	inEnabled	True to enable or false to disable the item.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::SetItemID)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemIndex, ai::uint32 inNewItemID)

Sets the unique identifier of an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemIndex	The 0-based index of the item.
	inNewItemID	The new unique non-zero item ID.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::SetItemMark)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIPanelFlyoutMenuItemMark inItemMark)

Sets a mark on an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.
	inItemMark	The mark type constant. Can be check, bullet, dash, or none.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::SetItemSubMenu)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, AIPanelFlyoutMenuRef inSubMenu)

Associates a submenu with an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.
	inSubMenu	A panel flyout menu object.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::SetItemText)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 inItemID, const ai::UnicodeString &inItemText)

Sets the display text for an item in a panel flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	inItemID	The unique identifier of the item.
	inItemText	The new text string.

AIAPI AIErr(* AIPanelFlyoutMenuSuite::Size)(AIPanelFlyoutMenuRef inFlyOutMenu, ai::uint32 &outSize)

Retrieves the number of items in a flyout menu.

Parameters:

	inFlyOutMenu	The panel flyout menu object.
	outSize	[out] A buffer in which to return the number of items.

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

AIPanel.h

AIPanelFlyoutMenuSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIPanelFlyoutMenuSuite Struct Reference
[API Suite List]