1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gio.Application; 26 27 private import gio.ActionGroupIF; 28 private import gio.ActionGroupT; 29 private import gio.ActionMapIF; 30 private import gio.ActionMapT; 31 private import gio.ApplicationCommandLine; 32 private import gio.Cancellable; 33 private import gio.DBusConnection; 34 private import gio.File; 35 private import gio.FileIF; 36 private import gio.Notification; 37 private import glib.ConstructionException; 38 private import glib.ErrorG; 39 private import glib.GException; 40 private import glib.OptionGroup; 41 private import glib.Str; 42 private import glib.VariantDict; 43 private import gobject.ObjectG; 44 private import gobject.Signals; 45 public import gtkc.gdktypes; 46 private import gtkc.gio; 47 public import gtkc.giotypes; 48 49 50 /** 51 * A #GApplication is the foundation of an application. It wraps some 52 * low-level platform-specific services and is intended to act as the 53 * foundation for higher-level application classes such as 54 * #GtkApplication or #MxApplication. In general, you should not use 55 * this class outside of a higher level framework. 56 * 57 * GApplication provides convenient life cycle management by maintaining 58 * a "use count" for the primary application instance. The use count can 59 * be changed using g_application_hold() and g_application_release(). If 60 * it drops to zero, the application exits. Higher-level classes such as 61 * #GtkApplication employ the use count to ensure that the application 62 * stays alive as long as it has any opened windows. 63 * 64 * Another feature that GApplication (optionally) provides is process 65 * uniqueness. Applications can make use of this functionality by 66 * providing a unique application ID. If given, only one application 67 * with this ID can be running at a time per session. The session 68 * concept is platform-dependent, but corresponds roughly to a graphical 69 * desktop login. When your application is launched again, its 70 * arguments are passed through platform communication to the already 71 * running program. The already running instance of the program is 72 * called the "primary instance"; for non-unique applications this is 73 * the always the current instance. On Linux, the D-Bus session bus 74 * is used for communication. 75 * 76 * The use of #GApplication differs from some other commonly-used 77 * uniqueness libraries (such as libunique) in important ways. The 78 * application is not expected to manually register itself and check 79 * if it is the primary instance. Instead, the main() function of a 80 * #GApplication should do very little more than instantiating the 81 * application instance, possibly connecting signal handlers, then 82 * calling g_application_run(). All checks for uniqueness are done 83 * internally. If the application is the primary instance then the 84 * startup signal is emitted and the mainloop runs. If the application 85 * is not the primary instance then a signal is sent to the primary 86 * instance and g_application_run() promptly returns. See the code 87 * examples below. 88 * 89 * If used, the expected form of an application identifier is very close 90 * to that of of a 91 * [DBus bus name](http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface). 92 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator". 93 * For details on valid application identifiers, see g_application_id_is_valid(). 94 * 95 * On Linux, the application identifier is claimed as a well-known bus name 96 * on the user's session bus. This means that the uniqueness of your 97 * application is scoped to the current session. It also means that your 98 * application may provide additional services (through registration of other 99 * object paths) at that bus name. The registration of these object paths 100 * should be done with the shared GDBus session bus. Note that due to the 101 * internal architecture of GDBus, method calls can be dispatched at any time 102 * (even if a main loop is not running). For this reason, you must ensure that 103 * any object paths that you wish to register are registered before #GApplication 104 * attempts to acquire the bus name of your application (which happens in 105 * g_application_register()). Unfortunately, this means that you cannot use 106 * g_application_get_is_remote() to decide if you want to register object paths. 107 * 108 * GApplication also implements the #GActionGroup and #GActionMap 109 * interfaces and lets you easily export actions by adding them with 110 * g_action_map_add_action(). When invoking an action by calling 111 * g_action_group_activate_action() on the application, it is always 112 * invoked in the primary instance. The actions are also exported on 113 * the session bus, and GIO provides the #GDBusActionGroup wrapper to 114 * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper 115 * for remote access to exported #GMenuModels. 116 * 117 * There is a number of different entry points into a GApplication: 118 * 119 * - via 'Activate' (i.e. just starting the application) 120 * 121 * - via 'Open' (i.e. opening some files) 122 * 123 * - by handling a command-line 124 * 125 * - via activating an action 126 * 127 * The #GApplication::startup signal lets you handle the application 128 * initialization for all of these in a single place. 129 * 130 * Regardless of which of these entry points is used to start the 131 * application, GApplication passes some "platform data from the 132 * launching instance to the primary instance, in the form of a 133 * #GVariant dictionary mapping strings to variants. To use platform 134 * data, override the @before_emit or @after_emit virtual functions 135 * in your #GApplication subclass. When dealing with 136 * #GApplicationCommandLine objects, the platform data is 137 * directly available via g_application_command_line_get_cwd(), 138 * g_application_command_line_get_environ() and 139 * g_application_command_line_get_platform_data(). 140 * 141 * As the name indicates, the platform data may vary depending on the 142 * operating system, but it always includes the current directory (key 143 * "cwd"), and optionally the environment (ie the set of environment 144 * variables and their values) of the calling process (key "environ"). 145 * The environment is only added to the platform data if the 146 * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses 147 * can add their own platform data by overriding the @add_platform_data 148 * virtual function. For instance, #GtkApplication adds startup notification 149 * data in this way. 150 * 151 * To parse commandline arguments you may handle the 152 * #GApplication::command-line signal or override the local_command_line() 153 * vfunc, to parse them in either the primary instance or the local instance, 154 * respectively. 155 * 156 * For an example of opening files with a GApplication, see 157 * [gapplication-example-open.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-open.c). 158 * 159 * For an example of using actions with GApplication, see 160 * [gapplication-example-actions.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-actions.c). 161 * 162 * For an example of using extra D-Bus hooks with GApplication, see 163 * [gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c). 164 * 165 * Since: 2.28 166 */ 167 public class Application : ObjectG, ActionGroupIF, ActionMapIF 168 { 169 /** the main Gtk struct */ 170 protected GApplication* gApplication; 171 172 /** Get the main Gtk struct */ 173 public GApplication* getApplicationStruct() 174 { 175 return gApplication; 176 } 177 178 /** the main Gtk struct as a void* */ 179 protected override void* getStruct() 180 { 181 return cast(void*)gApplication; 182 } 183 184 protected override void setStruct(GObject* obj) 185 { 186 gApplication = cast(GApplication*)obj; 187 super.setStruct(obj); 188 } 189 190 /** 191 * Sets our main struct and passes it to the parent class. 192 */ 193 public this (GApplication* gApplication, bool ownedRef = false) 194 { 195 this.gApplication = gApplication; 196 super(cast(GObject*)gApplication, ownedRef); 197 } 198 199 // add the ActionGroup capabilities 200 mixin ActionGroupT!(GApplication); 201 202 // add the ActionMap capabilities 203 mixin ActionMapT!(GApplication); 204 205 206 /** */ 207 public static GType getType() 208 { 209 return g_application_get_type(); 210 } 211 212 /** 213 * Creates a new #GApplication instance. 214 * 215 * If non-%NULL, the application id must be valid. See 216 * g_application_id_is_valid(). 217 * 218 * If no application ID is given then some features of #GApplication 219 * (most notably application uniqueness) will be disabled. 220 * 221 * Params: 222 * applicationId = the application id 223 * flags = the application flags 224 * 225 * Return: a new #GApplication instance 226 * 227 * Throws: ConstructionException GTK+ fails to create the object. 228 */ 229 public this(string applicationId, GApplicationFlags flags) 230 { 231 auto p = g_application_new(Str.toStringz(applicationId), flags); 232 233 if(p is null) 234 { 235 throw new ConstructionException("null returned by new"); 236 } 237 238 this(cast(GApplication*) p, true); 239 } 240 241 /** 242 * Returns the default #GApplication instance for this process. 243 * 244 * Normally there is only one #GApplication per process and it becomes 245 * the default when it is created. You can exercise more control over 246 * this by using g_application_set_default(). 247 * 248 * If there is no default application then %NULL is returned. 249 * 250 * Return: the default application for this process, or %NULL 251 * 252 * Since: 2.32 253 */ 254 public static Application getDefault() 255 { 256 auto p = g_application_get_default(); 257 258 if(p is null) 259 { 260 return null; 261 } 262 263 return ObjectG.getDObject!(Application)(cast(GApplication*) p); 264 } 265 266 /** 267 * Checks if @application_id is a valid application identifier. 268 * 269 * A valid ID is required for calls to g_application_new() and 270 * g_application_set_application_id(). 271 * 272 * For convenience, the restrictions on application identifiers are 273 * reproduced here: 274 * 275 * - Application identifiers must contain only the ASCII characters 276 * "[A-Z][a-z][0-9]_-." and must not begin with a digit. 277 * 278 * - Application identifiers must contain at least one '.' (period) 279 * character (and thus at least three elements). 280 * 281 * - Application identifiers must not begin or end with a '.' (period) 282 * character. 283 * 284 * - Application identifiers must not contain consecutive '.' (period) 285 * characters. 286 * 287 * - Application identifiers must not exceed 255 characters. 288 * 289 * Params: 290 * applicationId = a potential application identifier 291 * 292 * Return: %TRUE if @application_id is valid 293 */ 294 public static bool idIsValid(string applicationId) 295 { 296 return g_application_id_is_valid(Str.toStringz(applicationId)) != 0; 297 } 298 299 /** 300 * Activates the application. 301 * 302 * In essence, this results in the #GApplication::activate signal being 303 * emitted in the primary instance. 304 * 305 * The application must be registered before calling this function. 306 * 307 * Since: 2.28 308 */ 309 public void activate() 310 { 311 g_application_activate(gApplication); 312 } 313 314 /** 315 * Add an option to be handled by @application. 316 * 317 * Calling this function is the equivalent of calling 318 * g_application_add_main_option_entries() with a single #GOptionEntry 319 * that has its arg_data member set to %NULL. 320 * 321 * The parsed arguments will be packed into a #GVariantDict which 322 * is passed to #GApplication::handle-local-options. If 323 * %G_APPLICATION_HANDLES_COMMAND_LINE is set, then it will also 324 * be sent to the primary instance. See 325 * g_application_add_main_option_entries() for more details. 326 * 327 * See #GOptionEntry for more documentation of the arguments. 328 * 329 * Params: 330 * longName = the long name of an option used to specify it in a commandline 331 * shortName = the short name of an option 332 * flags = flags from #GOptionFlags 333 * arg = the type of the option, as a #GOptionArg 334 * description = the description for the option in `--help` output 335 * argDescription = the placeholder to use for the extra argument 336 * parsed by the option in `--help` output 337 * 338 * Since: 2.42 339 */ 340 public void addMainOption(string longName, char shortName, GOptionFlags flags, GOptionArg arg, string description, string argDescription) 341 { 342 g_application_add_main_option(gApplication, Str.toStringz(longName), shortName, flags, arg, Str.toStringz(description), Str.toStringz(argDescription)); 343 } 344 345 /** 346 * Adds main option entries to be handled by @application. 347 * 348 * This function is comparable to g_option_context_add_main_entries(). 349 * 350 * After the commandline arguments are parsed, the 351 * #GApplication::handle-local-options signal will be emitted. At this 352 * point, the application can inspect the values pointed to by @arg_data 353 * in the given #GOptionEntrys. 354 * 355 * Unlike #GOptionContext, #GApplication supports giving a %NULL 356 * @arg_data for a non-callback #GOptionEntry. This results in the 357 * argument in question being packed into a #GVariantDict which is also 358 * passed to #GApplication::handle-local-options, where it can be 359 * inspected and modified. If %G_APPLICATION_HANDLES_COMMAND_LINE is 360 * set, then the resulting dictionary is sent to the primary instance, 361 * where g_application_command_line_get_options_dict() will return it. 362 * This "packing" is done according to the type of the argument -- 363 * booleans for normal flags, strings for strings, bytestrings for 364 * filenames, etc. The packing only occurs if the flag is given (ie: we 365 * do not pack a "false" #GVariant in the case that a flag is missing). 366 * 367 * In general, it is recommended that all commandline arguments are 368 * parsed locally. The options dictionary should then be used to 369 * transmit the result of the parsing to the primary instance, where 370 * g_variant_dict_lookup() can be used. For local options, it is 371 * possible to either use @arg_data in the usual way, or to consult (and 372 * potentially remove) the option from the options dictionary. 373 * 374 * This function is new in GLib 2.40. Before then, the only real choice 375 * was to send all of the commandline arguments (options and all) to the 376 * primary instance for handling. #GApplication ignored them completely 377 * on the local side. Calling this function "opts in" to the new 378 * behaviour, and in particular, means that unrecognised options will be 379 * treated as errors. Unrecognised options have never been ignored when 380 * %G_APPLICATION_HANDLES_COMMAND_LINE is unset. 381 * 382 * If #GApplication::handle-local-options needs to see the list of 383 * filenames, then the use of %G_OPTION_REMAINING is recommended. If 384 * @arg_data is %NULL then %G_OPTION_REMAINING can be used as a key into 385 * the options dictionary. If you do use %G_OPTION_REMAINING then you 386 * need to handle these arguments for yourself because once they are 387 * consumed, they will no longer be visible to the default handling 388 * (which treats them as filenames to be opened). 389 * 390 * Params: 391 * entries = a 392 * %NULL-terminated list of #GOptionEntrys 393 * 394 * Since: 2.40 395 */ 396 public void addMainOptionEntries(GOptionEntry[] entries) 397 { 398 g_application_add_main_option_entries(gApplication, entries.ptr); 399 } 400 401 /** 402 * Adds a #GOptionGroup to the commandline handling of @application. 403 * 404 * This function is comparable to g_option_context_add_group(). 405 * 406 * Unlike g_application_add_main_option_entries(), this function does 407 * not deal with %NULL @arg_data and never transmits options to the 408 * primary instance. 409 * 410 * The reason for that is because, by the time the options arrive at the 411 * primary instance, it is typically too late to do anything with them. 412 * Taking the GTK option group as an example: GTK will already have been 413 * initialised by the time the #GApplication::command-line handler runs. 414 * In the case that this is not the first-running instance of the 415 * application, the existing instance may already have been running for 416 * a very long time. 417 * 418 * This means that the options from #GOptionGroup are only really usable 419 * in the case that the instance of the application being run is the 420 * first instance. Passing options like `--display=` or `--gdk-debug=` 421 * on future runs will have no effect on the existing primary instance. 422 * 423 * Calling this function will cause the options in the supplied option 424 * group to be parsed, but it does not cause you to be "opted in" to the 425 * new functionality whereby unrecognised options are rejected even if 426 * %G_APPLICATION_HANDLES_COMMAND_LINE was given. 427 * 428 * Params: 429 * group = a #GOptionGroup 430 * 431 * Since: 2.40 432 */ 433 public void addOptionGroup(OptionGroup group) 434 { 435 g_application_add_option_group(gApplication, (group is null) ? null : group.getOptionGroupStruct()); 436 } 437 438 /** 439 * Marks @application as busy (see g_application_mark_busy()) while 440 * @property on @object is %TRUE. 441 * 442 * The binding holds a reference to @application while it is active, but 443 * not to @object. Instead, the binding is destroyed when @object is 444 * finalized. 445 * 446 * Params: 447 * object = a #GObject 448 * property = the name of a boolean property of @object 449 * 450 * Since: 2.44 451 */ 452 public void bindBusyProperty(ObjectG object, string property) 453 { 454 g_application_bind_busy_property(gApplication, (object is null) ? null : object.getObjectGStruct(), Str.toStringz(property)); 455 } 456 457 /** 458 * Gets the unique identifier for @application. 459 * 460 * Return: the identifier for @application, owned by @application 461 * 462 * Since: 2.28 463 */ 464 public string getApplicationId() 465 { 466 return Str.toString(g_application_get_application_id(gApplication)); 467 } 468 469 /** 470 * Gets the #GDBusConnection being used by the application, or %NULL. 471 * 472 * If #GApplication is using its D-Bus backend then this function will 473 * return the #GDBusConnection being used for uniqueness and 474 * communication with the desktop environment and other instances of the 475 * application. 476 * 477 * If #GApplication is not using D-Bus then this function will return 478 * %NULL. This includes the situation where the D-Bus backend would 479 * normally be in use but we were unable to connect to the bus. 480 * 481 * This function must not be called before the application has been 482 * registered. See g_application_get_is_registered(). 483 * 484 * Return: a #GDBusConnection, or %NULL 485 * 486 * Since: 2.34 487 */ 488 public DBusConnection getDbusConnection() 489 { 490 auto p = g_application_get_dbus_connection(gApplication); 491 492 if(p is null) 493 { 494 return null; 495 } 496 497 return ObjectG.getDObject!(DBusConnection)(cast(GDBusConnection*) p); 498 } 499 500 /** 501 * Gets the D-Bus object path being used by the application, or %NULL. 502 * 503 * If #GApplication is using its D-Bus backend then this function will 504 * return the D-Bus object path that #GApplication is using. If the 505 * application is the primary instance then there is an object published 506 * at this path. If the application is not the primary instance then 507 * the result of this function is undefined. 508 * 509 * If #GApplication is not using D-Bus then this function will return 510 * %NULL. This includes the situation where the D-Bus backend would 511 * normally be in use but we were unable to connect to the bus. 512 * 513 * This function must not be called before the application has been 514 * registered. See g_application_get_is_registered(). 515 * 516 * Return: the object path, or %NULL 517 * 518 * Since: 2.34 519 */ 520 public string getDbusObjectPath() 521 { 522 return Str.toString(g_application_get_dbus_object_path(gApplication)); 523 } 524 525 /** 526 * Gets the flags for @application. 527 * 528 * See #GApplicationFlags. 529 * 530 * Return: the flags for @application 531 * 532 * Since: 2.28 533 */ 534 public GApplicationFlags getFlags() 535 { 536 return g_application_get_flags(gApplication); 537 } 538 539 /** 540 * Gets the current inactivity timeout for the application. 541 * 542 * This is the amount of time (in milliseconds) after the last call to 543 * g_application_release() before the application stops running. 544 * 545 * Return: the timeout, in milliseconds 546 * 547 * Since: 2.28 548 */ 549 public uint getInactivityTimeout() 550 { 551 return g_application_get_inactivity_timeout(gApplication); 552 } 553 554 /** 555 * Gets the application's current busy state, as set through 556 * g_application_mark_busy() or g_application_bind_busy_property(). 557 * 558 * Return: %TRUE if @application is currenty marked as busy 559 * 560 * Since: 2.44 561 */ 562 public bool getIsBusy() 563 { 564 return g_application_get_is_busy(gApplication) != 0; 565 } 566 567 /** 568 * Checks if @application is registered. 569 * 570 * An application is registered if g_application_register() has been 571 * successfully called. 572 * 573 * Return: %TRUE if @application is registered 574 * 575 * Since: 2.28 576 */ 577 public bool getIsRegistered() 578 { 579 return g_application_get_is_registered(gApplication) != 0; 580 } 581 582 /** 583 * Checks if @application is remote. 584 * 585 * If @application is remote then it means that another instance of 586 * application already exists (the 'primary' instance). Calls to 587 * perform actions on @application will result in the actions being 588 * performed by the primary instance. 589 * 590 * The value of this property cannot be accessed before 591 * g_application_register() has been called. See 592 * g_application_get_is_registered(). 593 * 594 * Return: %TRUE if @application is remote 595 * 596 * Since: 2.28 597 */ 598 public bool getIsRemote() 599 { 600 return g_application_get_is_remote(gApplication) != 0; 601 } 602 603 /** 604 * Gets the resource base path of @application. 605 * 606 * See g_application_set_resource_base_path() for more information. 607 * 608 * Return: the base resource path, if one is set 609 * 610 * Since: 2.42 611 */ 612 public string getResourceBasePath() 613 { 614 return Str.toString(g_application_get_resource_base_path(gApplication)); 615 } 616 617 /** 618 * Increases the use count of @application. 619 * 620 * Use this function to indicate that the application has a reason to 621 * continue to run. For example, g_application_hold() is called by GTK+ 622 * when a toplevel window is on the screen. 623 * 624 * To cancel the hold, call g_application_release(). 625 */ 626 public void hold() 627 { 628 g_application_hold(gApplication); 629 } 630 631 /** 632 * Increases the busy count of @application. 633 * 634 * Use this function to indicate that the application is busy, for instance 635 * while a long running operation is pending. 636 * 637 * The busy state will be exposed to other processes, so a session shell will 638 * use that information to indicate the state to the user (e.g. with a 639 * spinner). 640 * 641 * To cancel the busy indication, use g_application_unmark_busy(). 642 * 643 * Since: 2.38 644 */ 645 public void markBusy() 646 { 647 g_application_mark_busy(gApplication); 648 } 649 650 /** 651 * Opens the given files. 652 * 653 * In essence, this results in the #GApplication::open signal being emitted 654 * in the primary instance. 655 * 656 * @n_files must be greater than zero. 657 * 658 * @hint is simply passed through to the ::open signal. It is 659 * intended to be used by applications that have multiple modes for 660 * opening files (eg: "view" vs "edit", etc). Unless you have a need 661 * for this functionality, you should use "". 662 * 663 * The application must be registered before calling this function 664 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set. 665 * 666 * Params: 667 * files = an array of #GFiles to open 668 * nFiles = the length of the @files array 669 * hint = a hint (or ""), but never %NULL 670 * 671 * Since: 2.28 672 */ 673 public void open(FileIF[] files, string hint) 674 { 675 GFile*[] filesArray = new GFile*[files.length]; 676 for ( int i = 0; i < files.length; i++ ) 677 { 678 filesArray[i] = files[i].getFileStruct(); 679 } 680 681 g_application_open(gApplication, filesArray.ptr, cast(int)files.length, Str.toStringz(hint)); 682 } 683 684 /** 685 * Immediately quits the application. 686 * 687 * Upon return to the mainloop, g_application_run() will return, 688 * calling only the 'shutdown' function before doing so. 689 * 690 * The hold count is ignored. 691 * 692 * The result of calling g_application_run() again after it returns is 693 * unspecified. 694 * 695 * Since: 2.32 696 */ 697 public void quit() 698 { 699 g_application_quit(gApplication); 700 } 701 702 /** 703 * Attempts registration of the application. 704 * 705 * This is the point at which the application discovers if it is the 706 * primary instance or merely acting as a remote for an already-existing 707 * primary instance. This is implemented by attempting to acquire the 708 * application identifier as a unique bus name on the session bus using 709 * GDBus. 710 * 711 * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was 712 * given, then this process will always become the primary instance. 713 * 714 * Due to the internal architecture of GDBus, method calls can be 715 * dispatched at any time (even if a main loop is not running). For 716 * this reason, you must ensure that any object paths that you wish to 717 * register are registered before calling this function. 718 * 719 * If the application has already been registered then %TRUE is 720 * returned with no work performed. 721 * 722 * The #GApplication::startup signal is emitted if registration succeeds 723 * and @application is the primary instance (including the non-unique 724 * case). 725 * 726 * In the event of an error (such as @cancellable being cancelled, or a 727 * failure to connect to the session bus), %FALSE is returned and @error 728 * is set appropriately. 729 * 730 * Note: the return value of this function is not an indicator that this 731 * instance is or is not the primary instance of the application. See 732 * g_application_get_is_remote() for that. 733 * 734 * Params: 735 * cancellable = a #GCancellable, or %NULL 736 * 737 * Return: %TRUE if registration succeeded 738 * 739 * Since: 2.28 740 * 741 * Throws: GException on failure. 742 */ 743 public bool register(Cancellable cancellable) 744 { 745 GError* err = null; 746 747 auto p = g_application_register(gApplication, (cancellable is null) ? null : cancellable.getCancellableStruct(), &err) != 0; 748 749 if (err !is null) 750 { 751 throw new GException( new ErrorG(err) ); 752 } 753 754 return p; 755 } 756 757 /** 758 * Decrease the use count of @application. 759 * 760 * When the use count reaches zero, the application will stop running. 761 * 762 * Never call this function except to cancel the effect of a previous 763 * call to g_application_hold(). 764 */ 765 public void release() 766 { 767 g_application_release(gApplication); 768 } 769 770 /** 771 * Runs the application. 772 * 773 * This function is intended to be run from main() and its return value 774 * is intended to be returned by main(). Although you are expected to pass 775 * the @argc, @argv parameters from main() to this function, it is possible 776 * to pass %NULL if @argv is not available or commandline handling is not 777 * required. Note that on Windows, @argc and @argv are ignored, and 778 * g_win32_get_command_line() is called internally (for proper support 779 * of Unicode commandline arguments). 780 * 781 * #GApplication will attempt to parse the commandline arguments. You 782 * can add commandline flags to the list of recognised options by way of 783 * g_application_add_main_option_entries(). After this, the 784 * #GApplication::handle-local-options signal is emitted, from which the 785 * application can inspect the values of its #GOptionEntrys. 786 * 787 * #GApplication::handle-local-options is a good place to handle options 788 * such as `--version`, where an immediate reply from the local process is 789 * desired (instead of communicating with an already-running instance). 790 * A #GApplication::handle-local-options handler can stop further processing 791 * by returning a non-negative value, which then becomes the exit status of 792 * the process. 793 * 794 * What happens next depends on the flags: if 795 * %G_APPLICATION_HANDLES_COMMAND_LINE was specified then the remaining 796 * commandline arguments are sent to the primary instance, where a 797 * #GApplication::command-line signal is emitted. Otherwise, the 798 * remaining commandline arguments are assumed to be a list of files. 799 * If there are no files listed, the application is activated via the 800 * #GApplication::activate signal. If there are one or more files, and 801 * %G_APPLICATION_HANDLES_OPEN was specified then the files are opened 802 * via the #GApplication::open signal. 803 * 804 * If you are interested in doing more complicated local handling of the 805 * commandline then you should implement your own #GApplication subclass 806 * and override local_command_line(). In this case, you most likely want 807 * to return %TRUE from your local_command_line() implementation to 808 * suppress the default handling. See 809 * [gapplication-example-cmdline2.c][gapplication-example-cmdline2] 810 * for an example. 811 * 812 * If, after the above is done, the use count of the application is zero 813 * then the exit status is returned immediately. If the use count is 814 * non-zero then the default main context is iterated until the use count 815 * falls to zero, at which point 0 is returned. 816 * 817 * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will 818 * run for as much as 10 seconds with a use count of zero while waiting 819 * for the message that caused the activation to arrive. After that, 820 * if the use count falls to zero the application will exit immediately, 821 * except in the case that g_application_set_inactivity_timeout() is in 822 * use. 823 * 824 * This function sets the prgname (g_set_prgname()), if not already set, 825 * to the basename of argv[0]. 826 * 827 * Since 2.40, applications that are not explicitly flagged as services 828 * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or 829 * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the 830 * default handler for local_command_line) if "--gapplication-service" 831 * was given in the command line. If this flag is present then normal 832 * commandline processing is interrupted and the 833 * %G_APPLICATION_IS_SERVICE flag is set. This provides a "compromise" 834 * solution whereby running an application directly from the commandline 835 * will invoke it in the normal way (which can be useful for debugging) 836 * while still allowing applications to be D-Bus activated in service 837 * mode. The D-Bus service file should invoke the executable with 838 * "--gapplication-service" as the sole commandline argument. This 839 * approach is suitable for use by most graphical applications but 840 * should not be used from applications like editors that need precise 841 * control over when processes invoked via the commandline will exit and 842 * what their exit status will be. 843 * 844 * Params: 845 * argc = the argc from main() (or 0 if @argv is %NULL) 846 * argv = the argv from main(), or %NULL 847 * 848 * Return: the exit status 849 * 850 * Since: 2.28 851 */ 852 public int run(string[] argv) 853 { 854 return g_application_run(gApplication, cast(int)argv.length, Str.toStringzArray(argv)); 855 } 856 857 /** 858 * Sends a notification on behalf of @application to the desktop shell. 859 * There is no guarantee that the notification is displayed immediately, 860 * or even at all. 861 * 862 * Notifications may persist after the application exits. It will be 863 * D-Bus-activated when the notification or one of its actions is 864 * activated. 865 * 866 * Modifying @notification after this call has no effect. However, the 867 * object can be reused for a later call to this function. 868 * 869 * @id may be any string that uniquely identifies the event for the 870 * application. It does not need to be in any special format. For 871 * example, "new-message" might be appropriate for a notification about 872 * new messages. 873 * 874 * If a previous notification was sent with the same @id, it will be 875 * replaced with @notification and shown again as if it was a new 876 * notification. This works even for notifications sent from a previous 877 * execution of the application, as long as @id is the same string. 878 * 879 * @id may be %NULL, but it is impossible to replace or withdraw 880 * notifications without an id. 881 * 882 * If @notification is no longer relevant, it can be withdrawn with 883 * g_application_withdraw_notification(). 884 * 885 * Params: 886 * id = id of the notification, or %NULL 887 * notification = the #GNotification to send 888 * 889 * Since: 2.40 890 */ 891 public void sendNotification(string id, Notification notification) 892 { 893 g_application_send_notification(gApplication, Str.toStringz(id), (notification is null) ? null : notification.getNotificationStruct()); 894 } 895 896 /** 897 * This used to be how actions were associated with a #GApplication. 898 * Now there is #GActionMap for that. 899 * 900 * Deprecated: Use the #GActionMap interface instead. Never ever 901 * mix use of this API with use of #GActionMap on the same @application 902 * or things will go very badly wrong. This function is known to 903 * introduce buggy behaviour (ie: signals not emitted on changes to the 904 * action group), so you should really use #GActionMap instead. 905 * 906 * Params: 907 * actionGroup = a #GActionGroup, or %NULL 908 * 909 * Since: 2.28 910 */ 911 public void setActionGroup(ActionGroupIF actionGroup) 912 { 913 g_application_set_action_group(gApplication, (actionGroup is null) ? null : actionGroup.getActionGroupStruct()); 914 } 915 916 /** 917 * Sets the unique identifier for @application. 918 * 919 * The application id can only be modified if @application has not yet 920 * been registered. 921 * 922 * If non-%NULL, the application id must be valid. See 923 * g_application_id_is_valid(). 924 * 925 * Params: 926 * applicationId = the identifier for @application 927 * 928 * Since: 2.28 929 */ 930 public void setApplicationId(string applicationId) 931 { 932 g_application_set_application_id(gApplication, Str.toStringz(applicationId)); 933 } 934 935 /** 936 * Sets or unsets the default application for the process, as returned 937 * by g_application_get_default(). 938 * 939 * This function does not take its own reference on @application. If 940 * @application is destroyed then the default application will revert 941 * back to %NULL. 942 * 943 * Since: 2.32 944 */ 945 public void setDefault() 946 { 947 g_application_set_default(gApplication); 948 } 949 950 /** 951 * Sets the flags for @application. 952 * 953 * The flags can only be modified if @application has not yet been 954 * registered. 955 * 956 * See #GApplicationFlags. 957 * 958 * Params: 959 * flags = the flags for @application 960 * 961 * Since: 2.28 962 */ 963 public void setFlags(GApplicationFlags flags) 964 { 965 g_application_set_flags(gApplication, flags); 966 } 967 968 /** 969 * Sets the current inactivity timeout for the application. 970 * 971 * This is the amount of time (in milliseconds) after the last call to 972 * g_application_release() before the application stops running. 973 * 974 * This call has no side effects of its own. The value set here is only 975 * used for next time g_application_release() drops the use count to 976 * zero. Any timeouts currently in progress are not impacted. 977 * 978 * Params: 979 * inactivityTimeout = the timeout, in milliseconds 980 * 981 * Since: 2.28 982 */ 983 public void setInactivityTimeout(uint inactivityTimeout) 984 { 985 g_application_set_inactivity_timeout(gApplication, inactivityTimeout); 986 } 987 988 /** 989 * Sets (or unsets) the base resource path of @application. 990 * 991 * The path is used to automatically load various [application 992 * resources][gresource] such as menu layouts and action descriptions. 993 * The various types of resources will be found at fixed names relative 994 * to the given base path. 995 * 996 * By default, the resource base path is determined from the application 997 * ID by prefixing '/' and replacing each '.' with '/'. This is done at 998 * the time that the #GApplication object is constructed. Changes to 999 * the application ID after that point will not have an impact on the 1000 * resource base path. 1001 * 1002 * As an example, if the application has an ID of "org.example.app" then 1003 * the default resource base path will be "/org/example/app". If this 1004 * is a #GtkApplication (and you have not manually changed the path) 1005 * then Gtk will then search for the menus of the application at 1006 * "/org/example/app/gtk/menus.ui". 1007 * 1008 * See #GResource for more information about adding resources to your 1009 * application. 1010 * 1011 * You can disable automatic resource loading functionality by setting 1012 * the path to %NULL. 1013 * 1014 * Changing the resource base path once the application is running is 1015 * not recommended. The point at which the resource path is consulted 1016 * for forming paths for various purposes is unspecified. 1017 * 1018 * Params: 1019 * resourcePath = the resource path to use 1020 * 1021 * Since: 2.42 1022 */ 1023 public void setResourceBasePath(string resourcePath) 1024 { 1025 g_application_set_resource_base_path(gApplication, Str.toStringz(resourcePath)); 1026 } 1027 1028 /** 1029 * Destroys a binding between @property and the busy state of 1030 * @application that was previously created with 1031 * g_application_bind_busy_property(). 1032 * 1033 * Params: 1034 * object = a #GObject 1035 * property = the name of a boolean property of @object 1036 * 1037 * Since: 2.44 1038 */ 1039 public void unbindBusyProperty(ObjectG object, string property) 1040 { 1041 g_application_unbind_busy_property(gApplication, (object is null) ? null : object.getObjectGStruct(), Str.toStringz(property)); 1042 } 1043 1044 /** 1045 * Decreases the busy count of @application. 1046 * 1047 * When the busy count reaches zero, the new state will be propagated 1048 * to other processes. 1049 * 1050 * This function must only be called to cancel the effect of a previous 1051 * call to g_application_mark_busy(). 1052 * 1053 * Since: 2.38 1054 */ 1055 public void unmarkBusy() 1056 { 1057 g_application_unmark_busy(gApplication); 1058 } 1059 1060 /** 1061 * Withdraws a notification that was sent with 1062 * g_application_send_notification(). 1063 * 1064 * This call does nothing if a notification with @id doesn't exist or 1065 * the notification was never sent. 1066 * 1067 * This function works even for notifications sent in previous 1068 * executions of this application, as long @id is the same as it was for 1069 * the sent notification. 1070 * 1071 * Note that notifications are dismissed when the user clicks on one 1072 * of the buttons in a notification or triggers its default action, so 1073 * there is no need to explicitly withdraw the notification in that case. 1074 * 1075 * Params: 1076 * id = id of a previously sent notification 1077 * 1078 * Since: 2.40 1079 */ 1080 public void withdrawNotification(string id) 1081 { 1082 g_application_withdraw_notification(gApplication, Str.toStringz(id)); 1083 } 1084 1085 int[string] connectedSignals; 1086 1087 void delegate(Application)[] onActivateListeners; 1088 /** 1089 * The ::activate signal is emitted on the primary instance when an 1090 * activation occurs. See g_application_activate(). 1091 */ 1092 void addOnActivate(void delegate(Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1093 { 1094 if ( "activate" !in connectedSignals ) 1095 { 1096 Signals.connectData( 1097 this, 1098 "activate", 1099 cast(GCallback)&callBackActivate, 1100 cast(void*)this, 1101 null, 1102 connectFlags); 1103 connectedSignals["activate"] = 1; 1104 } 1105 onActivateListeners ~= dlg; 1106 } 1107 extern(C) static void callBackActivate(GApplication* applicationStruct, Application _application) 1108 { 1109 foreach ( void delegate(Application) dlg; _application.onActivateListeners ) 1110 { 1111 dlg(_application); 1112 } 1113 } 1114 1115 int delegate(ApplicationCommandLine, Application)[] onCommandLineListeners; 1116 /** 1117 * The ::command-line signal is emitted on the primary instance when 1118 * a commandline is not handled locally. See g_application_run() and 1119 * the #GApplicationCommandLine documentation for more information. 1120 * 1121 * Params: 1122 * commandLine = a #GApplicationCommandLine representing the 1123 * passed commandline 1124 * 1125 * Return: An integer that is set as the exit status for the calling 1126 * process. See g_application_command_line_set_exit_status(). 1127 */ 1128 void addOnCommandLine(int delegate(ApplicationCommandLine, Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1129 { 1130 if ( "command-line" !in connectedSignals ) 1131 { 1132 Signals.connectData( 1133 this, 1134 "command-line", 1135 cast(GCallback)&callBackCommandLine, 1136 cast(void*)this, 1137 null, 1138 connectFlags); 1139 connectedSignals["command-line"] = 1; 1140 } 1141 onCommandLineListeners ~= dlg; 1142 } 1143 extern(C) static int callBackCommandLine(GApplication* applicationStruct, GApplicationCommandLine* commandLine, Application _application) 1144 { 1145 return _application.onCommandLineListeners[0](ObjectG.getDObject!(ApplicationCommandLine)(commandLine), _application); 1146 } 1147 1148 int delegate(VariantDict, Application)[] onHandleLocalOptionsListeners; 1149 /** 1150 * The ::handle-local-options signal is emitted on the local instance 1151 * after the parsing of the commandline options has occurred. 1152 * 1153 * You can add options to be recognised during commandline option 1154 * parsing using g_application_add_main_option_entries() and 1155 * g_application_add_option_group(). 1156 * 1157 * Signal handlers can inspect @options (along with values pointed to 1158 * from the @arg_data of an installed #GOptionEntrys) in order to 1159 * decide to perform certain actions, including direct local handling 1160 * (which may be useful for options like --version). 1161 * 1162 * In the event that the application is marked 1163 * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will 1164 * send the @options dictionary to the primary instance where it can be 1165 * read with g_application_command_line_get_options_dict(). The signal 1166 * handler can modify the dictionary before returning, and the 1167 * modified dictionary will be sent. 1168 * 1169 * In the event that %G_APPLICATION_HANDLES_COMMAND_LINE is not set, 1170 * "normal processing" will treat the remaining uncollected command 1171 * line arguments as filenames or URIs. If there are no arguments, 1172 * the application is activated by g_application_activate(). One or 1173 * more arguments results in a call to g_application_open(). 1174 * 1175 * If you want to handle the local commandline arguments for yourself 1176 * by converting them to calls to g_application_open() or 1177 * g_action_group_activate_action() then you must be sure to register 1178 * the application first. You should probably not call 1179 * g_application_activate() for yourself, however: just return -1 and 1180 * allow the default handler to do it for you. This will ensure that 1181 * the `--gapplication-service` switch works properly (i.e. no activation 1182 * in that case). 1183 * 1184 * Note that this signal is emitted from the default implementation of 1185 * local_command_line(). If you override that function and don't 1186 * chain up then this signal will never be emitted. 1187 * 1188 * You can override local_command_line() if you need more powerful 1189 * capabilities than what is provided here, but this should not 1190 * normally be required. 1191 * 1192 * Params: 1193 * options = the options dictionary 1194 * 1195 * Return: an exit code. If you have handled your options and want 1196 * to exit the process, return a non-negative option, 0 for success, 1197 * and a positive value for failure. To continue, return -1 to let 1198 * the default option processing continue. 1199 * 1200 * Since: 2.40 1201 */ 1202 void addOnHandleLocalOptions(int delegate(VariantDict, Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1203 { 1204 if ( "handle-local-options" !in connectedSignals ) 1205 { 1206 Signals.connectData( 1207 this, 1208 "handle-local-options", 1209 cast(GCallback)&callBackHandleLocalOptions, 1210 cast(void*)this, 1211 null, 1212 connectFlags); 1213 connectedSignals["handle-local-options"] = 1; 1214 } 1215 onHandleLocalOptionsListeners ~= dlg; 1216 } 1217 extern(C) static int callBackHandleLocalOptions(GApplication* applicationStruct, GVariantDict* options, Application _application) 1218 { 1219 return _application.onHandleLocalOptionsListeners[0](new VariantDict(options), _application); 1220 } 1221 1222 void delegate(void*, int, string, Application)[] onOpenListeners; 1223 /** 1224 * The ::open signal is emitted on the primary instance when there are 1225 * files to open. See g_application_open() for more information. 1226 * 1227 * Params: 1228 * files = an array of #GFiles 1229 * nFiles = the length of @files 1230 * hint = a hint provided by the calling instance 1231 */ 1232 void addOnOpen(void delegate(void*, int, string, Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1233 { 1234 if ( "open" !in connectedSignals ) 1235 { 1236 Signals.connectData( 1237 this, 1238 "open", 1239 cast(GCallback)&callBackOpen, 1240 cast(void*)this, 1241 null, 1242 connectFlags); 1243 connectedSignals["open"] = 1; 1244 } 1245 onOpenListeners ~= dlg; 1246 } 1247 extern(C) static void callBackOpen(GApplication* applicationStruct, void* files, int nFiles, char* hint, Application _application) 1248 { 1249 foreach ( void delegate(void*, int, string, Application) dlg; _application.onOpenListeners ) 1250 { 1251 dlg(files, nFiles, Str.toString(hint), _application); 1252 } 1253 } 1254 1255 void delegate(Application)[] onShutdownListeners; 1256 /** 1257 * The ::shutdown signal is emitted only on the registered primary instance 1258 * immediately after the main loop terminates. 1259 */ 1260 void addOnShutdown(void delegate(Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1261 { 1262 if ( "shutdown" !in connectedSignals ) 1263 { 1264 Signals.connectData( 1265 this, 1266 "shutdown", 1267 cast(GCallback)&callBackShutdown, 1268 cast(void*)this, 1269 null, 1270 connectFlags); 1271 connectedSignals["shutdown"] = 1; 1272 } 1273 onShutdownListeners ~= dlg; 1274 } 1275 extern(C) static void callBackShutdown(GApplication* applicationStruct, Application _application) 1276 { 1277 foreach ( void delegate(Application) dlg; _application.onShutdownListeners ) 1278 { 1279 dlg(_application); 1280 } 1281 } 1282 1283 void delegate(Application)[] onStartupListeners; 1284 /** 1285 * The ::startup signal is emitted on the primary instance immediately 1286 * after registration. See g_application_register(). 1287 */ 1288 void addOnStartup(void delegate(Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1289 { 1290 if ( "startup" !in connectedSignals ) 1291 { 1292 Signals.connectData( 1293 this, 1294 "startup", 1295 cast(GCallback)&callBackStartup, 1296 cast(void*)this, 1297 null, 1298 connectFlags); 1299 connectedSignals["startup"] = 1; 1300 } 1301 onStartupListeners ~= dlg; 1302 } 1303 extern(C) static void callBackStartup(GApplication* applicationStruct, Application _application) 1304 { 1305 foreach ( void delegate(Application) dlg; _application.onStartupListeners ) 1306 { 1307 dlg(_application); 1308 } 1309 } 1310 }