Skip to content

preferences

Preferences

Bases: Photoshop

The application preference settings.

Source code in photoshop/api/_preferences.py
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
class Preferences(Photoshop):
    """The application preference settings."""

    def __init__(self, parent):
        super().__init__(parent=parent)

    @property
    def additionalPluginFolder(self):
        """The path to an additional plug-in folder."""
        return Path(self.app.additionalPluginFolder)

    @property
    def appendExtension(self):
        return self.app.appendExtension

    @property
    def askBeforeSavingLayeredTIFF(self) -> bool:
        return self.app.askBeforeSavingLayeredTIFF

    @property
    def autoUpdateOpenDocuments(self) -> bool:
        """True to automatically update open documents."""
        return self.app.autoUpdateOpenDocuments

    @autoUpdateOpenDocuments.setter
    def autoUpdateOpenDocuments(self, boolean: bool):
        """True to automatically update open documents."""
        self.app.autoUpdateOpenDocuments = boolean

    @property
    def beepWhenDone(self) -> bool:
        """True to beep when a process."""
        return self.app.beepWhenDone

    @beepWhenDone.setter
    def beepWhenDone(self, boolean):
        self.app.beepWhenDone = boolean

    @property
    def colorChannelsInColor(self):
        """True to display component channels in the Channels palette in
        color."""
        return self.app.colorChannelsInColor

    @colorChannelsInColor.setter
    def colorChannelsInColor(self, value):
        self.app.colorChannelsInColor = value

    @property
    def colorPicker(self):
        """The preferred color selection tool."""
        return self.app.colorPicker

    @colorPicker.setter
    def colorPicker(self, value):
        self.app.colorPicker = value

    @property
    def columnGutter(self):
        return self.app.columnGutter

    @columnGutter.setter
    def columnGutter(self, value):
        self.app.columnGutter = value

    @property
    def columnWidth(self):
        return self.app.columnWidth

    @columnWidth.setter
    def columnWidth(self, value):
        self.app.columnWidth = value

    @property
    def createFirstSnapshot(self):
        """Automatically make the first snapshot when a new document is
        created."""
        return self.app.createFirstSnapshot

    @createFirstSnapshot.setter
    def createFirstSnapshot(self, boolean):
        self.app.createFirstSnapshot = boolean

    @property
    def dynamicColorSliders(self):
        return self.app.dynamicColorSliders

    @dynamicColorSliders.setter
    def dynamicColorSliders(self, boolean):
        self.app.dynamicColorSliders = boolean

    @property
    def editLogItems(self) -> bool:
        """The preferred level of detail in the history log."""
        return self.app.editLogItems

    @editLogItems.setter
    def editLogItems(self, boolean: bool):
        """The preferred level of detail in the history log.

        Valid only when useHistoryLog = True

        """
        self.app.editLogItems = boolean

    @property
    def exportClipboard(self):
        """Retain Photoshop contents on the clipboard after exit the app."""
        return self.app.exportClipboard

    @exportClipboard.setter
    def exportClipboard(self, boolean: bool):
        self.app.exportClipboard = boolean

    @property
    def fontPreviewSize(self):
        return self.app.fontPreviewSize

    @fontPreviewSize.setter
    def fontPreviewSize(self, value):
        self.app.fontPreviewSize = value

    @property
    def fullSizePreview(self):
        return self.app.fullSizePreview

    @fullSizePreview.setter
    def fullSizePreview(self, value):
        self.app.fullSizePreview = value

    @property
    def gamutWarningOpacity(self):
        return self.app.gamutWarningOpacity

    @property
    def rulerUnits(self):
        return self.app.rulerUnits

    @rulerUnits.setter
    def rulerUnits(self, value):
        self.app.rulerUnits = value

additionalPluginFolder property

The path to an additional plug-in folder.

autoUpdateOpenDocuments: bool property writable

True to automatically update open documents.

beepWhenDone: bool property writable

True to beep when a process.

colorChannelsInColor property writable

True to display component channels in the Channels palette in color.

colorPicker property writable

The preferred color selection tool.

createFirstSnapshot property writable

Automatically make the first snapshot when a new document is created.

editLogItems: bool property writable

The preferred level of detail in the history log.

exportClipboard property writable

Retain Photoshop contents on the clipboard after exit the app.


Last update: 2024-03-05
Created: 2024-03-05