Getting Started

SDK API Reference

SDK API Features

Other Documentation

PIUIHooksSuite.h File Reference

Detailed Description

This file contains all the public definitions and structures related to user interface elements.

Use the UIHooks suite to get the main application window (on Windows), access a handful of Photoshop cursors, and similar utilities.

Distribution: PUBLIC

#include "PIGeneral.h"
#include "PIActions.h"
#include "SPTypes.h"

Go to the source code of this file.


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...

UI Hooks Error Codes

#define kPSCursorError   '!cur'
 Invalid cursor ID.
#define kPSNoLocalizedNameError   '!LoC'
 Localized name not found.

Defines

#define kPSUIHooksSuite   "Photoshop UIHooks Suite for Plug-ins"
 Unique identifier for the UI Hooks Suite.
#define kPICursorNone   NULL
#define kPICursorArrow   "Photoshop Cursor Arrow"
#define kPICursorWatch   "Photoshop Cursor Watch"
#define kPICursorWatchContinue   "Photoshop Cursor Watch Continue"
#define kPICursorMove   "Photoshop Cursor Move"
#define kPICursorHand   "Photoshop Cursor Hand"
#define kPICursorGrab   "Photoshop Cursor Grab"
#define kPICursorZoomIn   "Photoshop Cursor Zoom In"
#define kPICursorZoomOut   "Photoshop Cursor Zoom Out"
#define kPICursorZoomLimit   "Photoshop Cursor Zoom Limit"
#define kPICursorPencil   "Photoshop Cursor Pencil"
#define kPICursorEyedropper   "Photoshop Cursor Eyedropper"
#define kPICursorEyedropperPlus   "Photoshop Cursor Eyedropper Plus"
#define kPICursorEyedropperMinus   "Photoshop Cursor Eyedropper Minus"
#define kPICursorBucket   "Photoshop Cursor Bucket"
#define kPICursorCrosshair   "Photoshop Cursor Crosshair"
#define kPICursorType   "Photoshop Cursor Type"
#define kPICursorPathArrow   "Photoshop Cursor Path Arrow"
#define kPSUIHooksSuiteVersion1   1
 UI Hooks Suite, version 1.
#define kPSUIHooksSuiteVersion2   2
 UI Hooks Suite, version 2.
#define kPSUIHooksSuiteVersion3   3
 UI Hooks Suite, version 3.

Typedefs

typedef 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 unsigned long(*) 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 .