/usr/include/d/gtkd-3/gio/MenuItem.d is in libgtkd-3-dev 3.7.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | /*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gio.MenuItem;
private import gio.IconIF;
private import gio.MenuModel;
private import gio.c.functions;
public import gio.c.types;
private import glib.ConstructionException;
private import glib.Str;
private import glib.Variant;
private import glib.VariantType;
private import gobject.ObjectG;
public import gtkc.giotypes;
/**
* #GMenuItem is an opaque structure type. You must access it using the
* functions below.
*
* Since: 2.32
*/
public class MenuItem : ObjectG
{
/** the main Gtk struct */
protected GMenuItem* gMenuItem;
/** Get the main Gtk struct */
public GMenuItem* getMenuItemStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gMenuItem;
}
/** the main Gtk struct as a void* */
protected override void* getStruct()
{
return cast(void*)gMenuItem;
}
protected override void setStruct(GObject* obj)
{
gMenuItem = cast(GMenuItem*)obj;
super.setStruct(obj);
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GMenuItem* gMenuItem, bool ownedRef = false)
{
this.gMenuItem = gMenuItem;
super(cast(GObject*)gMenuItem, ownedRef);
}
/** */
public static GType getType()
{
return g_menu_item_get_type();
}
/**
* Creates a new #GMenuItem.
*
* If @label is non-%NULL it is used to set the "label" attribute of the
* new item.
*
* If @detailed_action is non-%NULL it is used to set the "action" and
* possibly the "target" attribute of the new item. See
* g_menu_item_set_detailed_action() for more information.
*
* Params:
* label = the section label, or %NULL
* detailedAction = the detailed action string, or %NULL
*
* Returns: a new #GMenuItem
*
* Since: 2.32
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(string label, string detailedAction)
{
auto p = g_menu_item_new(Str.toStringz(label), Str.toStringz(detailedAction));
if(p is null)
{
throw new ConstructionException("null returned by new");
}
this(cast(GMenuItem*) p, true);
}
/**
* Creates a #GMenuItem as an exact copy of an existing menu item in a
* #GMenuModel.
*
* @item_index must be valid (ie: be sure to call
* g_menu_model_get_n_items() first).
*
* Params:
* model = a #GMenuModel
* itemIndex = the index of an item in @model
*
* Returns: a new #GMenuItem.
*
* Since: 2.34
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(MenuModel model, int itemIndex)
{
auto p = g_menu_item_new_from_model((model is null) ? null : model.getMenuModelStruct(), itemIndex);
if(p is null)
{
throw new ConstructionException("null returned by new_from_model");
}
this(cast(GMenuItem*) p, true);
}
/**
* Queries the named @attribute on @menu_item.
*
* If @expected_type is specified and the attribute does not have this
* type, %NULL is returned. %NULL is also returned if the attribute
* simply does not exist.
*
* Params:
* attribute = the attribute name to query
* expectedType = the expected type of the attribute
*
* Returns: the attribute value, or %NULL
*
* Since: 2.34
*/
public Variant getAttributeValue(string attribute, VariantType expectedType)
{
auto p = g_menu_item_get_attribute_value(gMenuItem, Str.toStringz(attribute), (expectedType is null) ? null : expectedType.getVariantTypeStruct());
if(p is null)
{
return null;
}
return new Variant(cast(GVariant*) p, true);
}
/**
* Queries the named @link on @menu_item.
*
* Params:
* link = the link name to query
*
* Returns: the link, or %NULL
*
* Since: 2.34
*/
public MenuModel getLink(string link)
{
auto p = g_menu_item_get_link(gMenuItem, Str.toStringz(link));
if(p is null)
{
return null;
}
return ObjectG.getDObject!(MenuModel)(cast(GMenuModel*) p, true);
}
/**
* Sets or unsets the "action" and "target" attributes of @menu_item.
*
* If @action is %NULL then both the "action" and "target" attributes
* are unset (and @target_value is ignored).
*
* If @action is non-%NULL then the "action" attribute is set. The
* "target" attribute is then set to the value of @target_value if it is
* non-%NULL or unset otherwise.
*
* Normal menu items (ie: not submenu, section or other custom item
* types) are expected to have the "action" attribute set to identify
* the action that they are associated with. The state type of the
* action help to determine the disposition of the menu item. See
* #GAction and #GActionGroup for an overview of actions.
*
* In general, clicking on the menu item will result in activation of
* the named action with the "target" attribute given as the parameter
* to the action invocation. If the "target" attribute is not set then
* the action is invoked with no parameter.
*
* If the action has no state then the menu item is usually drawn as a
* plain menu item (ie: with no additional decoration).
*
* If the action has a boolean state then the menu item is usually drawn
* as a toggle menu item (ie: with a checkmark or equivalent
* indication). The item should be marked as 'toggled' or 'checked'
* when the boolean state is %TRUE.
*
* If the action has a string state then the menu item is usually drawn
* as a radio menu item (ie: with a radio bullet or equivalent
* indication). The item should be marked as 'selected' when the string
* state is equal to the value of the @target property.
*
* See g_menu_item_set_action_and_target() or
* g_menu_item_set_detailed_action() for two equivalent calls that are
* probably more convenient for most uses.
*
* Params:
* action = the name of the action for this item
* targetValue = a #GVariant to use as the action target
*
* Since: 2.32
*/
public void setActionAndTargetValue(string action, Variant targetValue)
{
g_menu_item_set_action_and_target_value(gMenuItem, Str.toStringz(action), (targetValue is null) ? null : targetValue.getVariantStruct());
}
/**
* Sets or unsets an attribute on @menu_item.
*
* The attribute to set or unset is specified by @attribute. This
* can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL,
* %G_MENU_ATTRIBUTE_ACTION, %G_MENU_ATTRIBUTE_TARGET, or a custom
* attribute name.
* Attribute names are restricted to lowercase characters, numbers
* and '-'. Furthermore, the names must begin with a lowercase character,
* must not end with a '-', and must not contain consecutive dashes.
*
* must consist only of lowercase
* ASCII characters, digits and '-'.
*
* If @value is non-%NULL then it is used as the new value for the
* attribute. If @value is %NULL then the attribute is unset. If
* the @value #GVariant is floating, it is consumed.
*
* See also g_menu_item_set_attribute() for a more convenient way to do
* the same.
*
* Params:
* attribute = the attribute to set
* value = a #GVariant to use as the value, or %NULL
*
* Since: 2.32
*/
public void setAttributeValue(string attribute, Variant value)
{
g_menu_item_set_attribute_value(gMenuItem, Str.toStringz(attribute), (value is null) ? null : value.getVariantStruct());
}
/**
* Sets the "action" and possibly the "target" attribute of @menu_item.
*
* The format of @detailed_action is the same format parsed by
* g_action_parse_detailed_name().
*
* See g_menu_item_set_action_and_target() or
* g_menu_item_set_action_and_target_value() for more flexible (but
* slightly less convenient) alternatives.
*
* See also g_menu_item_set_action_and_target_value() for a description of
* the semantics of the action and target attributes.
*
* Params:
* detailedAction = the "detailed" action string
*
* Since: 2.32
*/
public void setDetailedAction(string detailedAction)
{
g_menu_item_set_detailed_action(gMenuItem, Str.toStringz(detailedAction));
}
/**
* Sets (or unsets) the icon on @menu_item.
*
* This call is the same as calling g_icon_serialize() and using the
* result as the value to g_menu_item_set_attribute_value() for
* %G_MENU_ATTRIBUTE_ICON.
*
* This API is only intended for use with "noun" menu items; things like
* bookmarks or applications in an "Open With" menu. Don't use it on
* menu items corresponding to verbs (eg: stock icons for 'Save' or
* 'Quit').
*
* If @icon is %NULL then the icon is unset.
*
* Params:
* icon = a #GIcon, or %NULL
*
* Since: 2.38
*/
public void setIcon(IconIF icon)
{
g_menu_item_set_icon(gMenuItem, (icon is null) ? null : icon.getIconStruct());
}
/**
* Sets or unsets the "label" attribute of @menu_item.
*
* If @label is non-%NULL it is used as the label for the menu item. If
* it is %NULL then the label attribute is unset.
*
* Params:
* label = the label to set, or %NULL to unset
*
* Since: 2.32
*/
public void setLabel(string label)
{
g_menu_item_set_label(gMenuItem, Str.toStringz(label));
}
/**
* Creates a link from @menu_item to @model if non-%NULL, or unsets it.
*
* Links are used to establish a relationship between a particular menu
* item and another menu. For example, %G_MENU_LINK_SUBMENU is used to
* associate a submenu with a particular menu item, and %G_MENU_LINK_SECTION
* is used to create a section. Other types of link can be used, but there
* is no guarantee that clients will be able to make sense of them.
* Link types are restricted to lowercase characters, numbers
* and '-'. Furthermore, the names must begin with a lowercase character,
* must not end with a '-', and must not contain consecutive dashes.
*
* Params:
* link = type of link to establish or unset
* model = the #GMenuModel to link to (or %NULL to unset)
*
* Since: 2.32
*/
public void setLink(string link, MenuModel model)
{
g_menu_item_set_link(gMenuItem, Str.toStringz(link), (model is null) ? null : model.getMenuModelStruct());
}
/**
* Sets or unsets the "section" link of @menu_item to @section.
*
* The effect of having one menu appear as a section of another is
* exactly as it sounds: the items from @section become a direct part of
* the menu that @menu_item is added to. See g_menu_item_new_section()
* for more information about what it means for a menu item to be a
* section.
*
* Params:
* section = a #GMenuModel, or %NULL
*
* Since: 2.32
*/
public void setSection(MenuModel section)
{
g_menu_item_set_section(gMenuItem, (section is null) ? null : section.getMenuModelStruct());
}
/**
* Sets or unsets the "submenu" link of @menu_item to @submenu.
*
* If @submenu is non-%NULL, it is linked to. If it is %NULL then the
* link is unset.
*
* The effect of having one menu appear as a submenu of another is
* exactly as it sounds.
*
* Params:
* submenu = a #GMenuModel, or %NULL
*
* Since: 2.32
*/
public void setSubmenu(MenuModel submenu)
{
g_menu_item_set_submenu(gMenuItem, (submenu is null) ? null : submenu.getMenuModelStruct());
}
}
|