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

« back to all changes in this revision

Viewing changes to man/GtkMenuItem.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:
8
8
\code{\link{gtkMenuItemNewWithLabel}(label, show = TRUE)}\cr
9
9
\code{\link{gtkMenuItemNewWithMnemonic}(label, show = TRUE)}\cr
10
10
\code{\link{gtkMenuItemSetRightJustified}(object, right.justified)}\cr
 
11
\code{\link{gtkMenuItemGetRightJustified}(object)}\cr
 
12
\code{\link{gtkMenuItemGetLabel}(object)}\cr
 
13
\code{\link{gtkMenuItemSetLabel}(object, label)}\cr
 
14
\code{\link{gtkMenuItemGetUseUnderline}(object)}\cr
 
15
\code{\link{gtkMenuItemSetUseUnderline}(object, setting)}\cr
11
16
\code{\link{gtkMenuItemSetSubmenu}(object, submenu)}\cr
 
17
\code{\link{gtkMenuItemGetSubmenu}(object)}\cr
 
18
\code{\link{gtkMenuItemRemoveSubmenu}(object)}\cr
12
19
\code{\link{gtkMenuItemSetAccelPath}(object, accel.path)}\cr
13
 
\code{\link{gtkMenuItemRemoveSubmenu}(object)}\cr
 
20
\code{\link{gtkMenuItemGetAccelPath}(object)}\cr
14
21
\code{\link{gtkMenuItemSelect}(object)}\cr
15
22
\code{\link{gtkMenuItemDeselect}(object)}\cr
16
23
\code{\link{gtkMenuItemActivate}(object)}\cr
17
24
\code{\link{gtkMenuItemToggleSizeRequest}(object, requisition)}\cr
18
25
\code{\link{gtkMenuItemToggleSizeAllocate}(object, allocation)}\cr
19
 
\code{\link{gtkMenuItemGetRightJustified}(object)}\cr
20
 
\code{\link{gtkMenuItemGetSubmenu}(object)}\cr
21
26
\code{gtkMenuItem(label, show = TRUE)}
22
27
}
23
28
\section{Hierarchy}{\preformatted{GObject
33
38
                                             +----GtkSeparatorMenuItem
34
39
                                             +----GtkTearoffMenuItem}}
35
40
\section{Interfaces}{GtkMenuItem implements
36
 
 AtkImplementorIface and  \verb{\link{GtkBuildable}}.}
37
 
\section{Detailed Description}{The \verb{\link{GtkMenuItem}} widget and the derived widgets are the only valid
 
41
 AtkImplementorIface,  \code{\link{GtkBuildable}} and  \code{\link{GtkActivatable}}.}
 
42
\section{Detailed Description}{The \code{\link{GtkMenuItem}} widget and the derived widgets are the only valid
38
43
childs for menus. Their function is to correctly handle highlighting,
39
44
alignment, events and submenus.
40
45
  
41
 
As it derives from \verb{\link{GtkBin}} it can hold any valid child widget, altough
 
46
As it derives from \code{\link{GtkBin}} it can hold any valid child widget, altough
42
47
only a few are really useful.}
 
