@bubblydoo/photoshop-mcp 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +138 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +7049 -0
- package/dist/index.js.map +1 -0
- package/dist-readmes/README.md +383 -0
- package/dist-runtime/runtime-code.cjs +17124 -0
- package/dist-runtime/runtime-code.d.cts +9 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/index.d.ts +16 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/all-types.d.ts +65 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Actions.d.ts +230 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Channel.d.ts +120 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/ColorSampler.d.ts +105 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Constants.d.ts +1648 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/CoreModules.d.ts +922 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/CountItem.d.ts +86 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Document.d.ts +931 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Guide.d.ts +105 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/HistoryState.d.ts +74 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/ImagingModule.d.ts +559 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Layer.d.ts +1073 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/LayerComp.d.ts +219 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Objects.d.ts +7 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/PathItem.d.ts +243 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/PathPoint.d.ts +78 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Photoshop.d.ts +317 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Selection.d.ts +557 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/SubPathItem.d.ts +69 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/TextItem.d.ts +213 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/Channels.d.ts +81 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/ColorSamplers.d.ts +97 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/CountItems.d.ts +130 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/Documents.d.ts +95 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/Guides.d.ts +76 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/HistoryStates.d.ts +56 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/LayerComps.d.ts +92 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/Layers.d.ts +68 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/PathItems.d.ts +65 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/PathPoints.d.ts +50 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/SubPathItems.d.ts +50 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/TextFonts.d.ts +43 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/Colors.d.ts +225 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/ConversionOptions.d.ts +213 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/ImagingBounds.d.ts +53 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/PathPointInfo.d.ts +84 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SaveOptions.d.ts +376 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SolidColor.d.ts +118 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SubPathInfo.d.ts +47 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/TextFont.d.ts +49 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/Tool.d.ts +23 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/Preferences.d.ts +121 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesBase.d.ts +9 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesCursors.d.ts +37 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesFileHandling.d.ts +58 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesGeneral.d.ts +77 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesGuidesGridsAndSlices.d.ts +51 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts +69 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesInterface.d.ts +46 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesPerformance.d.ts +42 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesTools.d.ts +44 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesTransparencyAndGamut.d.ts +38 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesType.d.ts +44 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesUnitsAndRulers.d.ts +44 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/text/CharacterStyle.d.ts +254 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/text/ParagraphStyle.d.ts +114 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/text/TextWarpStyle.d.ts +48 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/ApplyImageTypes.d.ts +107 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/CalculationsTypes.d.ts +119 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/DocumentTypes.d.ts +80 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/LayerCompTypes.d.ts +91 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/LayerTypes.d.ts +153 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/SharedTypes.d.ts +6 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/TextTypes.d.ts +218 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/util/colorTypes.d.ts +61 -0
- package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/util/unit.d.ts +45 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/index.d.ts +21 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/all-types.d.ts +3 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/dialog.d.ts +26 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/entrypoints.d.ts +385 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/host.d.ts +28 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/os.d.ts +56 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/other.d.ts +7 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/shell.d.ts +54 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/storage.d.ts +1216 -0
- package/dist-schemas/@adobe-uxp-types/uxp/src/internal/versions.d.ts +18 -0
- package/dist-schemas/@bubblydoo/uxp-toolkit/dist/commands-library/index.d.ts +109 -0
- package/dist-schemas/@bubblydoo/uxp-toolkit/dist/index.d.ts +153 -0
- package/dist-schemas/@bubblydoo/uxp-toolkit/dist/psLayerRef-BJKcxKbm.d.ts +66 -0
- package/package.json +51 -0
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import type { PreferencesCursors } from './PreferencesCursors';
|
|
2
|
+
import type { PreferencesFileHandling } from './PreferencesFileHandling';
|
|
3
|
+
import type { PreferencesGeneral } from './PreferencesGeneral';
|
|
4
|
+
import type { PreferencesGuidesGridsAndSlices } from './PreferencesGuidesGridsAndSlices';
|
|
5
|
+
import type { PreferencesHistory } from './PreferencesHistory';
|
|
6
|
+
import type { PreferencesInterface } from './PreferencesInterface';
|
|
7
|
+
import type { PreferencesPerformance } from './PreferencesPerformance';
|
|
8
|
+
import type { PreferencesTools } from './PreferencesTools';
|
|
9
|
+
import type { PreferencesTransparencyAndGamut } from './PreferencesTransparencyAndGamut';
|
|
10
|
+
import type { PreferencesType } from './PreferencesType';
|
|
11
|
+
import type { PreferencesUnitsAndRulers } from './PreferencesUnitsAndRulers';
|
|
12
|
+
/**
|
|
13
|
+
* Contains Photoshop preferences grouped into several categories similar to preferences in user interface.
|
|
14
|
+
*
|
|
15
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/}
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```javascript
|
|
19
|
+
* // Access general preferences
|
|
20
|
+
* const prefs = app.preferences;
|
|
21
|
+
* console.log(`Auto-update documents: ${prefs.general.autoUpdateOpenDocuments}`);
|
|
22
|
+
* prefs.general.exportClipboard = true;
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```javascript
|
|
27
|
+
* // Configure interface preferences
|
|
28
|
+
* const prefs = app.preferences;
|
|
29
|
+
* prefs.interface.showTransformControls = true;
|
|
30
|
+
* prefs.interface.enableNarrowOptionBar = false;
|
|
31
|
+
* ```
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // Set units and rulers
|
|
36
|
+
* const prefs = app.preferences;
|
|
37
|
+
* prefs.unitsAndRulers.rulerUnits = constants.Units.PIXELS;
|
|
38
|
+
* prefs.unitsAndRulers.typeUnits = constants.TypeUnits.POINTS;
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @minVersion 24.0
|
|
42
|
+
*/
|
|
43
|
+
export class Preferences {
|
|
44
|
+
/**
|
|
45
|
+
* @ignore
|
|
46
|
+
*/
|
|
47
|
+
constructor();
|
|
48
|
+
/**
|
|
49
|
+
* The class name of the referenced object: *"Preferences"*.
|
|
50
|
+
* @minVersion 24.0
|
|
51
|
+
*/
|
|
52
|
+
get typename(): 'Preferences';
|
|
53
|
+
/**
|
|
54
|
+
* General preferences.
|
|
55
|
+
*
|
|
56
|
+
* @minVersion 24.0
|
|
57
|
+
*/
|
|
58
|
+
get general(): PreferencesGeneral;
|
|
59
|
+
/**
|
|
60
|
+
* User interface preferences.
|
|
61
|
+
*
|
|
62
|
+
* @minVersion 24.0
|
|
63
|
+
*/
|
|
64
|
+
get interface(): PreferencesInterface;
|
|
65
|
+
/**
|
|
66
|
+
* Tools preferences.
|
|
67
|
+
*
|
|
68
|
+
* @minVersion 24.0
|
|
69
|
+
*/
|
|
70
|
+
get tools(): PreferencesTools;
|
|
71
|
+
/**
|
|
72
|
+
* All preferences related to history logging.
|
|
73
|
+
*
|
|
74
|
+
* @minVersion 24.0
|
|
75
|
+
*/
|
|
76
|
+
get history(): PreferencesHistory;
|
|
77
|
+
/**
|
|
78
|
+
* File handling preferences. Mostly about file saving options, file compatibility and recent files.
|
|
79
|
+
*
|
|
80
|
+
* @minVersion 24.0
|
|
81
|
+
*/
|
|
82
|
+
get fileHandling(): PreferencesFileHandling;
|
|
83
|
+
/**
|
|
84
|
+
* Options that could affect the speed of Photoshop performance including GPU usage.
|
|
85
|
+
*
|
|
86
|
+
* @minVersion 24.0
|
|
87
|
+
*/
|
|
88
|
+
get performance(): PreferencesPerformance;
|
|
89
|
+
/**
|
|
90
|
+
* Options for size and style of tool cursors.
|
|
91
|
+
*
|
|
92
|
+
* @minVersion 24.0
|
|
93
|
+
*/
|
|
94
|
+
get cursors(): PreferencesCursors;
|
|
95
|
+
/**
|
|
96
|
+
* Controls for how transparency will be shown and what color to use for the out-of-gamut warning.
|
|
97
|
+
*
|
|
98
|
+
* @minVersion 24.0
|
|
99
|
+
*/
|
|
100
|
+
get transparencyAndGamut(): PreferencesTransparencyAndGamut;
|
|
101
|
+
/**
|
|
102
|
+
* Preferences related to ruler units, type units and resolution.
|
|
103
|
+
*
|
|
104
|
+
* @minVersion 24.0
|
|
105
|
+
*/
|
|
106
|
+
get unitsAndRulers(): PreferencesUnitsAndRulers;
|
|
107
|
+
/**
|
|
108
|
+
* Presentation options for guides, grid, slices, paths, and other on-canvas controls.
|
|
109
|
+
*
|
|
110
|
+
* @minVersion 24.0
|
|
111
|
+
*/
|
|
112
|
+
get guidesGridsAndSlices(): PreferencesGuidesGridsAndSlices;
|
|
113
|
+
/**
|
|
114
|
+
* Preferences related to type.
|
|
115
|
+
*
|
|
116
|
+
* @minVersion 24.0
|
|
117
|
+
*/
|
|
118
|
+
get type(): PreferencesType;
|
|
119
|
+
}
|
|
120
|
+
/** @ignore */
|
|
121
|
+
export const preferences: Preferences;
|
package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesCursors.d.ts
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* Options for size and style of tool cursors.
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#cursors}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesCursors extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesCursors"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesCursors';
|
|
21
|
+
/**
|
|
22
|
+
* The style of cursor in use for painting tools.
|
|
23
|
+
*
|
|
24
|
+
* @minVersion 24.0
|
|
25
|
+
*/
|
|
26
|
+
get paintingCursors(): Constants.PaintingCursors;
|
|
27
|
+
set paintingCursors(value: Constants.PaintingCursors);
|
|
28
|
+
/**
|
|
29
|
+
* The type of pointer to use
|
|
30
|
+
*
|
|
31
|
+
* @minVersion 24.0
|
|
32
|
+
*/
|
|
33
|
+
get otherCursors(): Constants.OtherCursors;
|
|
34
|
+
set otherCursors(value: Constants.OtherCursors);
|
|
35
|
+
}
|
|
36
|
+
/** @ignore */
|
|
37
|
+
export const preferencesCursors: PreferencesCursors;
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* File handling preferences. Mostly about file saving options, file compatibility and recent files
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#filehandling}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesFileHandling extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesFileHandling"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesFileHandling';
|
|
21
|
+
/**
|
|
22
|
+
* The behavior mode to use when saving files
|
|
23
|
+
*
|
|
24
|
+
* @minVersion 24.0
|
|
25
|
+
*/
|
|
26
|
+
get imagePreviews(): Constants.SavePreview;
|
|
27
|
+
set imagePreviews(value: Constants.SavePreview);
|
|
28
|
+
/**
|
|
29
|
+
* If true, the file extension is lowercase
|
|
30
|
+
*
|
|
31
|
+
* @minVersion 24.0
|
|
32
|
+
*/
|
|
33
|
+
get useLowerCaseExtension(): boolean;
|
|
34
|
+
set useLowerCaseExtension(enabled: boolean);
|
|
35
|
+
/**
|
|
36
|
+
* If true, asks the user to verify layer preservation options when saving a file in TIFF format.
|
|
37
|
+
*
|
|
38
|
+
* @minVersion 24.0
|
|
39
|
+
*/
|
|
40
|
+
get askBeforeSavingLayeredTIFF(): boolean;
|
|
41
|
+
set askBeforeSavingLayeredTIFF(enabled: boolean);
|
|
42
|
+
/**
|
|
43
|
+
* The behavior to use to check whether to maximize compatibility when opening Adobe Photoshop (PSD) files.
|
|
44
|
+
*
|
|
45
|
+
* @minVersion 24.0
|
|
46
|
+
*/
|
|
47
|
+
get maximizeCompatibility(): Constants.MaximizeCompatibility;
|
|
48
|
+
set maximizeCompatibility(value: Constants.MaximizeCompatibility);
|
|
49
|
+
/**
|
|
50
|
+
* The maximum number of items in the recent file list [0,100].
|
|
51
|
+
*
|
|
52
|
+
* @minVersion 24.0
|
|
53
|
+
*/
|
|
54
|
+
get recentFileListMaximum(): number;
|
|
55
|
+
set recentFileListMaximum(value: number);
|
|
56
|
+
}
|
|
57
|
+
/** @ignore */
|
|
58
|
+
export const preferencesFileHandling: PreferencesFileHandling;
|
package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesGeneral.d.ts
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* General preferences
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#general}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesGeneral extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesGeneral"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesGeneral';
|
|
21
|
+
/**
|
|
22
|
+
* Changes color picker within the Photoshop. It uses object where `type` property is color picker type to use.
|
|
23
|
+
* If color picker type is `ColorPicker.PLUGIN` then also `pluginID` property must be provided
|
|
24
|
+
* and must contain internal ID of the plugin as a string.
|
|
25
|
+
*
|
|
26
|
+
* @minVersion 24.0
|
|
27
|
+
*/
|
|
28
|
+
set colorPicker(colorPickerArg: ColorPickerOption);
|
|
29
|
+
get colorPicker(): ColorPickerOption;
|
|
30
|
+
/**
|
|
31
|
+
* Method used when scaling or resizing images.
|
|
32
|
+
*
|
|
33
|
+
* @minVersion 24.0
|
|
34
|
+
*/
|
|
35
|
+
get imageInterpolation(): Constants.InterpolationMethod;
|
|
36
|
+
set imageInterpolation(method: Constants.InterpolationMethod);
|
|
37
|
+
/**
|
|
38
|
+
* If true, retains Adobe Photoshop contents on the clipboard after you exit the application.
|
|
39
|
+
*
|
|
40
|
+
* @minVersion 24.0
|
|
41
|
+
*/
|
|
42
|
+
get exportClipboard(): boolean;
|
|
43
|
+
set exportClipboard(enabled: boolean);
|
|
44
|
+
/**
|
|
45
|
+
* Determines whether to automatically re-read open file-based documents updated outside Photoshop.
|
|
46
|
+
* Cloud documents are not affected by this setting.'
|
|
47
|
+
*
|
|
48
|
+
* @minVersion 24.0
|
|
49
|
+
*/
|
|
50
|
+
get autoUpdateOpenDocuments(): boolean;
|
|
51
|
+
set autoUpdateOpenDocuments(enabled: boolean);
|
|
52
|
+
/**
|
|
53
|
+
* If true, alerts the user when a command completes
|
|
54
|
+
*
|
|
55
|
+
* @minVersion 24.0
|
|
56
|
+
*/
|
|
57
|
+
get beepWhenDone(): boolean;
|
|
58
|
+
set beepWhenDone(enabled: boolean);
|
|
59
|
+
}
|
|
60
|
+
/** @ignore */
|
|
61
|
+
export const preferencesGeneral: PreferencesGeneral;
|
|
62
|
+
/**
|
|
63
|
+
* The options used when specifying a color picker in Preferences.
|
|
64
|
+
* @minVersion 24.0
|
|
65
|
+
* @optionobject
|
|
66
|
+
* @targetfolder objects/options
|
|
67
|
+
*/
|
|
68
|
+
export interface ColorPickerOption {
|
|
69
|
+
/**
|
|
70
|
+
* @minVersion 24.0
|
|
71
|
+
*/
|
|
72
|
+
type: 'photoshopPicker' | 'systemPicker' | 'pluginPicker';
|
|
73
|
+
/**
|
|
74
|
+
* @minVersion 24.0
|
|
75
|
+
*/
|
|
76
|
+
pluginID?: string;
|
|
77
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* Preferences how guides, grids and slices will be shown
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#guidesgridsandslices}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesGuidesGridsAndSlices extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesGuidesGridsAndSlices"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesGuidesGridsAndSlices';
|
|
21
|
+
/**
|
|
22
|
+
* The formatting style for non-printing guide lines.
|
|
23
|
+
*
|
|
24
|
+
* @minVersion 24.0
|
|
25
|
+
*/
|
|
26
|
+
get guideStyle(): Constants.GuideLineStyle;
|
|
27
|
+
set guideStyle(value: Constants.GuideLineStyle);
|
|
28
|
+
/**
|
|
29
|
+
* The formatting style for non-printing grid lines
|
|
30
|
+
*
|
|
31
|
+
* @minVersion 24.0
|
|
32
|
+
*/
|
|
33
|
+
get gridStyle(): Constants.GridLineStyle;
|
|
34
|
+
set gridStyle(value: Constants.GridLineStyle);
|
|
35
|
+
/**
|
|
36
|
+
* The whole number by which to subdivide the grid [1,100].
|
|
37
|
+
*
|
|
38
|
+
* @minVersion 24.0
|
|
39
|
+
*/
|
|
40
|
+
get gridSubDivisions(): number;
|
|
41
|
+
set gridSubDivisions(value: number);
|
|
42
|
+
/**
|
|
43
|
+
* If true, displays slice numbers in the document window when using the Slice tool.
|
|
44
|
+
*
|
|
45
|
+
* @minVersion 24.0
|
|
46
|
+
*/
|
|
47
|
+
get showSliceNumber(): boolean;
|
|
48
|
+
set showSliceNumber(enabled: boolean);
|
|
49
|
+
}
|
|
50
|
+
/** @ignore */
|
|
51
|
+
export const preferencesGuidesGridsAndSlices: PreferencesGuidesGridsAndSlices;
|
package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* All preferences related to history logging
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#history}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesHistory extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesHistory"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesHistory';
|
|
21
|
+
/**
|
|
22
|
+
* If true, automatically makes the first snapshot when a new document is created
|
|
23
|
+
*
|
|
24
|
+
* @minVersion 24.0
|
|
25
|
+
*/
|
|
26
|
+
get createFirstSnapshot(): boolean;
|
|
27
|
+
set createFirstSnapshot(enabled: boolean);
|
|
28
|
+
/**
|
|
29
|
+
* If true, allows non-linear history
|
|
30
|
+
*
|
|
31
|
+
* @minVersion 24.0
|
|
32
|
+
*/
|
|
33
|
+
get nonLinearHistory(): boolean;
|
|
34
|
+
set nonLinearHistory(enabled: boolean);
|
|
35
|
+
/**
|
|
36
|
+
* The whole number of history states to preserve [1,1000].
|
|
37
|
+
*
|
|
38
|
+
* @minVersion 24.0
|
|
39
|
+
*/
|
|
40
|
+
get numberOfHistoryStates(): number;
|
|
41
|
+
set numberOfHistoryStates(value: number);
|
|
42
|
+
/**
|
|
43
|
+
* Turn on and off the history logging
|
|
44
|
+
*
|
|
45
|
+
* @minVersion 24.0
|
|
46
|
+
*/
|
|
47
|
+
get useHistoryLog(): boolean;
|
|
48
|
+
set useHistoryLog(enabled: boolean);
|
|
49
|
+
/**
|
|
50
|
+
* Options for edit log items.
|
|
51
|
+
*
|
|
52
|
+
* Sets `history.useHistoryLog = true` as side effect.
|
|
53
|
+
*
|
|
54
|
+
* @minVersion 24.0
|
|
55
|
+
*/
|
|
56
|
+
get editLogItems(): Constants.EditLogItemsType;
|
|
57
|
+
set editLogItems(value: Constants.EditLogItemsType);
|
|
58
|
+
/**
|
|
59
|
+
* Options for saving the history items. It can be metadata, file or both.
|
|
60
|
+
*
|
|
61
|
+
* Sets `history.useHistoryLog = true` as side effect.
|
|
62
|
+
*
|
|
63
|
+
* @minVersion 24.0
|
|
64
|
+
*/
|
|
65
|
+
get saveLogItems(): Constants.SaveLogItemsType;
|
|
66
|
+
set saveLogItems(value: Constants.SaveLogItemsType);
|
|
67
|
+
}
|
|
68
|
+
/** @ignore */
|
|
69
|
+
export const preferencesHistory: PreferencesHistory;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* User interface preferences
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#interface}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesInterface extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesInterface"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesInterface';
|
|
21
|
+
/**
|
|
22
|
+
* If true, dynamic color sliders appear in the Color palette.
|
|
23
|
+
*
|
|
24
|
+
* @minVersion 24.0
|
|
25
|
+
*/
|
|
26
|
+
get dynamicColorSliders(): boolean;
|
|
27
|
+
set dynamicColorSliders(enabled: boolean);
|
|
28
|
+
/**
|
|
29
|
+
* Size of the small font used in panels and dialogs
|
|
30
|
+
*
|
|
31
|
+
* Requires Photoshop restart for changed value to take an effect.*
|
|
32
|
+
*
|
|
33
|
+
* @minVersion 24.0
|
|
34
|
+
*/
|
|
35
|
+
get textFontSize(): Constants.FontSize;
|
|
36
|
+
set textFontSize(value: Constants.FontSize);
|
|
37
|
+
/**
|
|
38
|
+
* If true, the Channels palette will display the component channels in their respective colors.
|
|
39
|
+
*
|
|
40
|
+
* @minVersion 24.0
|
|
41
|
+
*/
|
|
42
|
+
get colorChannelsInColor(): boolean;
|
|
43
|
+
set colorChannelsInColor(enabled: boolean);
|
|
44
|
+
}
|
|
45
|
+
/** @ignore */
|
|
46
|
+
export const preferencesInterface: PreferencesInterface;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
2
|
+
/**
|
|
3
|
+
* Performance preferences. Options that could possibly affect speed of Photoshop.
|
|
4
|
+
*
|
|
5
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#performance}
|
|
6
|
+
* @targetfolder classes/preferences
|
|
7
|
+
* @minVersion 24.0
|
|
8
|
+
*/
|
|
9
|
+
export class PreferencesPerformance extends PreferencesBase {
|
|
10
|
+
/**
|
|
11
|
+
* @ignore
|
|
12
|
+
*/
|
|
13
|
+
constructor();
|
|
14
|
+
/**
|
|
15
|
+
* The class name of the referenced object: *"PreferencesPerformance"*.
|
|
16
|
+
*
|
|
17
|
+
* @minVersion 24.0
|
|
18
|
+
*/
|
|
19
|
+
get typename(): 'PreferencesPerformance';
|
|
20
|
+
/**
|
|
21
|
+
* Number of cached levels of image data. Used to improve screen redraw and histogram speed.
|
|
22
|
+
* Choose more Cache Levels for bigger documents with few layers; choose fewer Cache Levels for smaller
|
|
23
|
+
* documents with many layers [1,8].
|
|
24
|
+
*
|
|
25
|
+
* Requires Photoshop restart for changed value to take an effect.*
|
|
26
|
+
*
|
|
27
|
+
* @minVersion 24.0
|
|
28
|
+
*/
|
|
29
|
+
get imageCacheLevels(): number;
|
|
30
|
+
set imageCacheLevels(value: number);
|
|
31
|
+
/**
|
|
32
|
+
* Maximum percentage of available RAM used by Photoshop as a whole number [2,99].
|
|
33
|
+
*
|
|
34
|
+
* Requires Photoshop restart for changed value to take an effect.*
|
|
35
|
+
*
|
|
36
|
+
* @minVersion 24.0
|
|
37
|
+
*/
|
|
38
|
+
get maxRAMuse(): number;
|
|
39
|
+
set maxRAMuse(value: number);
|
|
40
|
+
}
|
|
41
|
+
/** @ignore */
|
|
42
|
+
export const preferencesPerformance: PreferencesPerformance;
|
package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesTools.d.ts
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
2
|
+
/**
|
|
3
|
+
* Tools preferences
|
|
4
|
+
*
|
|
5
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#tools}
|
|
6
|
+
* @targetfolder classes/preferences
|
|
7
|
+
* @minVersion 24.0
|
|
8
|
+
*/
|
|
9
|
+
export class PreferencesTools extends PreferencesBase {
|
|
10
|
+
/**
|
|
11
|
+
* @ignore
|
|
12
|
+
*/
|
|
13
|
+
constructor();
|
|
14
|
+
/**
|
|
15
|
+
* The class name of the referenced object: *"PreferencesTools"*.
|
|
16
|
+
*
|
|
17
|
+
* @minVersion 24.0
|
|
18
|
+
*/
|
|
19
|
+
get typename(): 'PreferencesTools';
|
|
20
|
+
/**
|
|
21
|
+
* If true, pop-up definitions or descriptions are displayed on mouseover.
|
|
22
|
+
*
|
|
23
|
+
* @minVersion 24.0
|
|
24
|
+
*/
|
|
25
|
+
get showToolTips(): boolean;
|
|
26
|
+
set showToolTips(enabled: boolean);
|
|
27
|
+
/**
|
|
28
|
+
* Determines whether to enable the shift key as a modifier to the keyboard shortcut
|
|
29
|
+
* for switching between grouped tools.
|
|
30
|
+
*
|
|
31
|
+
* @minVersion 24.0
|
|
32
|
+
*/
|
|
33
|
+
get useShiftKeyForToolSwitch(): boolean;
|
|
34
|
+
set useShiftKeyForToolSwitch(enabled: boolean);
|
|
35
|
+
/**
|
|
36
|
+
* If true, automatically resizes the window when zooming in or out using keyboard shortcuts.
|
|
37
|
+
*
|
|
38
|
+
* @minVersion 24.0
|
|
39
|
+
*/
|
|
40
|
+
get keyboardZoomResizesWindows(): boolean;
|
|
41
|
+
set keyboardZoomResizesWindows(enabled: boolean);
|
|
42
|
+
}
|
|
43
|
+
/** @ignore */
|
|
44
|
+
export const preferencesTools: PreferencesTools;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* Preferences how transparency will be shown and what color to use for out of gamut warning
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#transparencyandgamut}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesTransparencyAndGamut extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesTransparencyAndGamut"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesTransparencyAndGamut';
|
|
21
|
+
/**
|
|
22
|
+
* The size of grid squares used to construct the transparency pattern
|
|
23
|
+
*
|
|
24
|
+
* @minVersion 24.0
|
|
25
|
+
*/
|
|
26
|
+
get gridSize(): Constants.GridSize;
|
|
27
|
+
set gridSize(value: Constants.GridSize);
|
|
28
|
+
/**
|
|
29
|
+
* The opacity as a float number representing the percentage
|
|
30
|
+
* of the warning color for out-of-gamut colors [1,100].
|
|
31
|
+
*
|
|
32
|
+
* @minVersion 24.0
|
|
33
|
+
*/
|
|
34
|
+
get gamutWarningOpacity(): number;
|
|
35
|
+
set gamutWarningOpacity(value: number);
|
|
36
|
+
}
|
|
37
|
+
/** @ignore */
|
|
38
|
+
export const preferencesTransparencyAndGamut: PreferencesTransparencyAndGamut;
|
package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesType.d.ts
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* Preferences related to the text and mostly text layers
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#type}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesType extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesType"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesType';
|
|
21
|
+
/**
|
|
22
|
+
* Change user interface of Character and Paragraph panels and shows additional text options
|
|
23
|
+
*
|
|
24
|
+
* @minVersion 24.0
|
|
25
|
+
*/
|
|
26
|
+
get showTextFeatures(): Constants.TypeInterfaceFeatures;
|
|
27
|
+
set showTextFeatures(features: Constants.TypeInterfaceFeatures);
|
|
28
|
+
/**
|
|
29
|
+
* If true, all font names are listed in English
|
|
30
|
+
*
|
|
31
|
+
* @minVersion 24.0
|
|
32
|
+
*/
|
|
33
|
+
get showEnglishFontNames(): boolean;
|
|
34
|
+
set showEnglishFontNames(enabled: boolean);
|
|
35
|
+
/**
|
|
36
|
+
* Determines whether to substitute left and right quotation marks automatically while typing in the Type Tool.
|
|
37
|
+
*
|
|
38
|
+
* @minVersion 24.0
|
|
39
|
+
*/
|
|
40
|
+
get smartQuotes(): boolean;
|
|
41
|
+
set smartQuotes(enabled: boolean);
|
|
42
|
+
}
|
|
43
|
+
/** @ignore */
|
|
44
|
+
export const preferencesType: PreferencesType;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type * as Constants from '../Constants';
|
|
2
|
+
import { PreferencesBase } from './PreferencesBase';
|
|
3
|
+
/**
|
|
4
|
+
* Preferences related to ruler units, type units and resolution
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#unitsandrulers}
|
|
7
|
+
* @targetfolder classes/preferences
|
|
8
|
+
* @minVersion 24.0
|
|
9
|
+
*/
|
|
10
|
+
export class PreferencesUnitsAndRulers extends PreferencesBase {
|
|
11
|
+
/**
|
|
12
|
+
* @ignore
|
|
13
|
+
*/
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* The class name of the referenced object: *"PreferencesUnitsAndRulers"*.
|
|
17
|
+
*
|
|
18
|
+
* @minVersion 24.0
|
|
19
|
+
*/
|
|
20
|
+
get typename(): 'PreferencesUnitsAndRulers';
|
|
21
|
+
/**
|
|
22
|
+
* The unit that will be used for the displayed Rulers and consequently considered primary in Photoshop.
|
|
23
|
+
*
|
|
24
|
+
* @minVersion 24.0
|
|
25
|
+
*/
|
|
26
|
+
get rulerUnits(): Constants.RulerUnits;
|
|
27
|
+
set rulerUnits(value: Constants.RulerUnits);
|
|
28
|
+
/**
|
|
29
|
+
* The unit type-size that the numeric inputs are assumed to represent.
|
|
30
|
+
*
|
|
31
|
+
* @minVersion 24.0
|
|
32
|
+
*/
|
|
33
|
+
get typeUnits(): Constants.TypeUnits;
|
|
34
|
+
set typeUnits(value: Constants.TypeUnits);
|
|
35
|
+
/**
|
|
36
|
+
* The point/pica size
|
|
37
|
+
*
|
|
38
|
+
* @minVersion 24.0
|
|
39
|
+
*/
|
|
40
|
+
get pointSize(): Constants.PointType;
|
|
41
|
+
set pointSize(value: Constants.PointType);
|
|
42
|
+
}
|
|
43
|
+
/** @ignore */
|
|
44
|
+
export const preferencesUnitsAndRulers: PreferencesUnitsAndRulers;
|