/usr/include/d/gtkd-3/gio/SimpleAction.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 | /*
* 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.SimpleAction;
private import gio.ActionIF;
private import gio.ActionT;
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;
private import gobject.Signals;
public import gtkc.giotypes;
private import std.algorithm;
/**
* A #GSimpleAction is the obvious simple implementation of the #GAction
* interface. This is the easiest way to create an action for purposes of
* adding it to a #GSimpleActionGroup.
*
* See also #GtkAction.
*/
public class SimpleAction : ObjectG, ActionIF
{
/** the main Gtk struct */
protected GSimpleAction* gSimpleAction;
/** Get the main Gtk struct */
public GSimpleAction* getSimpleActionStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gSimpleAction;
}
/** the main Gtk struct as a void* */
protected override void* getStruct()
{
return cast(void*)gSimpleAction;
}
protected override void setStruct(GObject* obj)
{
gSimpleAction = cast(GSimpleAction*)obj;
super.setStruct(obj);
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GSimpleAction* gSimpleAction, bool ownedRef = false)
{
this.gSimpleAction = gSimpleAction;
super(cast(GObject*)gSimpleAction, ownedRef);
}
// add the Action capabilities
mixin ActionT!(GSimpleAction);
/** */
public static GType getType()
{
return g_simple_action_get_type();
}
/**
* Creates a new action.
*
* The created action is stateless. See g_simple_action_new_stateful().
*
* Params:
* name = the name of the action
* parameterType = the type of parameter to the activate function
*
* Returns: a new #GSimpleAction
*
* Since: 2.28
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(string name, VariantType parameterType)
{
auto p = g_simple_action_new(Str.toStringz(name), (parameterType is null) ? null : parameterType.getVariantTypeStruct());
if(p is null)
{
throw new ConstructionException("null returned by new");
}
this(cast(GSimpleAction*) p, true);
}
/**
* Creates a new stateful action.
*
* @state is the initial state of the action. All future state values
* must have the same #GVariantType as the initial state.
*
* If the @state GVariant is floating, it is consumed.
*
* Params:
* name = the name of the action
* parameterType = the type of the parameter to the activate function
* state = the initial state of the action
*
* Returns: a new #GSimpleAction
*
* Since: 2.28
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(string name, VariantType parameterType, Variant state)
{
auto p = g_simple_action_new_stateful(Str.toStringz(name), (parameterType is null) ? null : parameterType.getVariantTypeStruct(), (state is null) ? null : state.getVariantStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_stateful");
}
this(cast(GSimpleAction*) p, true);
}
/**
* Sets the action as enabled or not.
*
* An action must be enabled in order to be activated or in order to
* have its state changed from outside callers.
*
* This should only be called by the implementor of the action. Users
* of the action should not attempt to modify its enabled flag.
*
* Params:
* enabled = whether the action is enabled
*
* Since: 2.28
*/
public void setEnabled(bool enabled)
{
g_simple_action_set_enabled(gSimpleAction, enabled);
}
/**
* Sets the state of the action.
*
* This directly updates the 'state' property to the given value.
*
* This should only be called by the implementor of the action. Users
* of the action should not attempt to directly modify the 'state'
* property. Instead, they should call g_action_change_state() to
* request the change.
*
* If the @value GVariant is floating, it is consumed.
*
* Params:
* value = the new #GVariant for the state
*
* Since: 2.30
*/
public void setState(Variant value)
{
g_simple_action_set_state(gSimpleAction, (value is null) ? null : value.getVariantStruct());
}
/**
* Sets the state hint for the action.
*
* See g_action_get_state_hint() for more information about
* action state hints.
*
* Params:
* stateHint = a #GVariant representing the state hint
*
* Since: 2.44
*/
public void setStateHint(Variant stateHint)
{
g_simple_action_set_state_hint(gSimpleAction, (stateHint is null) ? null : stateHint.getVariantStruct());
}
protected class OnActivateDelegateWrapper
{
void delegate(Variant, SimpleAction) dlg;
gulong handlerId;
this(void delegate(Variant, SimpleAction) dlg)
{
this.dlg = dlg;
onActivateListeners ~= this;
}
void remove(OnActivateDelegateWrapper source)
{
foreach(index, wrapper; onActivateListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onActivateListeners[index] = null;
onActivateListeners = std.algorithm.remove(onActivateListeners, index);
break;
}
}
}
}
OnActivateDelegateWrapper[] onActivateListeners;
/**
* Indicates that the action was just activated.
*
* @parameter will always be of the expected type. In the event that
* an incorrect type was given, no signal will be emitted.
*
* Since GLib 2.40, if no handler is connected to this signal then the
* default behaviour for boolean-stated actions with a %NULL parameter
* type is to toggle them via the #GSimpleAction::change-state signal.
* For stateful actions where the state type is equal to the parameter
* type, the default is to forward them directly to
* #GSimpleAction::change-state. This should allow almost all users
* of #GSimpleAction to connect only one handler or the other.
*
* Params:
* parameter = the parameter to the activation
*
* Since: 2.28
*/
gulong addOnActivate(void delegate(Variant, SimpleAction) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnActivateDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"activate",
cast(GCallback)&callBackActivate,
cast(void*)wrapper,
cast(GClosureNotify)&callBackActivateDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackActivate(GSimpleAction* simpleactionStruct, GVariant* parameter, OnActivateDelegateWrapper wrapper)
{
wrapper.dlg(new Variant(parameter), wrapper.outer);
}
extern(C) static void callBackActivateDestroy(OnActivateDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnChangeStateDelegateWrapper
{
void delegate(Variant, SimpleAction) dlg;
gulong handlerId;
this(void delegate(Variant, SimpleAction) dlg)
{
this.dlg = dlg;
onChangeStateListeners ~= this;
}
void remove(OnChangeStateDelegateWrapper source)
{
foreach(index, wrapper; onChangeStateListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onChangeStateListeners[index] = null;
onChangeStateListeners = std.algorithm.remove(onChangeStateListeners, index);
break;
}
}
}
}
OnChangeStateDelegateWrapper[] onChangeStateListeners;
/**
* Indicates that the action just received a request to change its
* state.
*
* @value will always be of the correct state type. In the event that
* an incorrect type was given, no signal will be emitted.
*
* If no handler is connected to this signal then the default
* behaviour is to call g_simple_action_set_state() to set the state
* to the requested value. If you connect a signal handler then no
* default action is taken. If the state should change then you must
* call g_simple_action_set_state() from the handler.
*
* An example of a 'change-state' handler:
* |[<!-- language="C" -->
* static void
* change_volume_state (GSimpleAction *action,
* GVariant *value,
* gpointer user_data)
* {
* gint requested;
*
* requested = g_variant_get_int32 (value);
*
* // Volume only goes from 0 to 10
* if (0 <= requested && requested <= 10)
* g_simple_action_set_state (action, value);
* }
* ]|
*
* The handler need not set the state to the requested value.
* It could set it to any value at all, or take some other action.
*
* Params:
* value = the requested value for the state
*
* Since: 2.30
*/
gulong addOnChangeState(void delegate(Variant, SimpleAction) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnChangeStateDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"change-state",
cast(GCallback)&callBackChangeState,
cast(void*)wrapper,
cast(GClosureNotify)&callBackChangeStateDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackChangeState(GSimpleAction* simpleactionStruct, GVariant* value, OnChangeStateDelegateWrapper wrapper)
{
wrapper.dlg(new Variant(value), wrapper.outer);
}
extern(C) static void callBackChangeStateDestroy(OnChangeStateDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
}
|