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

« back to all changes in this revision

Viewing changes to man/GtkToolbar.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:
49
49
                     +----GtkContainer
50
50
                           +----GtkToolbar}}
51
51
\section{Interfaces}{GtkToolbar implements
52
 
 AtkImplementorIface and  \verb{\link{GtkBuildable}}.}
 
52
 AtkImplementorIface,  \code{\link{GtkBuildable}},  \code{\link{GtkToolShell}} and  \code{\link{GtkOrientable}}.}
53
53
\section{Detailed Description}{A toolbar is created with a call to \code{\link{gtkToolbarNew}}.
54
54
  
55
 
A toolbar can contain instances of a subclass of \verb{\link{GtkToolItem}}. To add
56
 
a \verb{\link{GtkToolItem}} to the a toolbar, use \code{\link{gtkToolbarInsert}}. To remove
 
55
A toolbar can contain instances of a subclass of \code{\link{GtkToolItem}}. To add
 
56
a \code{\link{GtkToolItem}} to the a toolbar, use \code{\link{gtkToolbarInsert}}. To remove
57
57
an item from the toolbar use \code{\link{gtkContainerRemove}}. To add a button
58
 
to the toolbar, add an instance of \verb{\link{GtkToolButton}}.
 
58
to the toolbar, add an instance of \code{\link{GtkToolButton}}.
59
59
  
60
60
Toolbar items can be visually grouped by adding instances of
61
 
\verb{\link{GtkSeparatorToolItem}} to the toolbar. If a \verb{\link{GtkSeparatorToolItem}} has
 
61
\code{\link{GtkSeparatorToolItem}} to the toolbar. If a \code{\link{GtkSeparatorToolItem}} has
62
62
the "expand" property set to \verb{TRUE} and the "draw" property set to
63
63
\verb{FALSE} the effect is to force all following items to the end of the
64
64
toolbar.
66
66
Creating a context menu for the toolbar can be done by connecting to
67
67
the \verb{"popup-context-menu"} signal.}
68
68
\section{Structures}{\describe{\item{\verb{GtkToolbar}}{
69
 
The \verb{\link{GtkToolbar}} struct only contains private data and should only be
 
69
The \code{\link{GtkToolbar}} struct only contains private data and should only be
70
70
accessed through the function described below.
71
71
 
72
72
}}}
74
74
\section{Enums and Flags}{\describe{
75
75
\item{\verb{GtkToolbarChildType}}{
76
76
\strong{WARNING: \code{GtkToolbarChildType} is deprecated and should not be used in newly-written code.}
77
 
\code{\link{GtkToolbarChildType}} is used to set the type of new elements that are added 
78
 
to a \verb{\link{GtkToolbar}}.
 
77
\code{\link{GtkToolbarChildType}} is used to set the type of new elements that are added
 
78
to a \code{\link{GtkToolbar}}.
79
79
 
80
80
\describe{
81
81
\item{\verb{space}}{a space in the style of the toolbar's \code{\link{GtkToolbarSpaceStyle}}.}
82
 
\item{\verb{button}}{a \verb{\link{GtkButton}}.}
83
 
\item{\verb{togglebutton}}{a \verb{\link{GtkToggleButton}}.}
84
 
\item{\verb{radiobutton}}{a \verb{\link{GtkRadioButton}}.}
85
 
\item{\verb{widget}}{a standard \verb{\link{GtkWidget}}.}
 
82
\item{\verb{button}}{a \code{\link{GtkButton}}.}
 
83
\item{\verb{togglebutton}}{a \code{\link{GtkToggleButton}}.}
 
84
\item{\verb{radiobutton}}{a \code{\link{GtkRadioButton}}.}
 
85
\item{\verb{widget}}{a standard \code{\link{GtkWidget}}.}
86
86
}
87
87
 
88
88
}
102
102
\section{Signals}{\describe{
103
103
\item{\code{focus-home-or-end(toolbar, focus.home, user.data)}}{
104
104
A keybinding signal used internally by GTK+. This signal can't
105
 
be used in application code  
 
105
be used in application code
106
106
 
107
107
\describe{
108
 
\item{\code{toolbar}}{[\verb{\link{GtkToolbar}}]  the \verb{\link{GtkToolbar}} which emitted the signal}
109
 
\item{\code{focus.home}}{[logical] \code{TRUE} if the first item should be focused}
110
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
108
\item{\code{toolbar}}{the \code{\link{GtkToolbar}} which emitted the signal}
 
109
\item{\code{focus.home}}{\code{TRUE} if the first item should be focused}
 
110
\item{\code{user.data}}{user data set when the signal handler was connected.}
111
111
}
112
112
 
113
113
\emph{Returns:} [logical] \code{TRUE} if the signal was handled, \code{FALSE} if not
114
114
 
115
115
}
116
116
\item{\code{orientation-changed(toolbar, orientation, user.data)}}{
117
 
Emitted when the orientation of the toolbar changes.  
 
117
Emitted when the orientation of the toolbar changes.
118
118
 
119
119
\describe{
120
 
\item{\code{toolbar}}{[\verb{\link{GtkToolbar}}]  the object which emitted the signal}
121
 
\item{\code{orientation}}{[\code{\link{GtkOrientation}}]  the new \code{\link{GtkOrientation}} of the toolbar}
122
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
120
\item{\code{toolbar}}{the object which emitted the signal}
 
121
\item{\code{orientation}}{the new \code{\link{GtkOrientation}} of the toolbar}
 
122
\item{\code{user.data}}{user data set when the signal handler was connected.}
123
123
}
124
124
 
125
125
 
132
132
to display a context menu on the toolbar. The context-menu should
133
133
appear at the coordinates given by \code{x} and \code{y}. The mouse button
134
134
number is given by the \code{button} parameter. If the menu was popped
135
 
up using the keybaord, \code{button} is -1.  
 
135
up using the keybaord, \code{button} is -1.
136
136
 
137
137
\describe{
138
 
\item{\code{toolbar}}{[\verb{\link{GtkToolbar}}]  the \verb{\link{GtkToolbar}} which emitted the signal}
139
 
\item{\code{x}}{[integer]  the x coordinate of the point where the menu should appear}
140
 
\item{\code{y}}{[integer]  the y coordinate of the point where the menu should appear}
141
 
\item{\code{button}}{[integer]  the mouse button the user pressed, or -1}
142
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
138
\item{\code{toolbar}}{the \code{\link{GtkToolbar}} which emitted the signal}
 
139
\item{\code{x}}{the x coordinate of the point where the menu should appear}
 
140
\item{\code{y}}{the y coordinate of the point where the menu should appear}
 
141
\item{\code{button}}{the mouse button the user pressed, or -1}
 
142
\item{\code{user.data}}{user data set when the signal handler was connected.}
143
143
}
144
144
 
145
145
\emph{Returns:} [logical]  return \code{TRUE} if the signal was handled, \code{FALSE} if not
146
146
 
147
147
}
148
148
\item{\code{style-changed(toolbar, style, user.data)}}{
149
 
Emitted when the style of the toolbar changes.  
 
149
Emitted when the style of the toolbar changes.
150
150
 
151
151
\describe{
152
 
\item{\code{toolbar}}{[\verb{\link{GtkToolbar}}]  The \verb{\link{GtkToolbar}} which emitted the signal}
153
 
\item{\code{style}}{[\code{\link{GtkToolbarStyle}}]  the new \code{\link{GtkToolbarStyle}} of the toolbar}
154
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
152
\item{\code{toolbar}}{The \code{\link{GtkToolbar}} which emitted the signal}
 
153
\item{\code{style}}{the new \code{\link{GtkToolbarStyle}} of the toolbar}
 
154
\item{\code{user.data}}{user data set when the signal handler was connected.}
155
155
}
156
156
 
157
157
 
158
158
}
159
159
}}
160
160
\section{Properties}{\describe{
161
 
\item{\verb{icon-size} [\code{\link{GtkIconSize}} : Read / Write]}{
 
161
\item{\verb{icon-size} [integer : Read / Write]}{
162
162
 
163
163
The size of the icons in a toolbar is normally determined by
164
 
the toolbar-icon-size setting. When this property is set, it 
 
164
the toolbar-icon-size setting. When this property is set, it
165
165
overrides the setting. 
166
166
  
167
167
This should only be used for special-purpose toolbars, normal
168
168
application toolbars should respect the user preferences for the
169
 
size of icons.  
170
 
 
171
 
  Default value: GTK_ICON_SIZE_LARGE_TOOLBAR  Since  2.10
 
169
size of icons.
 
170
  Allowed values: >= 0  Default value: 3  Since 2.10
172
171
 
173
172
}
174
173
\item{\verb{icon-size-set} [logical : Read / Write]}{
175
174
 
176
 
Is \code{TRUE} if the icon-size property has been set.  
177
 
 
178
 
  Default value: FALSE  Since  2.10
179
 
 
180
 
}
181
 
\item{\verb{orientation} [\code{\link{GtkOrientation}} : Read / Write]}{
182
 
 
183
 
The orientation of the toolbar.  Default value: GTK_ORIENTATION_HORIZONTAL
 
175
Is \code{TRUE} if the icon-size property has been set.
 
176
  Default value: FALSE  Since 2.10
184
177
 
185
178
}
186
179
\item{\verb{show-arrow} [logical : Read / Write]}{
195
188
}
196
189
\item{\verb{tooltips} [logical : Read / Write]}{
197
190
 
198
 
If the tooltips of the toolbar should be active or not.  
199
 
 
200
 
  Default value: TRUE  Since  2.8
 
191
If the tooltips of the toolbar should be active or not.
 
192
  Default value: TRUE  Since 2.8
201
193
 
202
194
}
203
195
}}
233
225
 
234
226
}
235
227
}}
236
 
\references{\url{http://developer.gnome.org/doc/API/2.0/gtk/GtkToolbar.html}}
 
228
\references{\url{http://library.gnome.org/devel//gtk/GtkToolbar.html}}
237
229
\author{Derived by RGtkGen from GTK+ documentation}
238
230
\keyword{internal}