Adobe 65007312 Programming Guide - Page 87

action. Drawn in platform-standard style, A button that responds to a click with an

Page 87 highlights

CHAPTER 5: Creating a User Interface for Your Plug-in User interface elements 87 Control type Description Type-specific properties password_field An editable text field that obscures the entered text, displaying only bullet characters. All edit and text properties. See "Edit-field view properties" on page 92 and "Text view properties" on page 94. picture A static image or icon. TIP: you can typically get the path to the image file using this function: _PLUGIN:resourceId('myPic.png') value: The full path to the JPG or PNG image file. frame_width: Pixel width of a frame to draw around the image. Default: 0. frame_color: An LrColor object. Default is black. popup_menu A pop-up menu of choices, each with a title and value. When the user pops up the menu and makes a choice, the selected item's title and value become those of the control. The current title text is displayed in the control when the menu is not open. See "Binding pop-up menu selections" on page 100 for example of how to specify items and use the value_equal function. title: Display label. value: The value of the currently selected item. items: A table of items to appear in the menu. Each selectable item entry contains a title and a value. The title text is displayed when the menu is open. An entry of separator=true creates a separator, an unselectable line in the menu. value_equal: A function that compares the current control value to each item's value in turn, to determine the selection. All text properties. See "Text view properties" on page 94. push_button A button that responds to a click with an action. Drawn in platform-standard style with a rounded appearance. title: Display label. action: A function defining the action to be taken when the button is clicked, in the form myAction( button ). All text properties. See "Text view properties" on page 94. radio_button Displays the title text with a platform-style radio button. The button is checked (selected) when its value is equal to its checked_value, and unchecked (deselected) when its value has any other value, except nil. When the value is nil, the button shows a mixed state. title: Display label. value: The control value. checked_value: A value that indicates the selected state. Within a container, only one of a set of radio buttons should be selected. Selecting one button should deselect all others in the set. You must enforce this in the way you bind the button values. It is not automatic. See "Binding radio button selections" on page 99.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 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
  • 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

C
HAPTER
5: Creating a User Interface for Your Plug-in
User interface elements
87
password_field
An editable text field that obscures the
entered text, displaying only bullet
characters.
All edit and text properties. See
“Edit-field view properties” on page 92
and
“Text view properties” on page 94
.
picture
A static image or icon.
T
IP
:
you can typically get the path to the
image file using this function:
_PLUGIN:resourceId(’myPic.png’)
value
: The full path to the JPG or PNG
image file.
frame_width
: Pixel width of a frame to
draw around the image. Default: 0.
frame_color
: An
LrColor
object.
Default is black.
popup_menu
A pop-up menu of choices, each with a
title
and
value
. When the user pops up
the menu and makes a choice, the selected
item’s
title
and
value
become those of
the control. The current
title
text is
displayed in the control when the menu is
not open.
See
“Binding pop-up menu selections” on
page 100
for example of how to specify
items
and use the
value_equal
function.
title
: Display label.
value
: The value of the currently
selected item.
items
: A table of items to appear in
the menu. Each selectable item entry
contains a
title
and a
value
. The
title
text is displayed when the
menu is open. An entry of
separator=true
creates a separator,
an unselectable line in the menu.
value_equal
: A function that
compares the current control
value
to
each item’s
value
in turn, to determine
the selection.
All text properties. See
“Text view
properties” on page 94
.
push_button
A button that responds to a click with an
action. Drawn in platform-standard style
with a rounded appearance.
title
: Display label.
action
: A function defining the action
to be taken when the button is clicked,
in the form
myAction(
button
)
.
All text properties. See
“Text view
properties” on page 94
.
radio_button
Displays the
title
text with a
platform-style radio button. The button is
checked (selected) when its
value
is equal
to its
checked_value
, and unchecked
(deselected) when its
value
has any other
value, except nil. When the
value
is nil, the
button shows a mixed state.
Within a container, only one of a set of radio
buttons should be selected. Selecting one
button should deselect all others in the set.
You must enforce this in the way you bind
the button values. It is not automatic.
See
“Binding radio button selections” on
page 99
.
title
: Display label.
value
: The control value.
checked_value
: A value that indicates
the selected state.
Control type
Description
Type-specific properties