AISymbolPaletteSuite Struct Reference
[API Suite List]

These functions access and manipulate the currency and selection state of symbols. More...

#include <AISymbol.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetCurrentSymbol )(AIPatternHandle *symbolPattern)
	Retrieves the current symbol.
AIAPI AIErr(*	SetCurrentSymbol )(AIPatternHandle symbolPattern)
	Makes a symbol current.
AIAPI AIBoolean(*	IsSymbolSelected )(AIPatternHandle symbolPattern)
	Reports the selection state of a symbol.
AIAPI ai::int32(*	CountSelectedSymbols )(void)
	Counts selected symbols.
AIAPI AIErr(*	GetNthSelectedSymbol )(ai::int32 n, AIPatternHandle *symbolPattern)
	Retrieves a selected symbol by position index.
AIAPI AIBoolean(*	IsPaletteVisible )(void)
	Reports whether the Symbol palette is visible.

---

Detailed Description

These functions access and manipulate the currency and selection state of symbols.

The suite is exported by the Symbols palette, which is not a required plug-in, so it can be unavailable. Selection and currency of symbols is not otherwise supported.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAISymbolPaletteSuite and kAISymbolPaletteVersion.

---

Member Data Documentation

AIAPI ai::int32(* AISymbolPaletteSuite::CountSelectedSymbols)(void)

Counts selected symbols.

Use with GetNthSelectedSymbol() to iterate through selected symbols. (Note that this function returns a numeric value, not an error code.)

Returns:

The number of selected symbols.

AIAPI AIErr(* AISymbolPaletteSuite::GetCurrentSymbol)(AIPatternHandle *symbolPattern)

Retrieves the current symbol.

Parameters:

symbolPattern

[out] A buffer in which to return the symbol reference.

AIAPI AIErr(* AISymbolPaletteSuite::GetNthSelectedSymbol)(ai::int32 n, AIPatternHandle *symbolPattern)

Retrieves a selected symbol by position index.

Use with CountSelectedSymbols() to iterate through selected symbols.

Parameters:

	n	The 0-based position index.
	symbolPattern	[out] A buffer in which to return the symbol reference.

AIAPI AIBoolean(* AISymbolPaletteSuite::IsPaletteVisible)(void)

Reports whether the Symbol palette is visible.

(Note that this function returns a Boolean value, not an error code.)

Returns:

True if the Symbol palette is shown.

AIAPI AIBoolean(* AISymbolPaletteSuite::IsSymbolSelected)(AIPatternHandle symbolPattern)

Reports the selection state of a symbol.

(Note that this function returns a Boolean value, not an error code.)

Parameters:

symbolPattern

The symbol reference.

Returns:

True if the symbol is selected.

AIAPI AIErr(* AISymbolPaletteSuite::SetCurrentSymbol)(AIPatternHandle symbolPattern)

Makes a symbol current.

Parameters:

symbolPattern

The symbol reference.

---

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

• AISymbol.h