/** * Stores constants for the window types supported by the CSXS infrastructure. */ declare function CSXSWindowType(): void; /** * EvalScript error message */ declare var EvalScript_ErrMessage: any; /** * Version Defines a version number with major, minor, micro, and special components. The major, minor and micro values are numeric; the special value can be any string. * @param major - The major version component, a positive integer up to nine digits long. * @param minor - The minor version component, a positive integer up to nine digits long. * @param micro - The micro version component, a positive integer up to nine digits long. * @param special - The special version component, an arbitrary string. */ declare class Version { constructor(major: any, minor: any, micro: any, special: any); /** * The maximum value allowed for a numeric version component. This reflects the maximum value allowed in PlugPlug and the manifest schema. */ static MAX_NUM: any; } /** * VersionBound Defines a boundary for a version range, which associates a \c Version object with a flag for whether it is an inclusive or exclusive boundary. * @param version - The \c #Version object. * @param inclusive - True if this boundary is inclusive, false if it is exclusive. */ declare class VersionBound { constructor(version: any, inclusive: any); } /** * VersionRange Defines a range of versions using a lower boundary and optional upper boundary. * @param lowerBound - The \c #VersionBound object. * @param upperBound - The \c #VersionBound object, or null for a range with no upper boundary. */ declare class VersionRange { constructor(lowerBound: any, upperBound: any); } /** * Runtime Represents a runtime related to the CEP infrastructure. Extensions can declare dependencies on particular CEP runtime versions in the extension manifest. * @param name - The runtime name. * @param version - A \c #VersionRange object that defines a range of valid versions. */ declare class Runtime { constructor(name: any, version: any); } /** * Extension Encapsulates a CEP-based extension to an Adobe application. * @param id - The unique identifier of this extension. * @param name - The localizable display name of this extension. * @param mainPath - The path of the "index.html" file. * @param basePath - The base path of this extension. * @param windowType - The window type of the main window of this extension. * Valid values are defined by \c #CSXSWindowType. * @param width - The default width in pixels of the main window of this extension. * @param height - The default height in pixels of the main window of this extension. * @param minWidth - The minimum width in pixels of the main window of this extension. * @param minHeight - The minimum height in pixels of the main window of this extension. * @param maxWidth - The maximum width in pixels of the main window of this extension. * @param maxHeight - The maximum height in pixels of the main window of this extension. * @param defaultExtensionDataXml - The extension data contained in the default \c ExtensionDispatchInfo section of the extension manifest. * @param specialExtensionDataXml - The extension data contained in the application-specific \c ExtensionDispatchInfo section of the extension manifest. * @param requiredRuntimeList - An array of \c Runtime objects for runtimes required by this extension. * @param isAutoVisible - True if this extension is visible on loading. * @param isPluginExtension - True if this extension has been deployed in the Plugins folder of the host application. */ declare class Extension { constructor( id: any, name: any, mainPath: any, basePath: any, windowType: any, width: any, height: any, minWidth: any, minHeight: any, maxWidth: any, maxHeight: any, defaultExtensionDataXml: any, specialExtensionDataXml: any, requiredRuntimeList: any, isAutoVisible: any, isPluginExtension: any ); } /** * CSEvent A standard JavaScript event, the base class for CEP events. * @param type - The name of the event type. * @param scope - The scope of event, can be "GLOBAL" or "APPLICATION". * @param appId - The unique identifier of the application that generated the event. * @param extensionId - The unique identifier of the extension that generated the event. */ declare class CSEvent { public type: any public scope: any public appId: any public extensionId: any constructor(type?: any, scope?: any, appId?: any, extensionId?: any); /** * Event-specific data. */ data: any; } /** * SystemPath Stores operating-system-specific location constants for use in the \c #CSInterface.getSystemPath() method. */ declare class SystemPath { constructor(); /** * The path to user data. */ static USER_DATA: any; /** * The path to common files for Adobe applications. */ static COMMON_FILES: any; /** * The path to the user's default document folder. */ static MY_DOCUMENTS: any; static APPLICATION: any; /** * The path to current extension. */ static EXTENSION: any; /** * The path to hosting application's executable. */ static HOST_APPLICATION: any; } /** * ColorType Stores color-type constants. */ declare class ColorType { constructor(); /** * RGB color type. */ static RGB: any; /** * Gradient color type. */ static GRADIENT: any; /** * Null color type. */ static NONE: any; } /** * RGBColor Stores an RGB color with red, green, blue, and alpha values. All values are in the range [0.0 to 255.0]. Invalid numeric values are converted to numbers within this range. * @param red - The red value, in the range [0.0 to 255.0]. * @param green - The green value, in the range [0.0 to 255.0]. * @param blue - The blue value, in the range [0.0 to 255.0]. * @param alpha - The alpha (transparency) value, in the range [0.0 to 255.0]. The default, 255.0, means that the color is fully opaque. */ declare class RGBColor { constructor(red: any, green: any, blue: any, alpha: any); } /** * Direction A point value in which the y component is 0 and the x component is positive or negative for a right or left direction, or the x component is 0 and the y component is positive or negative for an up or down direction. * @param x - The horizontal component of the point. * @param y - The vertical component of the point. */ declare class Direction { constructor(x: any, y: any); } /** * GradientStop Stores gradient stop information. * @param offset - The offset of the gradient stop, in the range [0.0 to 1.0]. * @param rgbColor - The color of the gradient at this point, an \c #RGBColor object. */ declare class GradientStop { constructor(offset: any, rgbColor: any); } /** * GradientColor Stores gradient color information. * @param type - The gradient type, must be "linear". * @param direction - A \c #Direction object for the direction of the gradient * (up, down, right, or left). * @param numStops - The number of stops in the gradient. * @param gradientStopList - An array of \c #GradientStop objects. */ declare class GradientColor { constructor(type: any, direction: any, numStops: any, gradientStopList: any); } /** * UIColor Stores color information, including the type, anti-alias level, and specific color values in a color object of an appropriate type. * @param type - The color type, 1 for "rgb" and 2 for "gradient". * The supplied color object must correspond to this type. * @param antialiasLevel - The anti-alias level constant. * @param color - A \c #RGBColor or \c #GradientColor object containing specific color information. */ declare class UIColor { constructor(type: any, antialiasLevel: any, color: any); } /** * AppSkinInfo Stores window-skin properties, such as color and font. All color parameter values are \c #UIColor objects except that systemHighlightColor is \c #RGBColor object. * @param baseFontFamily - The base font family of the application. * @param baseFontSize - The base font size of the application. * @param appBarBackgroundColor - The application bar background color. * @param panelBackgroundColor - The background color of the extension panel. * @param appBarBackgroundColorSRGB - The application bar background color, as sRGB. * @param panelBackgroundColorSRGB - The background color of the extension panel, as sRGB. * @param systemHighlightColor - The highlight color of the extension panel, if provided by the host application. Otherwise, the operating-system highlight color. */ declare class AppSkinInfo { constructor( baseFontFamily: any, baseFontSize: any, appBarBackgroundColor: any, panelBackgroundColor: any, appBarBackgroundColorSRGB: any, panelBackgroundColorSRGB: any, systemHighlightColor: any ); } /** * HostEnvironment Stores information about the environment in which the extension is loaded. * @param appName - The application's name. * @param appVersion - The application's version. * @param appLocale - The application's current license locale. * @param appUILocale - The application's current UI locale. * @param appId - The application's unique identifier. * @param isAppOnline - True if the application is currently online. * @param appSkinInfo - An \c #AppSkinInfo object containing the application's default color and font styles. */ declare class HostEnvironment { constructor( appName: any, appVersion: any, appLocale: any, appUILocale: any, appId: any, isAppOnline: any, appSkinInfo: any ); } /** * HostCapabilities Stores information about the host capabilities. * @param EXTENDED_PANEL_MENU - True if the application supports panel menu. * @param EXTENDED_PANEL_ICONS - True if the application supports panel icon. * @param DELEGATE_APE_ENGINE - True if the application supports delegated APE engine. * @param SUPPORT_HTML_EXTENSIONS - True if the application supports HTML extensions. * @param DISABLE_FLASH_EXTENSIONS - True if the application disables FLASH extensions. */ declare class HostCapabilities { constructor( EXTENDED_PANEL_MENU: any, EXTENDED_PANEL_ICONS: any, DELEGATE_APE_ENGINE: any, SUPPORT_HTML_EXTENSIONS: any, DISABLE_FLASH_EXTENSIONS: any ); } /** * ApiVersion Stores current api version. Since 4.2.0 * @param major - The major version * @param minor - The minor version. * @param micro - The micro version. */ declare class ApiVersion { constructor(major: any, minor: any, micro: any); } /** * MenuItemStatus Stores flyout menu item status Since 5.2.0 * @param menuItemLabel - The menu item label. * @param enabled - True if user wants to enable the menu item. * @param checked - True if user wants to check the menu item. */ declare class MenuItemStatus { constructor(menuItemLabel: any, enabled: any, checked: any); } /** * ContextMenuItemStatus Stores the status of the context menu item. Since 5.2.0 * @param menuItemID - The menu item id. * @param enabled - True if user wants to enable the menu item. * @param checked - True if user wants to check the menu item. */ declare class ContextMenuItemStatus { constructor(menuItemID: any, enabled: any, checked: any); } /** * CSInterface This is the entry point to the CEP extensibility infrastructure. Instantiate this object and use it to:
requestOpenExtension("HLP", "");
* @param extensionId - The extension's unique identifier.
* @param startupParams - Not currently used, pass "".
*/
requestOpenExtension(extensionId: any, startupParams: any): void;
/**
* Retrieves the list of extensions currently loaded in the current host application.
The extension list is initialized once, and remains the same during the lifetime
of the CEP session.
* @param extensionIds - Optional, an array of unique identifiers for extensions of interest.
If omitted, retrieves data for all extensions.
* @returns Zero or more \c #Extension objects.
*/
getExtensions(extensionIds: any): any;
/**
* Retrieves network-related preferences.
* @returns A JavaScript object containing network preferences.
*/
getNetworkPreferences(): any;
/**
* Initializes the resource bundle for this extension with property values
for the current application and locale.
To support multiple locales, you must define a property file for each locale,
containing keyed display-string values for that locale.
See localization documentation for Extension Builder and related products.
Keys can be in the
form key.value="localized string", for use in HTML text elements.
For example, in this input element, the localized \c key.value string is displayed
instead of the empty \c value string:
* @returns An object containing the resource bundle information.
*/
initResourceBundle(): any;
/**
* Writes installation information to a file.
* @returns The file path.
*/
dumpInstallationInfo(): any;
/**
* Retrieves version information for the current Operating System,
See http://www.useragentstring.com/pages/Chrome/ for Chrome \c navigator.userAgent values.
* @returns A string containing the OS version, or "unknown Operation System".
If user customizes the User Agent by setting CEF command parameter "--user-agent", only
"Mac OS X" or "Windows" will be returned.
*/
getOSInformation(): any;
/**
* Opens a page in the default system browser.
Since 4.2.0
* @param url - The URL of the page/file to open, or the email address.
Must use HTTP/HTTPS/file/mailto protocol. For example:
"http://www.adobe.com"
"https://github.com"
"file:///C:/log.txt"
"mailto:test@adobe.com"
* @returns One of these error codes:\n