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