← Back to branch summary

~ubuntu-branches/ubuntu/trusty/rgtk2/trusty

« back to all changes in this revision

Viewing changes to man/GtkAction.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2010-11-03 11:35:46 UTC
  • mfrom: (1.3.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20101103113546-a7fi7jdxdebp0tw1
Tags: 2.20.1-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/GtkAction.Rd
18
18
\code{\link{gtkActionCreateToolItem}(object)}\cr
19
19
\code{\link{gtkActionCreateMenu}(object)}\cr
20
20
\code{\link{gtkActionConnectProxy}(object, proxy)}\cr
 
21
\code{\link{gtkActionConnectProxy}(object, proxy)}\cr
 
22
\code{\link{gtkActionDisconnectProxy}(object, proxy)}\cr
21
23
\code{\link{gtkActionDisconnectProxy}(object, proxy)}\cr
22
24
\code{\link{gtkActionGetProxies}(object)}\cr
23
25
\code{\link{gtkActionConnectAccelerator}(object)}\cr
24
26
\code{\link{gtkActionDisconnectAccelerator}(object)}\cr
25
 
\code{\link{gtkActionBlockActivateFrom}(object, proxy)}\cr
26
 
\code{\link{gtkActionUnblockActivateFrom}(object, proxy)}\cr
 
27
\code{\link{gtkActionBlockActivate}(object)}\cr
 
28
\code{\link{gtkActionUnblockActivate}(object)}\cr
 
29
\code{\link{gtkActionBlockActivateFrom}(object, proxy)}\cr
 
30
\code{\link{gtkActionBlockActivateFrom}(object, proxy)}\cr
 
31
\code{\link{gtkActionUnblockActivateFrom}(object, proxy)}\cr
 
32
\code{\link{gtkActionUnblockActivateFrom}(object, proxy)}\cr
 
33
\code{\link{gtkActionGetAlwaysShowImage}(object)}\cr
 
34
\code{\link{gtkActionSetAlwaysShowImage}(object, always.show)}\cr
27
35
\code{\link{gtkActionGetAccelPath}(object)}\cr
28
36
\code{\link{gtkActionSetAccelPath}(object, accel.path)}\cr
29
37
\code{\link{gtkActionGetAccelClosure}(object)}\cr
30
38
\code{\link{gtkActionSetAccelGroup}(object, accel.group)}\cr
 
39
\code{\link{gtkActionSetLabel}(object, label)}\cr
 
40
\code{\link{gtkActionGetLabel}(object)}\cr
 
41
\code{\link{gtkActionSetShortLabel}(object, short.label)}\cr
 
42
\code{\link{gtkActionGetShortLabel}(object)}\cr
 
43
\code{\link{gtkActionSetTooltip}(object, tooltip)}\cr
 
44
\code{\link{gtkActionGetTooltip}(object)}\cr
 
45
\code{\link{gtkActionSetStockId}(object, stock.id)}\cr
 
46
\code{\link{gtkActionGetStockId}(object)}\cr
 
47
\code{\link{gtkActionSetGicon}(object, icon)}\cr
 
48
\code{\link{gtkActionGetGicon}(object)}\cr
 
49
\code{\link{gtkActionSetIconName}(object, icon.name)}\cr
 
50
\code{\link{gtkActionGetIconName}(object)}\cr
 
51
\code{\link{gtkActionSetVisibleHorizontal}(object, visible.horizontal)}\cr
 
52
\code{\link{gtkActionGetVisibleHorizontal}(object)}\cr
 
53
\code{\link{gtkActionSetVisibleVertical}(object, visible.vertical)}\cr
 
54
\code{\link{gtkActionGetVisibleVertical}(object)}\cr
 
55
\code{\link{gtkActionSetIsImportant}(object, is.important)}\cr
 
56
\code{\link{gtkActionGetIsImportant}(object)}\cr
31
57
\code{gtkAction(name = NULL, label = NULL, tooltip = NULL, stock.id = NULL)}
32
58
}
33
59
\section{Hierarchy}{\preformatted{GObject
35
61
         +----GtkToggleAction
36
62
         +----GtkRecentAction}}
37
63
\section{Interfaces}{GtkAction implements
38
 
 \verb{\link{GtkBuildable}}.}
 
64
 \code{\link{GtkBuildable}}.}
