/usr/include/gtkmm-3.0/gtkmm/application.h is in libgtkmm-3.0-dev 3.10.1-0ubuntu2.
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 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 | // -*- c++ -*-
// Generated by gmmproc 2.38.0 -- DO NOT MODIFY!
#ifndef _GTKMM_APPLICATION_H
#define _GTKMM_APPLICATION_H
#include <gtkmmconfig.h>
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2003 The gtkmm 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 <vector>
#include <gtkmm/actiongroup.h>
#include <giomm/application.h>
#include <giomm/menumodel.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkApplication GtkApplication;
typedef struct _GtkApplicationClass GtkApplicationClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class Application_Class; } // namespace Gtk
namespace Gtk
{
/** @addtogroup gtkmmEnums gtkmm Enums and Flags */
/**
* @var ApplicationInhibitFlags APPLICATION_INHIBIT_LOGOUT
* Inhibit ending the user sessionby logging out or by shutting down the computer.
*
* @var ApplicationInhibitFlags APPLICATION_INHIBIT_SWITCH
* Inhibit user switching.
*
* @var ApplicationInhibitFlags APPLICATION_INHIBIT_SUSPEND
* Inhibit suspending thesession or computer.
*
* @var ApplicationInhibitFlags APPLICATION_INHIBIT_IDLE
* Inhibit the session beingmarked as idle (and possibly locked).
*
* @enum ApplicationInhibitFlags
*
* Types of user actions that may be blocked by Gtk::Application::inhibit().
*
* @newin{3,4}
* @ingroup gtkmmEnums
* @par Bitwise operators:
* <tt>%ApplicationInhibitFlags operator|(ApplicationInhibitFlags, ApplicationInhibitFlags)</tt><br>
* <tt>%ApplicationInhibitFlags operator&(ApplicationInhibitFlags, ApplicationInhibitFlags)</tt><br>
* <tt>%ApplicationInhibitFlags operator^(ApplicationInhibitFlags, ApplicationInhibitFlags)</tt><br>
* <tt>%ApplicationInhibitFlags operator~(ApplicationInhibitFlags)</tt><br>
* <tt>%ApplicationInhibitFlags& operator|=(ApplicationInhibitFlags&, ApplicationInhibitFlags)</tt><br>
* <tt>%ApplicationInhibitFlags& operator&=(ApplicationInhibitFlags&, ApplicationInhibitFlags)</tt><br>
* <tt>%ApplicationInhibitFlags& operator^=(ApplicationInhibitFlags&, ApplicationInhibitFlags)</tt><br>
*/
enum ApplicationInhibitFlags
{
APPLICATION_INHIBIT_LOGOUT = (1 << 0),
APPLICATION_INHIBIT_SWITCH = (1 << 1),
APPLICATION_INHIBIT_SUSPEND = (1 << 2),
APPLICATION_INHIBIT_IDLE = (1 << 3)
};
/** @ingroup gtkmmEnums */
inline ApplicationInhibitFlags operator|(ApplicationInhibitFlags lhs, ApplicationInhibitFlags rhs)
{ return static_cast<ApplicationInhibitFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline ApplicationInhibitFlags operator&(ApplicationInhibitFlags lhs, ApplicationInhibitFlags rhs)
{ return static_cast<ApplicationInhibitFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline ApplicationInhibitFlags operator^(ApplicationInhibitFlags lhs, ApplicationInhibitFlags rhs)
{ return static_cast<ApplicationInhibitFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline ApplicationInhibitFlags operator~(ApplicationInhibitFlags flags)
{ return static_cast<ApplicationInhibitFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup gtkmmEnums */
inline ApplicationInhibitFlags& operator|=(ApplicationInhibitFlags& lhs, ApplicationInhibitFlags rhs)
{ return (lhs = static_cast<ApplicationInhibitFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup gtkmmEnums */
inline ApplicationInhibitFlags& operator&=(ApplicationInhibitFlags& lhs, ApplicationInhibitFlags rhs)
{ return (lhs = static_cast<ApplicationInhibitFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup gtkmmEnums */
inline ApplicationInhibitFlags& operator^=(ApplicationInhibitFlags& lhs, ApplicationInhibitFlags rhs)
{ return (lhs = static_cast<ApplicationInhibitFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::ApplicationInhibitFlags> : public Glib::Value_Flags<Gtk::ApplicationInhibitFlags>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
class Window;
//TODO: Add overview documentation discussing the techniques show in the examples in gtkmm-docmentation.
//TODO: Add the screenshots from the C API?
/** The Gtk::Application class handles many important aspects
* of a GTK+ application in a convenient fashion, without enforcing
* a one-size-fits-all application model.
*
* Currently, Gtk::Application handles GTK+ and gtkmm initialization, application
* uniqueness, session management, provides some basic scriptability and
* desktop shell integration by exporting actions and menus, and manages a
* list of toplevel windows whose life-cycle is automatically tied to the
* life-cycle of your application.
*
* While Gtk::Application works fine with plain Gtk::Window%s, it is recommended
* to use it together with Gtk::ApplicationWindow.
*
* When GDK threads are enabled, Gtk::Application will acquire the GDK
* lock when invoking actions that arrive from other processes. The GDK
* lock is not touched for local action invocations. In order to have
* actions invoked in a predictable context it is therefore recommended
* that the GDK lock be held while invoking actions locally with
* Gio::ActionGroup::activate_action(). The same applies to actions
* associated with Gtk::ApplicationWindow and to the Gio::Application::activate() and
* Gio::Application::open() methods.
*
* To set an application menu for a Gtk::Application, use
* set_app_menu(). The Gio::MenuModel that this method
* expects is usually constructed using Gtk::Builder.
* To specify a menubar that will be shown by
* Gtk::ApplicationWindow%s, use set_menubar(). Use the base
* Gio::ActionMap interface to add actions, to respond to the user
* selecting these menu items.
*
* GTK+ displays these menus as expected, depending on the platform
* the application is running on.
*
* Gtk::Application optionally registers with a session manager
* of the users session (if you set the register-session
* property) and offers various functionality related to the session
* life-cycle.
*
* An application can block various ways to end the session with
* the inhibit() method. Typical use cases for
* this kind of inhibiting are long-running, uninterruptible operations,
* such as burning a CD or performing a disk backup. The session
* manager may not honor the inhibitor, but it can be expected to
* inform the user about the negative consequences of ending the
* session while inhibitors are present.
*
* @newin{3,4}
*/
class Application
: public Gio::Application
{
protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Application CppObjectType;
typedef Application_Class CppClassType;
typedef GtkApplication BaseObjectType;
typedef GtkApplicationClass BaseClassType;
private: friend class Application_Class;
static CppClassType application_class_;
private:
// noncopyable
Application(const Application&);
Application& operator=(const Application&);
protected:
explicit Application(const Glib::ConstructParams& construct_params);
explicit Application(GtkApplication* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Application();
/** 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.
GtkApplication* gobj() { return reinterpret_cast<GtkApplication*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkApplication* gobj() const { return reinterpret_cast<GtkApplication*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GtkApplication* gobj_copy();
private:
protected:
/** Creates a new Application instance.
*
* This initializes gtkmm (and the GObject type system) for you.
*
* If non-empty, the application ID must be valid. See
* g_application_id_is_valid().
*
* If no application ID is given then some features (most notably application
* uniqueness) will be disabled. A null application ID is only allowed with
* gtkmm 3.6 or later.
*
* @param application_id A valid application ID.
* @param flags The application flags.
*
* @newin{3,4}
*/
explicit Application(const Glib::ustring& application_id = Glib::ustring(), Gio::ApplicationFlags flags = Gio::APPLICATION_FLAGS_NONE);
//This constructor does not correspond to anything in the C API.
//We added it so we can choose to always initialize gtkmm as early as possible.
//See https://bugzilla.gnome.org/show_bug.cgi?id=639925
/** Creates a new Application instance.
*
* This initializes gtkmm (and the GObject type system) for you, parsing the
* standard GTK+ command line arguments.
*
* You could instead use the constuctor that takes no command line arguements
* and later supply the command line arguments to run().
*
* Note that all GTK+ functionality that is available via command line arguments
* can instead be achieved by setting suitable environment variables
* such as G_DEBUG.
*
* If non-empty, the application ID must be valid. See
* g_application_id_is_valid().
*
* If no application ID is given then some features (most notably application
* uniqueness) will be disabled. A null application ID is only allowed with
* gtkmm 3.6 or later.
*
* @param argc The parameter received by your main() function.
* @param argv The parameter received by your main() function.
* @param application_id A valid application ID.
* @param flags The application flags.
*
* @newin{3,4}
*/
explicit Application(int& argc, char**& argv, const Glib::ustring& application_id = Glib::ustring(), Gio::ApplicationFlags flags = Gio::APPLICATION_FLAGS_NONE);
public:
/** Creates a new Application instance.
*
* This initializes gtkmm (and the GObject type system) for you.
*
* If non-empty, the application ID must be valid. See
* g_application_id_is_valid().
*
* If no application ID is given then some features (most notably application
* uniqueness) will be disabled. A null application ID is only allowed with
* gtkmm 3.6 or later.
*
* @param application_id A valid application ID.
* @param flags The application flags.
*
* @newin{3,4}
*/
static Glib::RefPtr<Application> create(const Glib::ustring& application_id = Glib::ustring(), Gio::ApplicationFlags flags = Gio::APPLICATION_FLAGS_NONE);
/** Creates a new Application instance.
*
* This initializes gtkmm (and the GObject type system) for you, parsing the
* standard GTK+ command line arguments.
*
* You could instead use the constuctor that takes no command line arguements
* and later supply the command line arguments to run().
*
* Note that all GTK+ functionality that is available via command line arguments
* can instead be achieved by setting suitable environment variables
* such as G_DEBUG.
*
* If non-empty, the application ID must be valid. See
* g_application_id_is_valid().
*
* If no application ID is given then some features (most notably application
* uniqueness) will be disabled. A null application ID is only allowed with
* gtkmm 3.6 or later.
*
* @param argc The parameter received by your main() function.
* @param argv The parameter received by your main() function.
* @param application_id A valid application ID.
*
* @param flags The application flags.
* @newin{3,4}
*/
static Glib::RefPtr<Application> create(int& argc, char**& argv, const Glib::ustring& application_id = Glib::ustring(), Gio::ApplicationFlags flags = Gio::APPLICATION_FLAGS_NONE);
/** Gets a list of the Gtk::Windows associated with @a application.
*
* The list is sorted by most recently focused window, such that the first
* element is the currently focused window. (Useful for choosing a parent
* for a transient window.)
*
* The list that is returned should not be modified in any way. It will
* only remain valid until the next focus change or window creation or
* deletion.
*
* @newin{3,0}
* @return A List of Gtk::Window.
*/
std::vector<Window*> get_windows();
/** Gets a list of the Gtk::Windows associated with @a application.
*
* The list is sorted by most recently focused window, such that the first
* element is the currently focused window. (Useful for choosing a parent
* for a transient window.)
*
* The list that is returned should not be modified in any way. It will
* only remain valid until the next focus change or window creation or
* deletion.
*
* @newin{3,0}
* @return A List of Gtk::Window.
*/
std::vector<const Window*> get_windows() const;
/** Adds a window to the Gtk::Application.
*
* If all the windows managed by Gtk::Application are closed or removed from
* the application then the Gtk::Application will call quit(), and quit
* the application.
*
* This call is equivalent to calling Gtk::Window::set_application().
*
* Normally, the connection between the application and the window
* will remain until the window is closed or destroyed, but you can explicitly
* remove it with remove_window().
*
* @newin{3,4}
* @param window A toplevel window to add to the application.
*/
void add_window(Window& window);
/** Remove a window from @a application.
*
* If @a window belongs to @a application then this call is equivalent to
* setting the Gtk::Window::property_application() property of @a window to
* <tt>0</tt>.
*
* The application may stop running as a result of a call to this
* function.
*
* @newin{3,0}
* @param window A Gtk::Window.
*/
void remove_window(Window& window);
/** Starts the application.
*
* The default implementation of this virtual function will simply run
* a main loop.
*
* It is an error to call this function if @a application is a proxy for
* a remote application.
*
* @param argc The argc from main() (or 0 if @a argv is <tt>0</tt>).
* @param argv The argv from main(), or <tt>0</tt>.
* @return The exit status.
*
* @newin{3,4}
*/
int run(int argc, char** argv);
/** Starts the application.
*
* The default implementation of this virtual function will simply run
* a main loop.
*
* It is an error to call this function if @a application is a proxy for
* a remote application.
*
* @param window The window to show. This method will return when the window is hidden.
* @param argc The argc from main() (or 0 if @a argv is <tt>0</tt>).
* @param argv The argv from main(), or <tt>0</tt>.
* @return The exit status.
*
* @newin{3,4}
*/
int run(Window& window, int argc, char** argv);
//TODO: If argc and argv are necessary at all, document the need to call that constructor first.
//See https://bugzilla.gnome.org/show_bug.cgi?id=639925#c4
/** Starts the application.
*
* The default implementation of this virtual function will simply run
* a main loop.
*
* It is an error to call this function if @a application is a proxy for
* a remote application.
*
* @param window The window to show. This method will return when the window is hidden.
* @return The exit status.
*
* @newin{3,4}
*/
int run(Window& window);
//TODO: If argc and argv are necessary at all, document the need to call that constructor first.
//See https://bugzilla.gnome.org/show_bug.cgi?id=639925#c4
/** Starts the application.
*
* The default implementation of this virtual function will simply run
* a main loop.
*
* It is an error to call this function if @a application is a proxy for
* a remote application.
*
* @return The exit status.
*
* @newin{3,4}
*/
int run();
/** Returns the menu model that has been set with
* set_app_menu().
*
* @newin{3,4}
* @return The application menu of @a application.
*/
Glib::RefPtr<Gio::MenuModel> get_app_menu();
/** Returns the menu model that has been set with
* set_app_menu().
*
* @newin{3,4}
* @return The application menu of @a application.
*/
Glib::RefPtr<const Gio::MenuModel> get_app_menu() const;
/** Sets or unsets the application menu for @a application.
*
* This can only be done in the primary instance of the application,
* after it has been registered. Application::property_startup() is a good place
* to call this.
*
* The application menu is a single menu containing items that typically
* impact the application as a whole, rather than acting on a specific
* window or document. For example, you would expect to see
* "Preferences" or "Quit" in an application menu, but not "Save" or
* "Print".
*
* If supported, the application menu will be rendered by the desktop
* environment.
*
* Use the base ActionMap interface to add actions, to respond to the user
* selecting these menu items.
*
* @newin{3,4}
* @param app_menu A MenuModel, or <tt>0</tt>.
*/
void set_app_menu(const Glib::RefPtr<Gio::MenuModel>& app_menu);
/** Returns the menu model that has been set with
* set_menubar().
*
* @newin{3,4}
* @return The menubar for windows of @a application.
*/
Glib::RefPtr<Gio::MenuModel> get_menubar();
/** Returns the menu model that has been set with
* set_menubar().
*
* @newin{3,4}
* @return The menubar for windows of @a application.
*/
Glib::RefPtr<const Gio::MenuModel> get_menubar() const;
/** Sets or unsets the menubar for windows of @a application.
*
* This is a menubar in the traditional sense.
*
* This can only be done in the primary instance of the application,
* after it has been registered. Application::property_startup() is a good place
* to call this.
*
* Depending on the desktop environment, this may appear at the top of
* each window, or at the top of the screen. In some environments, if
* both the application menu and the menubar are set, the application
* menu will be presented as if it were the first item of the menubar.
* Other environments treat the two as completely separate -- for
* example, the application menu may be rendered by the desktop shell
* while the menubar (if set) remains in each individual window.
*
* Use the base ActionMap interface to add actions, to respond to the user
* selecting these menu items.
*
* @newin{3,4}
* @param menubar A MenuModel, or <tt>0</tt>.
*/
void set_menubar(const Glib::RefPtr<Gio::MenuModel>& menubar);
//TODO: Add a *_variant() version that takes a VariantBase, add a templated method, and remove this method when we can break ABI:
/** Installs an accelerator that will cause the named action
* to be activated when the key combination specificed by @a accelerator
* is pressed.
*
* @a accelerator must be a string that can be parsed by
* gtk_accelerator_parse(), e.g. "<Primary>q" or
* "<Control><Alt>p".
*
* @a action_name must be the name of an action as it would be used
* in the app menu, i.e. actions that have been added to the application
* are referred to with an "app." prefix, and window-specific actions
* with a "win." prefix.
*
* GtkApplication also extracts accelerators out of 'accel' attributes
* in the MenuModels passed to set_app_menu() and
* set_menubar(), which is usually more convenient
* than calling this function for each accelerator.
*
* @newin{3,4}
* @param accelerator Accelerator string.
* @param action_name The name of the action to activate.
* @param parameter Parameter to pass when activating the action,
* or <tt>0</tt> if the action does not accept an activation parameter.
*/
void add_accelerator(const Glib::ustring& accelerator, const Glib::ustring& action_name, GVariant* parameter);
/// A add_accelerator() convenience overload.
void add_accelerator(const Glib::ustring& accelerator, const Glib::ustring& action_name);
//TODO: Add a *_variant() version that takes a VariantBase, add a templated method, and remove this method when we can break ABI:
/** Removes an accelerator that has been previously added
* with add_accelerator().
*
* @newin{3,4}
* @param action_name The name of the action to activate.
* @param parameter Parameter to pass when activating the action,
* or <tt>0</tt> if the action does not accept an activation parameter.
*/
void remove_accelerator(const Glib::ustring& action_name, GVariant* parameter);
/// A remove_accelerator() convenience overload.
void remove_accelerator(const Glib::ustring& action_name);
/** Inform the session manager that certain types of actions should be
* inhibited. This is not guaranteed to work on all platforms and for
* all types of actions.
*
* Applications should invoke this method when they begin an operation
* that should not be interrupted, such as creating a CD or DVD. The
* types of actions that may be blocked are specified by the @a flags
* parameter. When the application completes the operation it should
* call uninhibit() to remove the inhibitor. Note that
* an application can have multiple inhibitors, and all of the must
* be individually removed. Inhibitors are also cleared when the
* application exits.
*
* Applications should not expect that they will always be able to block
* the action. In most cases, users will be given the option to force
* the action to take place.
*
* Reasons should be short and to the point.
*
* If @a window is given, the session manager may point the user to
* this window to find out more about why the action is inhibited.
*
* @newin{3,4}
* @param window A Gtk::Window, or <tt>0</tt>.
* @param flags What types of actions should be inhibited.
* @param reason A short, human-readable string that explains
* why these operations are inhibited.
* @return A non-zero cookie that is used to uniquely identify this
* request. It should be used as an argument to uninhibit()
* in order to remove the request. If the platform does not support
* inhibiting or the request failed for some reason, 0 is returned.
*/
guint inhibit(Window& window, ApplicationInhibitFlags flags, const Glib::ustring& reason);
/** Removes an inhibitor that has been established with inhibit().
* Inhibitors are also cleared when the application exits.
*
* @newin{3,4}
* @param cookie A cookie that was returned by inhibit().
*/
void uninhibit(guint cookie);
/** Determines if any of the actions specified in @a flags are
* currently inhibited (possibly by another application).
*
* @newin{3,4}
* @param flags What types of actions should be queried.
* @return <tt>true</tt> if any of the actions specified in @a flags are inhibited.
*/
bool is_inhibited(ApplicationInhibitFlags flags) const;
/** Returns the Gtk::ApplicationWindow with the given ID.
*
* @newin{3,6}
* @param id An identifier number.
* @return The window with ID @a id, or
* <tt>0</tt> if there is no window with this ID.
*/
Window* get_window_by_id(guint id);
/** Returns the Gtk::ApplicationWindow with the given ID.
*
* @newin{3,6}
* @param id An identifier number.
* @return The window with ID @a id, or
* <tt>0</tt> if there is no window with this ID.
*/
const Window* get_window_by_id(guint id) const;
/** Gets the "active" window for the application.
*
* The active window is the one that was most recently focused (within
* the application). This window may not have the focus at the moment
* if another application has it -- this is just the most
* recently-focused window within this application.
*
* @newin{3,6}
* @return The active window.
*/
Window* get_active_window();
/** Gets the "active" window for the application.
*
* The active window is the one that was most recently focused (within
* the application). This window may not have the focus at the moment
* if another application has it -- this is just the most
* recently-focused window within this application.
*
* @newin{3,6}
* @return The active window.
*/
const Window* get_active_window() const;
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The GMenuModel for the application menu.
*
* 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::RefPtr<Gio::MenuModel> > property_app_menu() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The GMenuModel for the application menu.
*
* 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::RefPtr<Gio::MenuModel> > property_app_menu() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The GMenuModel for the menubar.
*
* 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::RefPtr<Gio::MenuModel> > property_menubar() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The GMenuModel for the menubar.
*
* 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::RefPtr<Gio::MenuModel> > property_menubar() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Register with the session manager.
*
* 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_register_session() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Register with the session manager.
*
* 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_register_session() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The window which most recently had focus.
*
* 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< Window* > property_active_window() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
/**
* @par Slot Prototype:
* <tt>void on_my_%window_added(Window* window)</tt>
*
* Emitted when a Gtk::Window is added to @a application through
* Gtk::Application::add_window().
*
* @newin{3,2}
* @param window The newly-added Gtk::Window.
*/
Glib::SignalProxy1< void,Window* > signal_window_added();
/**
* @par Slot Prototype:
* <tt>void on_my_%window_removed(Window* window)</tt>
*
* Emitted when a Gtk::Window is removed from @a application,
* either as a side-effect of being destroyed or explicitly
* through Gtk::Application::remove_window().
*
* @newin{3,2}
* @param window The Gtk::Window that is being removed.
*/
Glib::SignalProxy1< void,Window* > signal_window_removed();
private:
/** This is just a way to call Glib::init() (which calls g_type_init()) before
* calling application_class_.init(), so that
* gtk_application_get_type() will always succeed.
* See https://bugzilla.gnome.org/show_bug.cgi?id=639925
*/
const Glib::Class& custom_class_init();
void on_activate_add_and_show_main_window(Window* window);
void on_window_hide(Window* window);
//We need these to call g_application_run(),
//even if we have already called gtk_init().
int m_argc;
char** m_argv;
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_window_added().
virtual void on_window_added(Window* window);
/// This is a default handler for the signal signal_window_removed().
virtual void on_window_removed(Window* window);
};
} // namespace Gtk
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 Gtk::Application
*/
Glib::RefPtr<Gtk::Application> wrap(GtkApplication* object, bool take_copy = false);
}
#endif /* _GTKMM_APPLICATION_H */
|