The UI Hooks suite is a set of utilities that allows a plug-in module to get and set certain values in the Photoshop. More...

Data Structures
struct	PSUIHooksSuite1
	The set of routines available in Version 1 of the UI Hooks Suite. More...
struct	PSUIHooksSuite2
	The set of routines available in Version 2 of the UI Hooks Suite. More...
struct	PSUIHooksSuite3
	The set of routines available in Version 3 of the UI Hooks Suite. More...
struct	PSUIHooksSuite4
	The set of routines available in Version 3 of the UI Hooks Suite. More...
Defines
#define	kPSUIHooksSuite "Photoshop UIHooks Suite for Plug-ins"
	Unique identifier for the UI Hooks Suite.
#define	kPSUIHooksSuiteVersion1 1
	UI Hooks Suite, version 1.
#define	kPSUIHooksSuiteVersion2 2
	UI Hooks Suite, version 2.
#define	kPSUIHooksSuiteVersion3 3
	UI Hooks Suite, version 3.
#define	kPSUIHooksSuiteVersion4 4
	UI Hooks Suite, version 3.
Typedefs
typedef const char *	PICursor_t
	Cursor ID.
typedef SPAPI SPErr(*	HostSetCursorProc )(const PICursor_t cursorID)
	Sets the host cursor.
typedef SPAPI intptr_t(*	MainAppWindowProc )(void)
	Gets a handle to the main application window for Windows.
typedef SPAPI uint32(*	HostTickCountProc )(void)
	Gets the tick count as 60 ticks per second.
typedef SPAPI SPErr(*	PluginNameProc )(SPPluginRef pluginRef, ASZString *pluginName)
	Gets the name of the plug-in as specified in `pluginRef`.
typedef SPAPI SPErr(*	SetPluginMenuEntryProc )(const SPPluginRef self, const ASZString menuEntry, const DescriptorEventID eventID)
	Sets the menu entry for the Last Filter, Undo, Redo, and History state for only the last filter event.
typedef SPAPI SPErr(*	GetLocalizedFileNameProc )(const ASZString inOriginalString, ASZString *outLocalizedString)
	Gets the "localized" version of the string using the runtime filename localization support; added for Elements 3 .
typedef SPAPI intptr_t(*	MainAppRootWindowProc )(void)
	Gets a handle to the Photoshop application frame window for Windows, regardless of what the actual front document window is.
UI Hooks Error Codes
#define	kPSCursorError '!cur'
	Invalid cursor ID.
#define	kPSNoLocalizedNameError '!LoC'
	Localized name not found.

Detailed Description

The UI Hooks suite is a set of utilities that allows a plug-in module to get and set certain values in the Photoshop.

The UI Hooks suite is available in Adobe Photoshop 5.0 and later.

Accessing the Suite

The UI Hooks suite is referred to as:

  #define kPSUIHooksSuite           "Photoshop UIHooks Suite for Plug-ins"

There are three versions of the UI Hooks Suite suite:

  #define kPSUIHooksSuiteVersion1       1 
  #define kPSUIHooksSuiteVersion2       2 
  #define kPSUIHooksSuiteVersion3       3

The suite is acquired as follows:

  PSUIHooksSuite3 *sPSUIHooks;

  // Get the most recent version.
  error = sSPBasic->AcquireSuite(kPSUIHooksSuite,
                                 kPSUIHooksSuiteVersion3,     
                                 &sPSUIHooks);

  if (error) goto . . . //handle error

For PICA errors, see SPErrorCodes.h.

Define Documentation

#define kPSUIHooksSuite "Photoshop UIHooks Suite for Plug-ins"

Unique identifier for the UI Hooks Suite.

#define kPSCursorError '!cur'

Invalid cursor ID.

#define kPSNoLocalizedNameError '!LoC'

Localized name not found.

#define kPSUIHooksSuiteVersion1 1

UI Hooks Suite, version 1.

#define kPSUIHooksSuiteVersion2 2

UI Hooks Suite, version 2.

#define kPSUIHooksSuiteVersion3 3

UI Hooks Suite, version 3.

#define kPSUIHooksSuiteVersion4 4

UI Hooks Suite, version 3.

Typedef Documentation

typedef const char* PICursor_t

Cursor ID.

Used with Photoshop Cursor IDs.

typedef SPAPI SPErr(* HostSetCursorProc)(const PICursor_t cursorID)

Sets the host cursor.

Parameters:

cursorID The ID of the cursor to set. See Photoshop Cursor IDs.

Returns:: kPSCursorError if invalid cursor.

typedef SPAPI intptr_t(* MainAppWindowProc)(void)

Gets a handle to the main application window for Windows.

This is the front-most window.

Returns:: Windows parent window HWND, NULL on Mac OS.

typedef SPAPI uint32(* HostTickCountProc)(void)

Gets the tick count as 60 ticks per second.

Returns:: The tick count.

typedef SPAPI SPErr(* PluginNameProc)(SPPluginRef pluginRef, ASZString *pluginName)

Gets the name of the plug-in as specified in pluginRef.

Parameters:

pluginRef	A reference to a plug-in. A plug-in reference is passed to the plug-in by the host through the plug-in parameter block, or through the message data for an automation plug-in.
pluginName	[OUT] The name of the plug-in.

Returns:: Non-zero error if failure.

typedef SPAPI SPErr(* SetPluginMenuEntryProc)(const SPPluginRef self,const ASZString menuEntry,const DescriptorEventID eventID)

Sets the menu entry for the Last Filter, Undo, Redo, and History state for only the last filter event.

This entry must be set it on each invocation, if you want it to persist.

Parameters:

self	Reference to calling (active) filter plug-in. Must refer to the current plug-in only. A plug-in reference is passed to the plug-in by the host through the plug-in parameter block, or through the message data for an automation plug-in.
menuEntry	Menu string to display in Undo, Redo, Last Filter, and History.
eventID	Event ID to use for any descriptor returned.

Returns:: Non-zero error if failure.

typedef SPAPI SPErr(* GetLocalizedFileNameProc)(const ASZString inOriginalString,ASZString *outLocalizedString)

Gets the "localized" version of the string using the runtime filename localization support; added for Elements 3 .

Parameters:

inOriginalString	String for which a localized version is requested.
outLocalizedString	[OUT] Returned localized string.

Returns:

kPSNoLocalizedNameError, if no localized name is found.
kSPUnimplementedError if the host does not support this function. Photoshop always returns kSPUnimplementedError.

typedef SPAPI intptr_t(* MainAppRootWindowProc)(void)

Gets a handle to the Photoshop application frame window for Windows, regardless of what the actual front document window is.

New in version 4.

Returns:: Windows parent window HWND, NULL on Mac OS.

Getting Started

SDK API Reference

SDK API Features

Other Documentation

Data Structures

Defines

Typedefs

UI Hooks Error Codes

Detailed Description

Define Documentation

Typedef Documentation