/usr/include/giomm-2.4/giomm/actiongroup.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 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_ACTIONGROUP_H
#define _GIOMM_ACTIONGROUP_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2010 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/interface.h>
#include <glibmm/varianttype.h>
#include <gio/gio.h> //To declare g_action_group_get_action_state_type().
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GActionGroupInterface GActionGroupInterface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GActionGroup GActionGroup;
typedef struct _GActionGroupClass GActionGroupClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class ActionGroup_Class; } // namespace Gio
namespace Glib
{
class VariantBase;
class VariantContainerBase;
class VariantType;
}
namespace Gio
{
/** ActionGroup - a group of actions.
* ActionGroup represents a group of actions.
*
* Each action in the group has a unique name (which is a string). All method
* calls, except list_actions() take the name of an action as an argument.
*
* The GActionGroup API is meant to be the 'public' API to the action group.
* The calls here are exactly the interaction that 'external forces' (eg: UI,
* incoming D-Bus messages, etc.) are supposed to have with actions.
* 'Internal' APIs (ie: ones meant only to be accessed by the action group
* implementation) are found on subclasses. This is why you will find -- for
* example -- get_action_enabled() but not an equivalent @c set() call.
*
* Signals are emitted on the action group in response to state changes on
* individual actions.
*/
class ActionGroup : public Glib::Interface
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef ActionGroup CppObjectType;
typedef ActionGroup_Class CppClassType;
typedef GActionGroup BaseObjectType;
typedef GActionGroupInterface BaseClassType;
private:
friend class ActionGroup_Class;
static CppClassType actiongroup_class_;
// noncopyable
ActionGroup(const ActionGroup&);
ActionGroup& operator=(const ActionGroup&);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
/**
* You should derive from this class to use it.
*/
ActionGroup();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Called by constructors of derived classes. Provide the result of
* the Class init() function to ensure that it is properly
* initialized.
*
* @param interface_class The Class object for the derived type.
*/
explicit ActionGroup(const Glib::Interface_Class& interface_class);
public:
// This is public so that C++ wrapper instances can be
// created for C instances of unwrapped types.
// For instance, if an unexpected C type implements the C interface.
explicit ActionGroup(GActionGroup* castitem);
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~ActionGroup();
static void add_interface(GType gtype_implementer);
/** 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.
GActionGroup* gobj() { return reinterpret_cast<GActionGroup*>(gobject_); }
///Provides access to the underlying C GObject.
const GActionGroup* gobj() const { return reinterpret_cast<GActionGroup*>(gobject_); }
private:
public:
/** Checks if the named action exists within @a action_group.
*
* @newin{2,28}
*
* @param action_name The name of the action to check for.
* @return Whether the named action exists.
*/
bool has_action(const Glib::ustring& action_name) const;
/** Lists the actions contained within @a action_group.
*
* The caller is responsible for freeing the list with Glib::strfreev() when
* it is no longer required.
*
* @newin{2,28}
*
* @return A <tt>0</tt>-terminated array of the names of the
* actions in the groupb.
*/
std::vector<Glib::ustring> list_actions() const;
//TODO: Add templated method, renaming this to query_action_variant).
/** Queries all aspects of the named action within an @a action_group.
*
* This function acquires the information available from
* g_action_group_has_action(), g_action_group_get_action_enabled(),
* g_action_group_get_action_parameter_type(),
* g_action_group_get_action_state_type(),
* g_action_group_get_action_state_hint() and
* g_action_group_get_action_state() with a single function call.
*
* This provides two main benefits.
*
* The first is the improvement in efficiency that comes with not having
* to perform repeated lookups of the action in order to discover
* different things about it. The second is that implementing
* ActionGroup can now be done by only overriding this one virtual
* function.
*
* The interface provides a default implementation of this function that
* calls the individual functions, as required, to fetch the
* information. The interface also provides default implementations of
* those functions that call this function. All implementations,
* therefore, must override either this function or all of the others.
*
* If the action exists, <tt>true</tt> is returned and any of the requested
* fields (as indicated by having a non-<tt>0</tt> reference passed in) are
* filled. If the action doesn't exist, <tt>false</tt> is returned and the
* fields may or may not have been modified.
*
* @newin{2,32}
*
* @param action_name The name of an action in the group.
* @param enabled If the action is presently enabled.
* @param parameter_type The parameter type, or <tt>0</tt> if none needed.
* @param state_type The state type, or <tt>0</tt> if stateless.
* @param state_hint The state hint, or <tt>0</tt> if none.
* @param state The current state, or <tt>0</tt> if stateless.
* @return <tt>true</tt> if the action exists, else <tt>false</tt>.
*/
bool query_action(const Glib::ustring& action_name, bool& enabled, Glib::VariantType& parameter_type, Glib::VariantBase& state_hint, Glib::VariantType& state_type, Glib::VariantBase& state);
/// A query_action() convenience overload.
bool query_action(const Glib::ustring& action_name, bool& enabled, Glib::VariantType& parameter_type, Glib::VariantBase& state_hint, Glib::VariantType& state_type);
/// A query_action() convenience overload.
bool query_action(const Glib::ustring& action_name, bool& enabled, Glib::VariantType& parameter_type, Glib::VariantBase& state_hint, Glib::VariantBase& state);
/// A query_action() convenience overload.
bool query_action(const Glib::ustring& action_name, bool& enabled, Glib::VariantType& parameter_type, Glib::VariantBase& state_hint);
/// A query_action() convenience overload.
bool query_action(const Glib::ustring& action_name, bool& enabled, Glib::VariantBase& state_hint, Glib::VariantType& state_type, Glib::VariantBase& state);
/// A query_action() convenience overload.
bool query_action(const Glib::ustring& action_name, bool& enabled, Glib::VariantBase& state_hint, Glib::VariantType& state_type);
/// A query_action() convenience overload.
bool query_action(const Glib::ustring& action_name, bool& enabled, Glib::VariantBase& state_hint, Glib::VariantBase& state);
/// A query_action() convenience overload.
bool query_action(const Glib::ustring& action_name, bool& enabled, Glib::VariantBase& state_hint);
/** Checks if the named action within @a action_group is currently enabled.
*
* An action must be enabled in order to be activated or in order to
* have its state changed from outside callers.
*
* @newin{2,28}
*
* @param action_name The name of the action to query.
* @return Whether or not the action is currently enabled.
*/
bool get_action_enabled(const Glib::ustring& action_name) const;
/** Queries the type of the parameter that must be given when activating
* the named action within @a action_group.
*
* When activating the action using g_action_group_activate_action(),
* the Variant given to that function must be of the type returned
* by this function.
*
* In the case that this function returns <tt>0</tt>, you must not give any
* Variant, but <tt>0</tt> instead.
*
* The parameter type of a particular action will never change but it is
* possible for an action to be removed and for a new action to be added
* with the same name but a different parameter type.
*
* @newin{2,28}
*
* @param action_name The name of the action to query.
* @return The parameter type.
*/
Glib::VariantType get_action_parameter_type(const Glib::ustring& action_name) const;
/** Queries the type of the state of the named action within
* @a action_group.
*
* If the action is stateful then this function returns the
* VariantType of the state. All calls to
* g_action_group_change_action_state() must give a Variant of this
* type and g_action_group_get_action_state() will return a Variant
* of the same type.
*
* If the action is not stateful then this function will return <tt>0</tt>.
* In that case, g_action_group_get_action_state() will return <tt>0</tt>
* and you must not call g_action_group_change_action_state().
*
* The state type of a particular action will never change but it is
* possible for an action to be removed and for a new action to be added
* with the same name but a different state type.
*
* @newin{2,28}
*
* @param action_name The name of the action to query.
* @return The state type, if the action
* is stateful.
*/
Glib::VariantType get_action_state_type(const Glib::ustring& action_name) const;
#ifndef GIOMM_DISABLE_DEPRECATED
/** Requests a hint about the valid range of values for the state of the
* named action within @a action_group.
*
* If <tt>0</tt> is returned it either means that the action is not stateful
* or that there is no hint about the valid range of values for the
* state of the action.
*
* If a Variant array is returned then each item in the array is a
* possible value for the state. If a Variant pair (ie: two-tuple) is
* returned then the tuple specifies the inclusive lower and upper bound
* of valid values for the state.
*
* In any case, the information is merely a hint. It may be possible to
* have a state value outside of the hinted range and setting a value
* within the range may fail.
*
* The return value (if non-<tt>0</tt>) should be freed with
* Glib::variant_unref() when it is no longer required.
*
* @newin{2,28}
*
* @deprecated Use the get_action_state() method that takes an output parameter instead.
*
* @param action_name The name of the action to query.
* @return The state range hint.
*/
Glib::VariantContainerBase get_action_state_hint(const Glib::ustring& action_name) const;
#endif // GIOMM_DISABLE_DEPRECATED
//TODO: How do we check for a NULL Variant?
/**
* Requests a hint about the valid range of values for the state of the
* named action within the action group
*
* If a null Variant is returned it either means that the action is not stateful
* or that there is no hint about the valid range of values for the
* state of the action.
*
* If a ariant array is returned then each item in the array is a
* possible value for the state. If Variant pair (ie: two-tuple) is
* returned then the tuple specifies the inclusive lower and upper bound
* of valid values for the state.
*
* In any case, the information is merely a hint. It may be possible to
* have a state value outside of the hinted range and setting a value
* within the range may fail.
*
* @param action_name The name of the action to query.
* @param value This will be set to the state range hint.
*/
template <typename T_Value>
void get_action_state_hint(const Glib::ustring& action_name, T_Value& value) const;
/** Requests a hint about the valid range of values for the state of the
* named action within @a action_group.
*
* If <tt>0</tt> is returned it either means that the action is not stateful
* or that there is no hint about the valid range of values for the
* state of the action.
*
* If a Variant array is returned then each item in the array is a
* possible value for the state. If a Variant pair (ie: two-tuple) is
* returned then the tuple specifies the inclusive lower and upper bound
* of valid values for the state.
*
* In any case, the information is merely a hint. It may be possible to
* have a state value outside of the hinted range and setting a value
* within the range may fail.
*
* The return value (if non-<tt>0</tt>) should be freed with
* Glib::variant_unref() when it is no longer required.
*
* @newin{2,28}
*
* @param action_name The name of the action to query.
* @return The state range hint.
*/
Glib::VariantContainerBase get_action_state_hint_variant(const Glib::ustring& action_name) const;
#ifndef GIOMM_DISABLE_DEPRECATED
/** Queries the current state of the named action within @a action_group.
*
* If the action is not stateful then <tt>0</tt> will be returned. If the
* action is stateful then the type of the return value is the type
* given by g_action_group_get_action_state_type().
*
* The return value (if non-<tt>0</tt>) should be freed with
* Glib::variant_unref() when it is no longer required.
*
* @newin{2,28}
*
* @deprecated Use the get_action_state() method that takes an output parameter instead.
*
* @param action_name The name of the action to query.
* @return The current state of the action.
*/
Glib::VariantBase get_action_state(const Glib::ustring& action_name) const;
#endif // GIOMM_DISABLE_DEPRECATED
//TODO: How do we check for a NULL Variant?
/** Queries the current state of the named action within the action group.
*
* If the action is not stateful then a null Variant will be returned. If the
* action is stateful then the type of the return value is the type
* given by get_action_state_type().
*
* @param action_name The name of the action to query.
* @param value This will be set to the current state of the action.
*/
template <typename T_Value>
void get_action_state(const Glib::ustring& action_name, T_Value& value) const;
/** Queries the current state of the named action within @a action_group.
*
* If the action is not stateful then <tt>0</tt> will be returned. If the
* action is stateful then the type of the return value is the type
* given by g_action_group_get_action_state_type().
*
* The return value (if non-<tt>0</tt>) should be freed with
* Glib::variant_unref() when it is no longer required.
*
* @newin{2,28}
*
* @param action_name The name of the action to query.
* @return The current state of the action.
*/
Glib::VariantBase get_action_state_variant(const Glib::ustring& action_name) const;
//TODO: Add templated method, renaming this to change_action_state_variant().
/** Request for the state of the named action within @a action_group to be
* changed to @a value.
*
* The action must be stateful and @a value must be of the correct type.
* See g_action_group_get_action_state_type().
*
* This call merely requests a change. The action may refuse to change
* its state or may change its state to something other than @a value.
* See g_action_group_get_action_state_hint().
*
* If the @a value GVariant is floating, it is consumed.
*
* @newin{2,28}
*
* @param action_name The name of the action to request the change on.
* @param value The new state.
*/
void change_action_state(const Glib::ustring& action_name, const Glib::VariantBase& value);
//TODO: Add templated method, renaming this to activate_action_variant().
/** Activate the named action within @a action_group.
*
* If the action is expecting a parameter, then the correct type of
* parameter must be given as @a parameter. If the action is expecting no
* parameters then @a parameter must be <tt>0</tt>. See
* g_action_group_get_action_parameter_type().
*
* @newin{2,28}
*
* @param action_name The name of the action to activate.
* @param parameter Parameters to the activation.
*/
void activate_action(const Glib::ustring& action_name, const Glib::VariantBase& parameter);
/// A activate_action() convenience overload.
void activate_action(const Glib::ustring& action_name);
/** Emits the ActionGroup::signal_action_added() signal on @a action_group.
*
* This function should only be called by ActionGroup implementations.
*
* @newin{2,28}
*
* @param action_name The name of an action in the group.
*/
void action_added(const Glib::ustring& action_name);
/** Emits the ActionGroup::signal_action_removed() signal on @a action_group.
*
* This function should only be called by ActionGroup implementations.
*
* @newin{2,28}
*
* @param action_name The name of an action in the group.
*/
void action_removed(const Glib::ustring& action_name);
/** Emits the ActionGroup::signal_action_enabled_changed() signal on @a action_group.
*
* This function should only be called by ActionGroup implementations.
*
* @newin{2,28}
*
* @param action_name The name of an action in the group.
* @param enabled Whether or not the action is now enabled.
*/
void action_enabled_changed(const Glib::ustring& action_name, bool enabled);
//TODO: Add templated method, renaming this to action_state_changed_variant).
/** Emits the ActionGroup::signal_action_state_changed() signal on @a action_group.
*
* This function should only be called by ActionGroup implementations.
*
* @newin{2,28}
*
* @param action_name The name of an action in the group.
* @param state The new state of the named action.
*/
void action_state_changed(const Glib::ustring& action_name, const Glib::VariantBase& state);
/**
* @par Slot Prototype:
* <tt>void on_my_%action_added(const Glib::ustring& action_name)</tt>
*
* Signals that a new action was just added to the group.
* This signal is emitted after the action has been added
* and is now visible.
*
* @newin{2,28}
*
* @param action_name The name of the action in @a action_group.
*/
Glib::SignalProxy1< void,const Glib::ustring& > signal_action_added();
/**
* @par Slot Prototype:
* <tt>void on_my_%action_enabled_changed(const Glib::ustring& action_name, bool enabled)</tt>
*
* Signals that the enabled status of the named action has changed.
*
* @newin{2,28}
*
* @param action_name The name of the action in @a action_group.
* @param enabled Whether the action is enabled or not.
*/
Glib::SignalProxy2< void,const Glib::ustring&,bool > signal_action_enabled_changed();
/**
* @par Slot Prototype:
* <tt>void on_my_%action_removed(const Glib::ustring& action_name)</tt>
*
* Signals that an action is just about to be removed from the group.
* This signal is emitted before the action is removed, so the action
* is still visible and can be queried from the signal handler.
*
* @newin{2,28}
*
* @param action_name The name of the action in @a action_group.
*/
Glib::SignalProxy1< void,const Glib::ustring& > signal_action_removed();
/**
* @par Slot Prototype:
* <tt>void on_my_%action_state_changed(const Glib::ustring& action_name, const Glib::VariantBase& value)</tt>
*
* Signals that the state of the named action has changed.
*
* @newin{2,28}
*
* @param action_name The name of the action in @a action_group.
* @param value The new value of the state.
*/
Glib::SignalProxy2< void,const Glib::ustring&,const Glib::VariantBase& > signal_action_state_changed();
virtual bool has_action_vfunc(const Glib::ustring& name) const;
virtual std::vector<Glib::ustring> list_actions_vfunc() const;
virtual bool get_action_enabled_vfunc(const Glib::ustring& name) const;
virtual Glib::VariantType get_action_parameter_type_vfunc(const Glib::ustring& name) const;
virtual Glib::VariantType get_action_state_type_vfunc(const Glib::ustring& name) const;
virtual Glib::VariantBase get_action_state_hint_vfunc(const Glib::ustring& name) const;
virtual Glib::VariantBase get_action_state_vfunc(const Glib::ustring& name) const;
virtual void change_action_state_vfunc(const Glib::ustring& name, const Glib::VariantBase& value);
virtual void activate_action_vfunc(const Glib::ustring& name, const Glib::VariantBase& parameter);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_action_added().
virtual void on_action_added(const Glib::ustring& action_name);
/// This is a default handler for the signal signal_action_enabled_changed().
virtual void on_action_enabled_changed(const Glib::ustring& action_name, bool enabled);
/// This is a default handler for the signal signal_action_removed().
virtual void on_action_removed(const Glib::ustring& action_name);
/// This is a default handler for the signal signal_action_state_changed().
virtual void on_action_state_changed(const Glib::ustring& action_name, const Glib::VariantBase& value);
};
template <typename T_Value>
void ActionGroup::get_action_state(const Glib::ustring& action_name, T_Value& value) const
{
value = T_Value(); //Make sure that it is initialized.
typedef Glib::Variant<T_Value> type_glib_variant;
g_return_if_fail(
g_variant_type_equal(g_action_group_get_action_state_type(const_cast<GActionGroup*>(gobj()), action_name.c_str()), type_glib_variant::variant_type().gobj()));
const Glib::VariantBase variantBase = get_action_state_variant(action_name);
//TODO: Add a bool return instead of letting a std::bad_cast from the cast_dynamic() be thrown up to the caller?
const type_glib_variant variantDerived = variantBase.cast_dynamic<type_glib_variant>(variantBase);
value = variantDerived.get();
}
template <typename T_Value>
void ActionGroup::get_action_state_hint(const Glib::ustring& action_name, T_Value& value) const
{
value = T_Value(); //Make sure that it is initialized.
typedef Glib::Variant<T_Value> type_glib_variant;
const Glib::VariantBase variantBase = get_action_state_hint_variant(action_name);
// We can't check the type (a range) that will be returned before getting the range hint.
g_return_if_fail(
variantBase.is_of_type(type_glib_variant::variant_type()) );
const type_glib_variant variantDerived = variantBase.cast_dynamic<type_glib_variant>(variantBase);
value = variantDerived.get();
}
} // 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::ActionGroup
*/
Glib::RefPtr<Gio::ActionGroup> wrap(GActionGroup* object, bool take_copy = false);
} // namespace Glib
#endif /* _GIOMM_ACTIONGROUP_H */
|