action_descriptor
A record of key-text_font pairs for actions.
such as those included on the Adobe Photoshop Actions menu. The ActionDescriptor class is part of the Action Manager functionality. For more details on the Action Manager, see the Photoshop Scripting Guide.
ActionDescriptor
Bases: Photoshop
A record of key-value pairs for actions, such as those included on the Adobe Photoshop Actions menu.
The ActionDescriptor class is part of the Action Manager functionality. For more details on the Action Manager, see the Photoshop Scripting Guide.
Source code in photoshop/api/action_descriptor.py
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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
|
count
property
The number of keys contained in the descriptor.
clear()
Clears the descriptor.
Source code in photoshop/api/action_descriptor.py
77 78 79 |
|
erase(key)
Erases a key form the descriptor.
Source code in photoshop/api/action_descriptor.py
81 82 83 |
|
fromStream(value)
Create a descriptor from a stream of bytes.
for reading from disk.
Source code in photoshop/api/action_descriptor.py
85 86 87 88 89 90 91 |
|
getBoolean(key)
Gets the text_font of a key of type boolean.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key | str | key of type boolean. | required |
Returns:
Name | Type | Description |
---|---|---|
bool | int | The text_font of a key of type boolean. |
Source code in photoshop/api/action_descriptor.py
93 94 95 96 97 98 99 100 101 102 103 |
|
getClass(key)
Gets the text_font of a key of type class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key | str | The key of type class. | required |
Returns:
Name | Type | Description |
---|---|---|
int | The text_font of a key of type class. |
Source code in photoshop/api/action_descriptor.py
105 106 107 108 109 110 111 112 113 114 115 |
|
getData(key)
Gets raw byte data as a string value.
Source code in photoshop/api/action_descriptor.py
117 118 119 |
|
getDouble(key)
Gets the value of a key of type double.
Source code in photoshop/api/action_descriptor.py
121 122 123 |
|
getEnumerationType(index)
Gets the enumeration type of a key.
Source code in photoshop/api/action_descriptor.py
125 126 127 |
|
getEnumerationValue(index)
Gets the enumeration value of a key.
Source code in photoshop/api/action_descriptor.py
129 130 131 |
|
getInteger(index)
Gets the value of a key of type integer.
Source code in photoshop/api/action_descriptor.py
133 134 135 |
|
getKey(index)
Gets the ID of the key provided by index.
Source code in photoshop/api/action_descriptor.py
137 138 139 |
|
getLargeInteger(index)
Gets the value of a key of type large integer.
Source code in photoshop/api/action_descriptor.py
141 142 143 |
|
getList(index)
Gets the value of a key of type list.
Source code in photoshop/api/action_descriptor.py
145 146 147 |
|
getObjectType(key)
Gets the class ID of an object in a key of type object.
Source code in photoshop/api/action_descriptor.py
149 150 151 |
|
getObjectValue(key)
Get the class ID of an object in a key of type object.
Source code in photoshop/api/action_descriptor.py
153 154 155 |
|
getPath(key)
Gets the value of a key of type.
Source code in photoshop/api/action_descriptor.py
157 158 159 |
|
getReference(key)
Gets the value of a key of type.
Source code in photoshop/api/action_descriptor.py
161 162 163 |
|
getString(key)
Gets the value of a key of type.
Source code in photoshop/api/action_descriptor.py
165 166 167 |
|
getType(key)
Gets the type of a key.
Source code in photoshop/api/action_descriptor.py
169 170 171 |
|
getUnitDoubleType(key)
Gets the unit type of a key of type UnitDouble.
Source code in photoshop/api/action_descriptor.py
173 174 175 |
|
getUnitDoubleValue(key)
Gets the unit type of a key of type UnitDouble.
Source code in photoshop/api/action_descriptor.py
177 178 179 |
|
hasKey(key)
Checks whether the descriptor contains the provided key.
Source code in photoshop/api/action_descriptor.py
181 182 183 |
|
isEqual(otherDesc)
Determines whether the descriptor is the same as another descriptor.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
otherDesc | .action_descriptor.ActionDescriptor | | required |
Source code in photoshop/api/action_descriptor.py
185 186 187 188 189 190 191 192 |
|
putBoolean(key, value)
Sets the value for a key whose type is boolean.
Source code in photoshop/api/action_descriptor.py
194 195 196 |
|
putClass(key, value)
Sets the value for a key whose type is class.
Source code in photoshop/api/action_descriptor.py
198 199 200 |
|
putData(key, value)
Puts raw byte data as a string value.
Source code in photoshop/api/action_descriptor.py
202 203 204 |
|
putDouble(key, value)
Sets the value for a key whose type is double.
Source code in photoshop/api/action_descriptor.py
206 207 208 |
|
putEnumerated(key, enum_type, value)
Sets the enumeration type and value for a key.
Source code in photoshop/api/action_descriptor.py
210 211 212 |
|
putInteger(key, value)
Sets the value for a key whose type is integer.
Source code in photoshop/api/action_descriptor.py
214 215 216 |
|
putLargeInteger(key, value)
Sets the value for a key whose type is large integer.
Source code in photoshop/api/action_descriptor.py
218 219 220 |
|
putList(key, value)
Sets the value for a key whose type is an ActionList object.
Source code in photoshop/api/action_descriptor.py
222 223 224 |
|
putObject(key, class_id, value)
Sets the value for a key whose type is an object.
Source code in photoshop/api/action_descriptor.py
226 227 228 |
|
putPath(key, value)
Sets the value for a key whose type is path.
Source code in photoshop/api/action_descriptor.py
230 231 232 |
|
putReference(key, value)
Sets the value for a key whose type is an object reference.
Source code in photoshop/api/action_descriptor.py
234 235 236 |
|
putString(key, value)
Sets the value for a key whose type is string.
Source code in photoshop/api/action_descriptor.py
238 239 240 |
|
putUnitDouble(key, unit_id, value)
Sets the value for a key whose type is a unit value formatted as double.
Source code in photoshop/api/action_descriptor.py
242 243 244 245 |
|
toStream()
Gets the entire descriptor as as stream of bytes, for writing to disk.
Source code in photoshop/api/action_descriptor.py
247 248 249 250 |
|
Created: 2024-11-17