/usr/include/giomm-2.4/giomm/simpleaction.h is in libglibmm-2.4-dev 2.42.0-1.
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 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_SIMPLEACTION_H
#define _GIOMM_SIMPLEACTION_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2011 The giomm Development Team
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <giomm/action.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GSimpleAction GSimpleAction;
typedef GObjectClass GSimpleActionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class SimpleAction_Class; } // namespace Gio
namespace Gio
{
/** SimpleAction - A simple Action implementation.
* A SimpleAction is the obvious simple implementation of the Action
* interface. This is the easiest way to create an action for purposes of
* adding it to a SimpleActionGroup.
*
* See also Gtk::Action.
*
* @newin{2,32}
*/
class SimpleAction : public Glib::Object, public Action
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef SimpleAction CppObjectType;
typedef SimpleAction_Class CppClassType;
typedef GSimpleAction BaseObjectType;
typedef GSimpleActionClass BaseClassType;
private: friend class SimpleAction_Class;
static CppClassType simpleaction_class_;
private:
// noncopyable
SimpleAction(const SimpleAction&);
SimpleAction& operator=(const SimpleAction&);
protected:
explicit SimpleAction(const Glib::ConstructParams& construct_params);
explicit SimpleAction(GSimpleAction* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~SimpleAction();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GSimpleAction* gobj() { return reinterpret_cast<GSimpleAction*>(gobject_); }
///Provides access to the underlying C GObject.
const GSimpleAction* gobj() const { return reinterpret_cast<GSimpleAction*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GSimpleAction* gobj_copy();
private:
protected:
/** Creates a new action.
*
* The created action is stateless.
*
* @param name The name of the action.
*/
explicit SimpleAction(const Glib::ustring& name);
/** Creates a new new stateful action.
*
* The created action is stateless.
*
* @a state is the initial state of the action. All future state values
* must have the same VariantType as the initial state.
*
* @param name The name of the action.
* @param state The initial state of the action.
*/
SimpleAction(const Glib::ustring& name, const Glib::VariantBase& state);
explicit SimpleAction(const Glib::ustring& name, const Glib::VariantType& parameter_type);
explicit SimpleAction(const Glib::ustring& name, const Glib::VariantType& parameter_type, const Glib::VariantBase& state);
public:
static Glib::RefPtr<SimpleAction> create(const Glib::ustring& name);
/** Creates a new action.
*
* The created action is stateless. See g_simple_action_new_stateful().
*
* @newin{2,28}
*
* @param name The name of the action.
* @param parameter_type The type of parameter to the activate function.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create(const Glib::ustring& name, const Glib::VariantType& parameter_type);
//TODO: Add a templated version of this to avoid the need fo Gio::Variant by the caller.
/** Creates a new stateful action.
*
* @a state is the initial state of the action. All future state values
* must have the same VariantType as the initial state.
*
* If the @a state GVariant is floating, it is consumed.
*
* @newin{2,28}
*
* @param name The name of the action.
* @param parameter_type The type of the parameter to the activate function.
* @param state The initial state of the action.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create(const Glib::ustring& name, const Glib::VariantType& parameter_type, const Glib::VariantBase& state);
//TODO: Add a templated version of this to avoid the need fo Gio::Variant by the caller.
/** Creates a new stateful action.
*
* @a state is the initial state of the action. All future state values
* must have the same VariantType as the initial state.
*
* @newin{2,38}
* @param name The name of the action.
* @param state The initial state of the action.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create(const Glib::ustring& name, const Glib::VariantBase& state);
//TODO: Use similar C API if they ever add it. Doing this manually is tedious. See https://bugzilla.gnome.org/show_bug.cgi?id=705655
//TODO: Create a derived SimpleToggleAction class for this?
//TODO: Document how the app must handle signal_activate() to call change_state().
/** Creates a new boolean stateful action.
*
* @a state is the initial state of the action. All future state values
* must also be bool.
*
* @newin{2,38}
* @param name The name of the action.
* @param state The initial state of the action.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create_bool(const Glib::ustring&name, bool state = false);
//TODO: Use similar C API if they ever add it. Doing this manually is tedious. See https://bugzilla.gnome.org/show_bug.cgi?id=705655
//TODO: Create a derived SimpleToggleAction class for this?
//TODO: Create convenience API that auto-changes the state, like Gtk::TreeView's append_column_editable()?
// See https://bugzilla.gnome.org/show_bug.cgi?id=705133 (it's not documented clearly at all).
//TODO: Check whether glib now has API to use enums for this: See https://bugzilla.gnome.org/show_bug.cgi?id=705483
//TODO: Suggest other API that could be used to activate or discover the currently-select radio value.
/** Creates a new radio action with a string-based target value.
*
* @newin{2,38}
* @param name The name of the action.
* @param initial_state The initial state of the action.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create_radio_string(const Glib::ustring& name, const Glib::ustring& initial_state);
//TODO: Use similar C API if they ever add it. Doing this manually is tedious. See https://bugzilla.gnome.org/show_bug.cgi?id=705655
//TODO: Create a derived SimpleToggleAction class for this?
//TODO: Create convenience API that auto-changes the state, like Gtk::TreeView's append_column_editable()?
// See https://bugzilla.gnome.org/show_bug.cgi?id=705133 (it's not documented clearly at all).
//TODO: Check whether glib now has API to use enums for this: See https://bugzilla.gnome.org/show_bug.cgi?id=705483
//TODO: Suggest other API that could be used to activate or discover the currently-select radio value.
//TODO: Check that the need for type="i" in the XML is documented: See https://bugzilla.gnome.org/show_bug.cgi?id=704392#c14
/** Creates a new radio action with an integer-based target value.
*
* @newin{2,38}
* @param name The name of the action.
* @param initial_state The initial state of the action.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create_radio_integer(const Glib::ustring& name, gint32 initial_state);
/** 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.
*
* @newin{2,28}
*
* @param enabled Whether the action is enabled.
*/
void set_enabled(bool enabled = true);
#ifdef GLIBMM_PROPERTIES_ENABLED
/** If the action can be activated.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_enabled() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** If the action can be activated.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_enabled() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The name used to invoke the action.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The type of GVariant passed to activate().
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::VariantType > property_parameter_type() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The state the action is in.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::VariantBase > property_state() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The state the action is in.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::VariantBase > property_state() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The type of the state kept by the action.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::VariantType > property_state_type() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
/**
* @par Slot Prototype:
* <tt>void on_my_%activate(const Glib::VariantBase& parameter)</tt>
*
* Indicates that the action was just activated.
*
* @a 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 <tt>0</tt> parameter
* type is to toggle them via the SimpleAction::signal_change_state() signal.
* For stateful actions where the state type is equal to the parameter
* type, the default is to forward them directly to
* SimpleAction::signal_change_state(). This should allow almost all users
* of SimpleAction to connect only one handler or the other.
*
* @newin{2,28}
*
* @param parameter The parameter to the activation.
*/
Glib::SignalProxy1< void,const Glib::VariantBase& > signal_activate();
/**
* @par Slot Prototype:
* <tt>void on_my_%change_state(const Glib::VariantBase& value)</tt>
*
* Indicates that the action just received a request to change its
* state.
*
* @a 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:
*
* [C example ellipted]
*
* 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.
*
* @newin{2,30}
*
* @param value The requested value for the state.
*/
Glib::SignalProxy1< void,const Glib::VariantBase& > signal_change_state();
protected:
//TODO: Add templated version of this, renaming this to set_state_variant(), like Action::change_state()?
//This is protected because the C docs say "This should only be called by the implementor of the action."
// though that is not entirely clear. We can make this public if somebody needs it.
/** 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 @a value GVariant is floating, it is consumed.
*
* @newin{2,30}
*
* @param value The new Variant for the state.
*/
void set_state(const Glib::VariantBase& value);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::SimpleAction
*/
Glib::RefPtr<Gio::SimpleAction> wrap(GSimpleAction* object, bool take_copy = false);
}
#endif /* _GIOMM_SIMPLEACTION_H */
|