48
\section{GtkMenuItem as GtkBuildable}{The GtkMenuItem implementation of the GtkBuildable interface
 
49
supports adding a submenu by specifying "submenu" as the "type"
 
50
attribute of a <child> element.
 
51
  
 
52
 \emph{A UI definition fragment with submenus}\preformatted{<object class="GtkMenuItem">
 
53
  <child type="submenu">
 
54
    <object class="GtkMenu"/>
 
55
  </child>
 
56
</object>
 
57
}}
43
58
\section{Structures}{\describe{\item{\verb{GtkMenuItem}}{
44
59
\emph{undocumented
45
60
}
51
66
Emitted when the item is activated.
52
67
 
53
68
\describe{
54
 
\item{\code{menuitem}}{[\verb{\link{GtkMenuItem}}] the object which received the signal.}
55
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
69
\item{\code{menuitem}}{the object which received the signal.}
 
70
\item{\code{user.data}}{user data set when the signal handler was connected.}
56
71
}
57
72
 
58
73
 
62
77
submenu. For normal applications, the relevant signal is "activate".
63
78
 
64
79
\describe{
65
 
\item{\code{menuitem}}{[\verb{\link{GtkMenuItem}}] the object which received the signal.}
66
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
80
\item{\code{menuitem}}{the object which received the signal.}
 
81
\item{\code{user.data}}{user data set when the signal handler was connected.}
67
82
}
68
83
 
69
84
 
73
88
}
74
89
 
75
90
\describe{
76
 
\item{\code{menuitem}}{[\verb{\link{GtkMenuItem}}] the object which received the signal.}
77
 
\item{\code{arg1}}{[integer] }
78
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
91
\item{\code{menuitem}}{the object which received the signal.}
 
92
\item{\code{arg1}}{\emph{undocumented
 
93
}}
 
94
\item{\code{user.data}}{user data set when the signal handler was connected.}
79
95
}
80
96
 
81
97
 
85
101
}
86
102
 
87
103
\describe{
88
 
\item{\code{menuitem}}{[\verb{\link{GtkMenuItem}}] the object which received the signal.}
89
 
\item{\code{arg1}}{[R object] }
90
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
91
 
}
92
 
 
93
 
 
94
 
}
95
 
}}
96
 
\section{Properties}{\describe{\item{\verb{submenu} [\verb{\link{GtkMenu}} : *              : Read / Write]}{
97
 
 
98
 
The submenu attached to the menu item, or NULL if it has none.  
99
 
 
100
 
  Since  2.12
101
 
 
102
 
}}}
 
104
\item{\code{menuitem}}{the object which received the signal.}
 
105
\item{\code{arg1}}{\emph{undocumented
 
106
}}
 
107
\item{\code{user.data}}{user data set when the signal handler was connected.}
 
108
}
 
109
 
 
110
 
 
111
}
 
112
}}
 
113
\section{Properties}{\describe{
 
114
\item{\verb{accel-path} [character : *                : Read / Write]}{
 
115
 
 
116
Sets the accelerator path of the menu item, through which runtime
 
117
changes of the menu item's accelerator caused by the user can be
 
118
identified and saved to persistant storage.
 
119
  Default value: NULL  Since 2.14
 
120
 
 
121
}
 
122
\item{\verb{label} [character : *                : Read / Write]}{
 
123
 
 
124
The text for the child label.
 
125
  Default value: ""  Since 2.16
 
126
 
 
127
}
 
128
\item{\verb{right-justified} [logical : Read / Write]}{
 
129
 
 
130
Sets whether the menu item appears justified at the right side of a menu bar.
 
131
  Default value: FALSE  Since 2.14
 
132
 
 
133
}
 
134
\item{\verb{submenu} [\code{\link{GtkMenu}} : *              : Read / Write]}{
 
135
 
 
136
The submenu attached to the menu item, or NULL if it has none.
 
137
  Since 2.12
 
138
 
 
139
}
 
140
\item{\verb{use-underline} [logical : Read / Write]}{
 
141
 
 
142
\code{TRUE} if underlines in the text indicate mnemonics
 
143
  Default value: FALSE  Since 2.16
 
144
 
 
145
}
 
146
}}
103
147
\section{Style Properties}{\describe{
 
148
\item{\verb{arrow-scaling} [numeric : Read]}{
 
149
 
 
150
Amount of space used up by arrow, relative to the menu item's font size.  Allowed values: [0,2]  Default value: 0.8
 
151
 
 
152
}
104
153
\item{\verb{arrow-spacing} [integer : Read]}{
105
154
 
106
155
Space between label and arrow.  Allowed values: >= 0  Default value: 10
121
170
Space between icon and label.  Allowed values: >= 0  Default value: 5
122
171
 
123
172
}
 
173
\item{\verb{width-chars} [integer : Read]}{
 
174
 
 
175
The minimum desired width of the menu item in characters.
 
176
  Allowed values: >= 0  Default value: 12  Since 2.14
 
177
 
 
178
}
124
179
}}
125
 
\references{\url{http://developer.gnome.org/doc/API/2.0/gtk/GtkMenuItem.html}}
 
180
\references{\url{http://library.gnome.org/devel//gtk/GtkMenuItem.html}}
126
181
\author{Derived by RGtkGen from GTK+ documentation}
127
182
\keyword{internal}