AIPanel.h File Reference

#include "AITypes.h"
#include "IAIUnicodeString.h"
#include "IAIAutoBuffer.h"

Go to the source code of this file.

Classes
struct	AIPanelSuite
	Provides functions for creating and managing panels. More...
struct	AIPanelFlyoutMenuSuite
	Provides functions for creating and managing panel flyout menus. More...
Defines
#define	kAIPanelSuite   "AI Panel Suite"
#define	kAIPanelSuiteVersion3   AIAPI_VERSION(3)
#define	kAIPanelSuiteVersion   kAIPanelSuiteVersion3
#define	kAIPanelVersion   kAIPanelSuiteVersion
#define	kAIPanelFlyoutMenuSuite   "AI Panel Flyout Menu Suite"
#define	kAIPanelFlyoutMenuSuiteVersion2   AIAPI_VERSION(2)
#define	kAIPanelFlyoutMenuSuiteVersion   kAIPanelFlyoutMenuSuiteVersion2
#define	kAIPanelFlyoutMenuVersion   kAIPanelFlyoutMenuSuiteVersion
#define	kAIInvalidPanelRef   'INVD'
	Error Values return by the suite.
Typedefs
typedef HWND	AIPanelPlatformWindow
typedef struct _opaque_AIPanel *	AIPanelRef
	An opaque reference to a panel.
typedef struct _opaque_AIPanelFlyoutMenu *	AIPanelFlyoutMenuRef
	An opaque reference to a panel flyout menu.
typedef ai::uint32	AIPanelFlyoutMenuItemMark
	The glyph that marks a menu item as selected.
typedef void *	AIPanelUserData
	A developer-defined data object that can be associated with a panel.
typedef void AIAPI(*	AIPanelFlyoutMenuPreVisibilityProc )(AIPanelRef inPanel)
	Prototype of a function that is called before a panel's flyout menu is made visible.
typedef void AIAPI(*	AIPanelFlyoutMenuProc )(AIPanelRef inPanel, ai::uint32 itemID)
	Prototype of a function that is called after a panel's flyout menu has been shown.
typedef void AIAPI(*	AIPanelVisibilityChangedNotifyProc )(AIPanelRef inPanel, AIBoolean isVisible)
	Prototype of a function that is called after the visibility of a panel is changed.
typedef void AIAPI(*	AIPanelSizeChangedNotifyProc )(AIPanelRef inPanel)
	Prototype of a function that is called after the size of a panel is changed.
typedef void AIAPI(*	AIPanelStateChangedNotifyProc )(AIPanelRef inPanel, ai::int16 newState)
	Prototype of a function that is called after the state of a panel is changed.
typedef void AIAPI(*	AIPanelClosedNotifyProc )(AIPanelRef inPanel)
	Prototype of a function that is called after a panel is closed by clicking on the close button.
Enumerations
enum	{ kAIPanelFlyoutMenuItemMark_NONE, kAIPanelFlyoutMenuItemMark_CHECK, kAIPanelFlyoutMenuItemMark_BULLET, kAIPanelFlyoutMenuItemMark_DASH }
	Constants for the glyphs that mark a menu item as selected. More...

---

Detailed Description

---

Define Documentation

#define kAIPanelFlyoutMenuSuite   "AI Panel Flyout Menu Suite"

#define kAIPanelFlyoutMenuSuiteVersion   kAIPanelFlyoutMenuSuiteVersion2

#define kAIPanelFlyoutMenuSuiteVersion2   AIAPI_VERSION(2)

#define kAIPanelFlyoutMenuVersion   kAIPanelFlyoutMenuSuiteVersion

#define kAIPanelSuite   "AI Panel Suite"

#define kAIPanelSuiteVersion   kAIPanelSuiteVersion3

#define kAIPanelSuiteVersion3   AIAPI_VERSION(3)

#define kAIPanelVersion   kAIPanelSuiteVersion

---

Typedef Documentation

typedef void AIAPI(* AIPanelClosedNotifyProc)(AIPanelRef inPanel)

Prototype of a function that is called after a panel is closed by clicking on the close button.

Parameters:

inPanel

The panel object.

See also:

AIPanelSuite.

typedef ai::uint32 AIPanelFlyoutMenuItemMark

The glyph that marks a menu item as selected.

See AIPanelFlyoutMenuSuite.

typedef void AIAPI(* AIPanelFlyoutMenuPreVisibilityProc)(AIPanelRef inPanel)

Prototype of a function that is called before a panel's flyout menu is made visible.

Parameters:

inPanel

The panel object.

See also:

AIPanelFlyoutMenuSuite.

typedef void AIAPI(* AIPanelFlyoutMenuProc)(AIPanelRef inPanel, ai::uint32 itemID)

Prototype of a function that is called after a panel's flyout menu has been shown.

Parameters:

	inPanel	The panel object.
	itemID	The selected item ID. Zero value of itemID means user cancelled the menu without selecting any item.

See also:

AIPanelFlyoutMenuSuite.

typedef struct _opaque_AIPanelFlyoutMenu* AIPanelFlyoutMenuRef

An opaque reference to a panel flyout menu.

See AIPanelFlyoutMenuSuite.

typedef HWND AIPanelPlatformWindow

typedef struct _opaque_AIPanel* AIPanelRef

An opaque reference to a panel.

See AIPanelSuite.

typedef void AIAPI(* AIPanelSizeChangedNotifyProc)(AIPanelRef inPanel)

Prototype of a function that is called after the size of a panel is changed.

Parameters:

inPanel

The panel object.

See also:

AIPanelSuite.

typedef void AIAPI(* AIPanelStateChangedNotifyProc)(AIPanelRef inPanel, ai::int16 newState)

Prototype of a function that is called after the state of a panel is changed.

Parameters:

	inPanel	The panel object.
	newState	The new panel state

See also:

AIPanelSuite.

typedef void* AIPanelUserData

A developer-defined data object that can be associated with a panel.

See AIPanelSuite.

typedef void AIAPI(* AIPanelVisibilityChangedNotifyProc)(AIPanelRef inPanel, AIBoolean isVisible)

Prototype of a function that is called after the visibility of a panel is changed.

Parameters:

	inPanel	The panel object.
	isVisible	The new visibility of the panel

See also:

AIPanelSuite.

---

Enumeration Type Documentation

anonymous enum

Constants for the glyphs that mark a menu item as selected.

See AIPanelFlyoutMenuSuite.

Enumerator:

kAIPanelFlyoutMenuItemMark_NONE
kAIPanelFlyoutMenuItemMark_CHECK
kAIPanelFlyoutMenuItemMark_BULLET
kAIPanelFlyoutMenuItemMark_DASH