39
65
\section{Detailed Description}{Actions represent operations that the user can be perform, along with
40
 
some information how it should be presented in the interface. Each action 
41
 
provides methods to create icons, menu items and toolbar items representing 
 
66
some information how it should be presented in the interface. Each action
 
67
provides methods to create icons, menu items and toolbar items representing
42
68
itself.
43
69
  
44
 
As well as the callback that is called when the action gets activated, the 
 
70
As well as the callback that is called when the action gets activated, the
45
71
following also gets associated with the action:
46
72
\itemize{
47
73
\item a name (not translated, for path lookup)
57
83
\item sensitive (enabled/disabled)
58
84
}
59
85
  
60
 
Apart from regular actions, there are \verb{\link{GtkToggleAction}}, which can be toggled between two states and \verb{\link{GtkRadioAction}}, of which only one in a group 
61
 
can be in the "active" state. Other actions can be implemented as \verb{\link{GtkAction}} 
 
86
Apart from regular actions, there are \code{\link{GtkToggleAction}}, which can be toggled between two states and \code{\link{GtkRadioAction}}, of which only one in a group
 
87
can be in the "active" state. Other actions can be implemented as \code{\link{GtkAction}}
62
88
subclasses.
63
89
  
64
90
Each action can have one or more proxy menu item, toolbar button or
73
99
}}}
74
100
\section{Convenient Construction}{\code{gtkAction} is the equivalent of \code{\link{gtkActionNew}}.}
75
101
\section{Signals}{\describe{\item{\code{activate(action, user.data)}}{
76
 
The "activate" signal is emitted when the action is activated.  
77
 
 
78
 
  Since  2.4
 
102
The "activate" signal is emitted when the action is activated.
 
103
  Since 2.4
79
104
 
80
105
\describe{
81
 
\item{\code{action}}{[\verb{\link{GtkAction}}]  the \verb{\link{GtkAction}}}
82
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
106
\item{\code{action}}{the \code{\link{GtkAction}}}
 
107
\item{\code{user.data}}{user data set when the signal handler was connected.}
83
108
}
84
109
 
85
110
 
86
111
}}}
87
112
\section{Properties}{\describe{
88
 
\item{\verb{action-group} [\verb{\link{GtkActionGroup}} : *       : Read / Write]}{
 
113
\item{\verb{action-group} [\code{\link{GtkActionGroup}} : *       : Read / Write]}{
89
114
 
90
115
The GtkActionGroup this GtkAction is associated with, or NULL (for internal use).
91
116
 
92
117
}
 
118
\item{\verb{always-show-image} [logical : Read / Write / Construct]}{
 
119
 
 
120
If \code{TRUE}, the action's menu item proxies will ignore the \verb{"gtk-menu-images"}
 
121
setting and always show their image, if available.
 
122
  
 
123
Use this property if the menu item would be useless or hard to use
 
124
without their image.
 
125
  Default value: FALSE  Since 2.20
 
126
 
 
127
}
 
128
\item{\verb{gicon} [\code{\link{GIcon}} : *                : Read / Write]}{
 
129
 
 
130
The \code{\link{GIcon}} displayed in the \code{\link{GtkAction}}.
 
131
  
 
132
Note that the stock icon is preferred, if the \verb{"stock-id"} 
 
133
property holds the id of an existing stock icon.
 
134
  
 
135
This is an appearance property and thus only applies if 
 
136
\verb{"use-action-appearance"} is \code{TRUE}.
 
137
  Since 2.16
 
138
 
 
139
}
93
140
\item{\verb{hide-if-empty} [logical : Read / Write]}{
94
141
 
95
142
When TRUE, empty menu proxies for this action are hidden.  Default value: TRUE
98
145
\item{\verb{icon-name} [character : *                : Read / Write]}{
99
146
 
100
147
The name of the icon from the icon theme. 
101
 
Note that the stock icon is preferred, if
102
 
the ::stock-id property holds the id of an
103
 
existing stock icon.  
104
 
 
105
 
  Default value: NULL  Since  2.10
 
148
  
 
149
Note that the stock icon is preferred, if the \verb{"stock-id"} 
 
150
property holds the id of an existing stock icon, and the \code{\link{GIcon}} is
 
151
preferred if the \verb{"gicon"} property is set. 
 
152
  
 
153
This is an appearance property and thus only applies if 
 
154
\verb{"use-action-appearance"} is \code{TRUE}.
 
155
  Default value: NULL  Since 2.10
106
156
 
107
157
}
108
158
\item{\verb{is-important} [logical : Read / Write]}{
114
164
 
115
165
The label used for menu items and buttons that activate
116
166
this action. If the label is \code{NULL}, GTK+ uses the stock 
117
 
label specified via the stock-id property.  
118
 
 
 
167
label specified via the stock-id property.
 
168
  
 
169
This is an appearance property and thus only applies if 
 
170
\verb{"use-action-appearance"} is \code{TRUE}.
119
171
  Default value: NULL
120
172
 
121
173
}
131
183
}
132
184
\item{\verb{short-label} [character : *                : Read / Write]}{
133
185
 
134
 
A shorter label that may be used on toolbar buttons.  Default value: NULL
 
186
A shorter label that may be used on toolbar buttons.
 
187
  
 
188
This is an appearance property and thus only applies if 
 
189
\verb{"use-action-appearance"} is \code{TRUE}.
 
190
  Default value: NULL
135
191
 
136
192
}
137
193
\item{\verb{stock-id} [character : *                : Read / Write]}{
138
194
 
139
 
The stock icon displayed in widgets representing this action.  Default value: NULL
 
195
The stock icon displayed in widgets representing this action.
 
196
  
 
197
This is an appearance property and thus only applies if 
 
198
\verb{"use-action-appearance"} is \code{TRUE}.
 
199
  Default value: NULL
140
200
 
141
201
}
142
202
\item{\verb{tooltip} [character : *                : Read / Write]}{
157
217
\item{\verb{visible-overflown} [logical : Read / Write]}{
158
218
 
159
219
When \code{TRUE}, toolitem proxies for this action are represented in the 
160
 
toolbar overflow menu.  
161
 
 
162
 
  Default value: TRUE  Since  2.6
 
220
toolbar overflow menu.
 
221
  Default value: TRUE  Since 2.6
163
222
 
164
223
}
165
224
\item{\verb{visible-vertical} [logical : Read / Write]}{
168
227
 
169
228
}
170
229
}}
171
 
\references{\url{http://developer.gnome.org/doc/API/2.0/gtk/GtkAction.html}}
 
230
\references{\url{http://library.gnome.org/devel//gtk/GtkAction.html}}
172
231
\author{Derived by RGtkGen from GTK+ documentation}
173
232
\seealso{
174
 
\verb{\link{GtkActionGroup}}
175
 
\verb{\link{GtkUIManager}}
 
233
\code{\link{GtkActionGroup}}
 
234
\code{\link{GtkUIManager}}
176
235
}
177
236
\keyword{internal}