Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals | ![]() |
![]() |
![]() |
![]() |
#include <gtk/gtk.h> struct GtkApplication; GtkApplication * gtk_application_new (const gchar *application_id
,GApplicationFlags flags
); void gtk_application_add_window (GtkApplication *application
,GtkWindow *window
); void gtk_application_remove_window (GtkApplication *application
,GtkWindow *window
); GList * gtk_application_get_windows (GtkApplication *application
); GtkWindow * gtk_application_get_window_by_id (GtkApplication *application
,guint id
); GtkWindow * gtk_application_get_active_window (GtkApplication *application
); enum GtkApplicationInhibitFlags; guint gtk_application_inhibit (GtkApplication *application
,GtkWindow *window
,GtkApplicationInhibitFlags flags
,const gchar *reason
); void gtk_application_uninhibit (GtkApplication *application
,guint cookie
); gboolean gtk_application_is_inhibited (GtkApplication *application
,GtkApplicationInhibitFlags flags
); GMenuModel * gtk_application_get_app_menu (GtkApplication *application
); void gtk_application_set_app_menu (GtkApplication *application
,GMenuModel *app_menu
); GMenuModel * gtk_application_get_menubar (GtkApplication *application
); void gtk_application_set_menubar (GtkApplication *application
,GMenuModel *menubar
); void gtk_application_add_accelerator (GtkApplication *application
,const gchar *accelerator
,const gchar *action_name
,GVariant *parameter
); void gtk_application_remove_accelerator (GtkApplication *application
,const gchar *action_name
,GVariant *parameter
); gchar ** gtk_application_list_action_descriptions (GtkApplication *application
); gchar ** gtk_application_get_accels_for_action (GtkApplication *application
,const gchar *detailed_action_name
); void gtk_application_set_accels_for_action (GtkApplication *application
,const gchar *detailed_action_name
,const gchar * const *accels
);
"active-window" GtkWindow* : Read "app-menu" GMenuModel* : Read / Write "menubar" GMenuModel* : Read / Write "register-session" gboolean : Read / Write
GtkApplication is a class that handles many important aspects of a GTK+ application in a convenient fashion, without enforcing a one-size-fits-all application model.
Currently, GtkApplication handles GTK+ initialization, application uniqueness, session management, provides some basic scriptability and desktop shell integration by exporting actions and menus and manages a list of toplevel windows whose life-cycle is automatically tied to the life-cycle of your application.
While GtkApplication works fine with plain GtkWindows, it is recommended to use it together with GtkApplicationWindow.
When GDK threads are enabled, GtkApplication will acquire the GDK
lock when invoking actions that arrive from other processes. The GDK
lock is not touched for local action invocations. In order to have
actions invoked in a predictable context it is therefore recommended
that the GDK lock be held while invoking actions locally with
g_action_group_activate_action()
. The same applies to actions
associated with GtkApplicationWindow and to the 'activate' and
'open' GApplication methods.
To set an application menu for a GtkApplication, use
gtk_application_set_app_menu()
. The GMenuModel that this function
expects is usually constructed using GtkBuilder, as seen in the
following example. To specify a menubar that will be shown by
GtkApplicationWindows, use gtk_application_set_menubar()
. Use the base
GActionMap interface to add actions, to respond to the user
selecting these menu items.
GTK+ displays these menus as expected, depending on the platform the application is running on.
Example 6. A simple application
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 |
#include <stdlib.h> #include <gtk/gtk.h> typedef struct { GtkApplication parent_instance; guint quit_inhibit; GMenu *time; guint timeout; } BloatPad; typedef GtkApplicationClass BloatPadClass; G_DEFINE_TYPE (BloatPad, bloat_pad, GTK_TYPE_APPLICATION) static void activate_toggle (GSimpleAction *action, GVariant *parameter, gpointer user_data) { GVariant *state; state = g_action_get_state (G_ACTION (action)); g_action_change_state (G_ACTION (action), g_variant_new_boolean (!g_variant_get_boolean (state))); g_variant_unref (state); } static void activate_radio (GSimpleAction *action, GVariant *parameter, gpointer user_data) { g_action_change_state (G_ACTION (action), parameter); } static void change_fullscreen_state (GSimpleAction *action, GVariant *state, gpointer user_data) { if (g_variant_get_boolean (state)) gtk_window_fullscreen (user_data); else gtk_window_unfullscreen (user_data); g_simple_action_set_state (action, state); } static void change_busy_state (GSimpleAction *action, GVariant *state, gpointer user_data) { GtkWindow *window = user_data; GApplication *application = G_APPLICATION (gtk_window_get_application (window)); /* do this twice to test multiple busy counter increases */ if (g_variant_get_boolean (state)) { g_application_mark_busy (application); g_application_mark_busy (application); } else { g_application_unmark_busy (application); g_application_unmark_busy (application); } g_simple_action_set_state (action, state); } static void change_justify_state (GSimpleAction *action, GVariant *state, gpointer user_data) { GtkTextView *text = g_object_get_data (user_data, "bloatpad-text"); const gchar *str; str = g_variant_get_string (state, NULL); if (g_str_equal (str, "left")) gtk_text_view_set_justification (text, GTK_JUSTIFY_LEFT); else if (g_str_equal (str, "center")) gtk_text_view_set_justification (text, GTK_JUSTIFY_CENTER); else if (g_str_equal (str, "right")) gtk_text_view_set_justification (text, GTK_JUSTIFY_RIGHT); else /* ignore this attempted change */ return; g_simple_action_set_state (action, state); } static GtkClipboard * get_clipboard (GtkWidget *widget) { return gtk_widget_get_clipboard (widget, gdk_atom_intern_static_string ("CLIPBOARD")); } static void window_copy (GSimpleAction *action, GVariant *parameter, gpointer user_data) { GtkWindow *window = GTK_WINDOW (user_data); GtkTextView *text = g_object_get_data ((GObject*)window, "bloatpad-text"); gtk_text_buffer_copy_clipboard (gtk_text_view_get_buffer (text), get_clipboard ((GtkWidget*) text)); } static void window_paste (GSimpleAction *action, GVariant *parameter, gpointer user_data) { GtkWindow *window = GTK_WINDOW (user_data); GtkTextView *text = g_object_get_data ((GObject*)window, "bloatpad-text"); gtk_text_buffer_paste_clipboard (gtk_text_view_get_buffer (text), get_clipboard ((GtkWidget*) text), NULL, TRUE); } static void activate_clear (GSimpleAction *action, GVariant *parameter, gpointer user_data) { GtkWindow *window = GTK_WINDOW (user_data); GtkTextView *text = g_object_get_data ((GObject*)window, "bloatpad-text"); gtk_text_buffer_set_text (gtk_text_view_get_buffer (text), "", -1); } static void activate_clear_all (GSimpleAction *action, GVariant *parameter, gpointer user_data) { GtkApplication *app = GTK_APPLICATION (user_data); GList *iter; for (iter = gtk_application_get_windows (app); iter; iter = iter->next) g_action_group_activate_action (iter->data, "clear", NULL); } static void text_buffer_changed_cb (GtkTextBuffer *buffer, gpointer user_data) { GtkWindow *window = user_data; BloatPad *app; gint old_n, n; app = (BloatPad *) gtk_window_get_application (window); n = gtk_text_buffer_get_char_count (buffer); if (n > 0) { if (!app->quit_inhibit) app->quit_inhibit = gtk_application_inhibit (GTK_APPLICATION (app), gtk_application_get_active_window (GTK_APPLICATION (app)), GTK_APPLICATION_INHIBIT_LOGOUT, "bloatpad can't save, so you can't logout; erase your text"); } else { if (app->quit_inhibit) { gtk_application_uninhibit (GTK_APPLICATION (app), app->quit_inhibit); app->quit_inhibit = 0; } } g_simple_action_set_enabled (G_SIMPLE_ACTION (g_action_map_lookup_action (G_ACTION_MAP (window), "clear")), n > 0); if (n > 0) { GSimpleAction *spellcheck; spellcheck = g_simple_action_new ("spell-check", NULL); g_action_map_add_action (G_ACTION_MAP (window), G_ACTION (spellcheck)); } else g_action_map_remove_action (G_ACTION_MAP (window), "spell-check"); old_n = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (buffer), "line-count")); n = gtk_text_buffer_get_line_count (buffer); g_object_set_data (G_OBJECT (buffer), "line-count", GINT_TO_POINTER (n)); if (old_n < 3 && n == 3) { GNotification *n; n = g_notification_new ("Three lines of text"); g_notification_set_body (n, "Keep up the good work!"); g_notification_add_button (n, "Start over", "app.clear-all"); g_application_send_notification (G_APPLICATION (app), "three-lines", n); g_object_unref (n); } } static GActionEntry win_entries[] = { { "copy", window_copy, NULL, NULL, NULL }, { "paste", window_paste, NULL, NULL, NULL }, { "fullscreen", activate_toggle, NULL, "false", change_fullscreen_state }, { "busy", activate_toggle, NULL, "false", change_busy_state }, { "justify", activate_radio, "s", "'left'", change_justify_state }, { "clear", activate_clear, NULL, NULL, NULL } }; static void new_window (GApplication *app, GFile *file) { GtkWidget *window, *grid, *scrolled, *view; GtkWidget *toolbar; GtkToolItem *button; GtkWidget *sw, *box, *label; window = gtk_application_window_new (GTK_APPLICATION (app)); gtk_window_set_default_size ((GtkWindow*)window, 640, 480); g_action_map_add_action_entries (G_ACTION_MAP (window), win_entries, G_N_ELEMENTS (win_entries), window); gtk_window_set_title (GTK_WINDOW (window), "Bloatpad"); grid = gtk_grid_new (); gtk_container_add (GTK_CONTAINER (window), grid); toolbar = gtk_toolbar_new (); button = gtk_toggle_tool_button_new (); gtk_tool_button_set_icon_name (GTK_TOOL_BUTTON (button), "format-justify-left"); gtk_actionable_set_detailed_action_name (GTK_ACTIONABLE (button), "win.justify::left"); gtk_container_add (GTK_CONTAINER (toolbar), GTK_WIDGET (button)); button = gtk_toggle_tool_button_new (); gtk_tool_button_set_icon_name (GTK_TOOL_BUTTON (button), "format-justify-center"); gtk_actionable_set_detailed_action_name (GTK_ACTIONABLE (button), "win.justify::center"); gtk_container_add (GTK_CONTAINER (toolbar), GTK_WIDGET (button)); button = gtk_toggle_tool_button_new (); gtk_tool_button_set_icon_name (GTK_TOOL_BUTTON (button), "format-justify-right"); gtk_actionable_set_detailed_action_name (GTK_ACTIONABLE (button), "win.justify::right"); gtk_container_add (GTK_CONTAINER (toolbar), GTK_WIDGET (button)); button = gtk_separator_tool_item_new (); gtk_separator_tool_item_set_draw (GTK_SEPARATOR_TOOL_ITEM (button), FALSE); gtk_tool_item_set_expand (GTK_TOOL_ITEM (button), TRUE); gtk_container_add (GTK_CONTAINER (toolbar), GTK_WIDGET (button)); button = gtk_tool_item_new (); box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6); gtk_container_add (GTK_CONTAINER (button), box); label = gtk_label_new ("Fullscreen:"); gtk_container_add (GTK_CONTAINER (box), label); sw = gtk_switch_new (); gtk_actionable_set_action_name (GTK_ACTIONABLE (sw), "win.fullscreen"); gtk_container_add (GTK_CONTAINER (box), sw); gtk_container_add (GTK_CONTAINER (toolbar), GTK_WIDGET (button)); gtk_grid_attach (GTK_GRID (grid), toolbar, 0, 0, 1, 1); scrolled = gtk_scrolled_window_new (NULL, NULL); gtk_widget_set_hexpand (scrolled, TRUE); gtk_widget_set_vexpand (scrolled, TRUE); view = gtk_text_view_new (); g_object_set_data ((GObject*)window, "bloatpad-text", view); gtk_container_add (GTK_CONTAINER (scrolled), view); gtk_grid_attach (GTK_GRID (grid), scrolled, 0, 1, 1, 1); if (file != NULL) { gchar *contents; gsize length; if (g_file_load_contents (file, NULL, &contents, &length, NULL, NULL)) { GtkTextBuffer *buffer; buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (view)); gtk_text_buffer_set_text (buffer, contents, length); g_free (contents); } } g_signal_connect (gtk_text_view_get_buffer (GTK_TEXT_VIEW (view)), "changed", G_CALLBACK (text_buffer_changed_cb), window); text_buffer_changed_cb (gtk_text_view_get_buffer (GTK_TEXT_VIEW (view)), window); gtk_widget_show_all (GTK_WIDGET (window)); } static void bloat_pad_activate (GApplication *application) { new_window (application, NULL); } static void bloat_pad_open (GApplication *application, GFile **files, gint n_files, const gchar *hint) { gint i; for (i = 0; i < n_files; i++) new_window (application, files[i]); } static void bloat_pad_finalize (GObject *object) { G_OBJECT_CLASS (bloat_pad_parent_class)->finalize (object); } static void new_activated (GSimpleAction *action, GVariant *parameter, gpointer user_data) { GApplication *app = user_data; g_application_activate (app); } static void about_activated (GSimpleAction *action, GVariant *parameter, gpointer user_data) { gtk_show_about_dialog (NULL, "program-name", "Bloatpad", "title", "About Bloatpad", "comments", "Not much to say, really.", NULL); } static void quit_activated (GSimpleAction *action, GVariant *parameter, gpointer user_data) { GApplication *app = user_data; g_application_quit (app); } static void combo_changed (GtkComboBox *combo, gpointer user_data) { GtkEntry *entry = g_object_get_data (user_data, "entry"); const gchar *action; gchar **accels; gchar *str; action = gtk_combo_box_get_active_id (combo); if (!action) return; accels = gtk_application_get_accels_for_action (gtk_window_get_application (user_data), action); str = g_strjoinv (",", accels); g_strfreev (accels); gtk_entry_set_text (entry, str); } static void response (GtkDialog *dialog, guint response_id, gpointer user_data) { GtkEntry *entry = g_object_get_data (user_data, "entry"); GtkComboBox *combo = g_object_get_data (user_data, "combo"); const gchar *action; const gchar *str; gchar **accels; action = gtk_combo_box_get_active_id (combo); if (!action) return; str = gtk_entry_get_text (entry); accels = g_strsplit (str, ",", 0); gtk_application_set_accels_for_action (gtk_window_get_application (user_data), action, (const gchar **) accels); g_strfreev (accels); } static void edit_accels (GSimpleAction *action, GVariant *parameter, gpointer user_data) { GtkApplication *app = user_data; GtkWidget *combo; GtkWidget *entry; gchar **actions; GtkWidget *dialog; gint i; dialog = gtk_dialog_new (); gtk_window_set_application (GTK_WINDOW (dialog), app); actions = gtk_application_list_action_descriptions (app); combo = gtk_combo_box_text_new (); gtk_container_add (GTK_CONTAINER (gtk_dialog_get_content_area (GTK_DIALOG (dialog))), combo); for (i = 0; actions[i]; i++) gtk_combo_box_text_append (GTK_COMBO_BOX_TEXT (combo), actions[i], actions[i]); g_signal_connect (combo, "changed", G_CALLBACK (combo_changed), dialog); entry = gtk_entry_new (); gtk_container_add (GTK_CONTAINER (gtk_dialog_get_content_area (GTK_DIALOG (dialog))), entry); gtk_dialog_add_button (GTK_DIALOG (dialog), "Set", GTK_RESPONSE_APPLY); g_signal_connect (dialog, "response", G_CALLBACK (response), dialog); g_object_set_data (G_OBJECT (dialog), "combo", combo); g_object_set_data (G_OBJECT (dialog), "entry", entry); gtk_widget_show_all (dialog); } static gboolean update_time (gpointer user_data) { BloatPad *bloatpad = user_data; GDateTime *now; gchar *time; while (g_menu_model_get_n_items (G_MENU_MODEL (bloatpad->time))) g_menu_remove (bloatpad->time, 0); g_message ("Updating the time menu (which should be open now)..."); now = g_date_time_new_now_local (); time = g_date_time_format (now, "%c"); g_menu_append (bloatpad->time, time, NULL); g_date_time_unref (now); g_free (time); return G_SOURCE_CONTINUE; } static void time_active_changed (GSimpleAction *action, GVariant *state, gpointer user_data) { BloatPad *bloatpad = user_data; if (g_variant_get_boolean (state)) { if (!bloatpad->timeout) { bloatpad->timeout = g_timeout_add (1000, update_time, bloatpad); update_time (bloatpad); } } else { if (bloatpad->timeout) { g_source_remove (bloatpad->timeout); bloatpad->timeout = 0; } } g_simple_action_set_state (action, state); } static GActionEntry app_entries[] = { { "new", new_activated, NULL, NULL, NULL }, { "about", about_activated, NULL, NULL, NULL }, { "quit", quit_activated, NULL, NULL, NULL }, { "edit-accels", edit_accels }, { "time-active", NULL, NULL, "false", time_active_changed }, { "clear-all", activate_clear_all } }; static void dump_accels (GtkApplication *app) { gchar **actions; gint i; actions = gtk_application_list_action_descriptions (app); for (i = 0; actions[i]; i++) { gchar **accels; gchar *str; accels = gtk_application_get_accels_for_action (app, actions[i]); str = g_strjoinv (",", accels); g_print ("%s -> %s\n", actions[i], str); g_strfreev (accels); g_free (str); } g_strfreev (actions); } static void bloat_pad_startup (GApplication *application) { BloatPad *bloatpad = (BloatPad*) application; GtkBuilder *builder; GMenu *menu; GMenuItem *item; GIcon *icon; GIcon *icon2; GEmblem *emblem; GFile *file; gchar *data; gsize size; G_APPLICATION_CLASS (bloat_pad_parent_class) ->startup (application); g_action_map_add_action_entries (G_ACTION_MAP (application), app_entries, G_N_ELEMENTS (app_entries), application); builder = gtk_builder_new (); gtk_builder_add_from_string (builder, "<interface>" " <menu id='app-menu'>" " <section>" " <item>" " <attribute name='label' translatable='yes'>_New Window</attribute>" " <attribute name='action'>app.new</attribute>" " </item>" " </section>" " <section>" " <item>" " <attribute name='label' translatable='yes'>_About Bloatpad</attribute>" " <attribute name='action'>app.about</attribute>" " </item>" " </section>" " <section>" " <item>" " <attribute name='label' translatable='yes'>_Quit</attribute>" " <attribute name='action'>app.quit</attribute>" " </item>" " </section>" " </menu>" " <menu id='menubar'>" " <submenu>" " <attribute name='label' translatable='yes'>_Edit</attribute>" " <section>" " <item>" " <attribute name='label' translatable='yes'>_Copy</attribute>" " <attribute name='action'>win.copy</attribute>" " </item>" " <item>" " <attribute name='label' translatable='yes'>_Paste</attribute>" " <attribute name='action'>win.paste</attribute>" " </item>" " </section>" " <section>" " <item>" " <attribute name='label'>Clear (always shown)</attribute>" " <attribute name='action'>win.clear</attribute>" /* action should never be missing (so always shown) */ " <attribute name='hidden-when'>action-missing</attribute>" " </item>" " <item>" " <attribute name='label'>Clear (hidden when no text)</attribute>" " <attribute name='hidden-when'>action-disabled</attribute>" " <attribute name='action'>win.clear</attribute>" " </item>" " <item>" " <attribute name='label'>Spell check (does nothing, hides)</attribute>" " <attribute name='hidden-when'>action-missing</attribute>" " <attribute name='action'>win.spell-check</attribute>" " </item>" " </section>" " <section>" " <item>" " <attribute name='label' translatable='yes'>Accelerators...</attribute>" " <attribute name='action'>app.edit-accels</attribute>" " </item>" " </section>" " </submenu>" " <submenu>" " <attribute name='label' translatable='yes'>_View</attribute>" " <section>" " <item>" " <attribute name='label' translatable='yes'>_Fullscreen</attribute>" " <attribute name='action'>win.fullscreen</attribute>" " </item>" " <item>" " <attribute name='label' translatable='yes'>_Look Busy</attribute>" " <attribute name='action'>win.busy</attribute>" " </item>" " </section>" " </submenu>" " <submenu id='icon-menu'>" " <attribute name='label' translatable='yes'>_Icons</attribute>" " </submenu>" " <submenu id='time-menu'>" " <attribute name='label' translatable='yes'>Time</attribute>" " <attribute name='submenu-action'>app.time-active</attribute>" " </submenu>" " </menu>" "</interface>", -1, NULL); gtk_application_set_app_menu (GTK_APPLICATION (application), G_MENU_MODEL (gtk_builder_get_object (builder, "app-menu"))); gtk_application_set_menubar (GTK_APPLICATION (application), G_MENU_MODEL (gtk_builder_get_object (builder, "menubar"))); gtk_application_add_accelerator (GTK_APPLICATION (application), "<Primary>n", "app.new", NULL); gtk_application_add_accelerator (GTK_APPLICATION (application), "<Primary>q", "app.quit", NULL); gtk_application_add_accelerator (GTK_APPLICATION (application), "<Primary>c", "win.copy", NULL); gtk_application_add_accelerator (GTK_APPLICATION (application), "<Primary>p", "win.paste", NULL); gtk_application_add_accelerator (GTK_APPLICATION (application), "<Primary>l", "win.justify", g_variant_new_string ("left")); gtk_application_add_accelerator (GTK_APPLICATION (application), "<Primary>m", "win.justify", g_variant_new_string ("center")); gtk_application_add_accelerator (GTK_APPLICATION (application), "<Primary>r", "win.justify", g_variant_new_string ("right")); menu = G_MENU (gtk_builder_get_object (builder, "icon-menu")); file = g_file_new_for_path (SRCDIR "/../gtk/stock-icons/16/help-about.png"); icon = g_file_icon_new (file); item = g_menu_item_new ("File Icon", NULL); g_menu_item_set_icon (item, icon); g_menu_append_item (menu, item); g_object_unref (item); g_object_unref (icon); g_object_unref (file); icon = g_themed_icon_new ("edit-find"); item = g_menu_item_new ("Themed Icon", NULL); g_menu_item_set_icon (item, icon); g_menu_append_item (menu, item); g_object_unref (item); g_object_unref (icon); if (g_file_get_contents (SRCDIR "/../gtk/stock-icons/16/list-add.png", &data, &size, NULL)) { GBytes *bytes = g_bytes_new_take (data, size); icon = g_bytes_icon_new (bytes); item = g_menu_item_new ("Bytes Icon", NULL); g_menu_item_set_icon (item, icon); g_menu_append_item (menu, item); g_object_unref (item); g_object_unref (icon); g_bytes_unref (bytes); } icon = G_ICON (gdk_pixbuf_new_from_file (SRCDIR "/../gtk/stock-icons/16/gtk-preferences.png", NULL)); item = g_menu_item_new ("Pixbuf", NULL); g_menu_item_set_icon (item, icon); g_menu_append_item (menu, item); g_object_unref (item); g_object_unref (icon); file = g_file_new_for_path (SRCDIR "/../gtk/stock-icons/16/edit-paste.png"); icon = g_file_icon_new (file); emblem = g_emblem_new (icon); g_object_unref (icon); g_object_unref (file); file = g_file_new_for_path (SRCDIR "/../gtk/stock-icons/16/edit-copy.png"); icon2 = g_file_icon_new (file); icon = g_emblemed_icon_new (icon2, emblem); item = g_menu_item_new ("Emblemed Icon", NULL); g_menu_item_set_icon (item, icon); g_menu_append_item (menu, item); g_object_unref (item); g_object_unref (icon); g_object_unref (icon2); g_object_unref (file); g_object_unref (emblem); icon = g_themed_icon_new ("weather-severe-alert-symbolic"); item = g_menu_item_new ("Symbolic Icon", NULL); g_menu_item_set_icon (item, icon); g_menu_append_item (menu, item); g_object_unref (item); g_object_unref (icon); const gchar *new_accels[] = { "<Primary>n", "<Primary>t", NULL }; gtk_application_set_accels_for_action (GTK_APPLICATION (application), "app.new", new_accels); dump_accels (GTK_APPLICATION (application)); //gtk_application_set_menubar (GTK_APPLICATION (application), G_MENU_MODEL (gtk_builder_get_object (builder, "app-menu"))); bloatpad->time = G_MENU (gtk_builder_get_object (builder, "time-menu")); g_object_unref (builder); } static void bloat_pad_shutdown (GApplication *application) { BloatPad *bloatpad = (BloatPad *) application; if (bloatpad->timeout) { g_source_remove (bloatpad->timeout); bloatpad->timeout = 0; } G_APPLICATION_CLASS (bloat_pad_parent_class) ->shutdown (application); } static void bloat_pad_init (BloatPad *app) { } static void bloat_pad_class_init (BloatPadClass *class) { GApplicationClass *application_class = G_APPLICATION_CLASS (class); GObjectClass *object_class = G_OBJECT_CLASS (class); application_class->startup = bloat_pad_startup; application_class->shutdown = bloat_pad_shutdown; application_class->activate = bloat_pad_activate; application_class->open = bloat_pad_open; object_class->finalize = bloat_pad_finalize; } BloatPad * bloat_pad_new (void) { BloatPad *bloat_pad; g_set_application_name ("Bloatpad"); bloat_pad = g_object_new (bloat_pad_get_type (), "application-id", "org.gtk.Test.bloatpad", "flags", G_APPLICATION_HANDLES_OPEN, "inactivity-timeout", 30000, "register-session", TRUE, NULL); return bloat_pad; } int main (int argc, char **argv) { BloatPad *bloat_pad; int status; bloat_pad = bloat_pad_new (); gtk_application_add_accelerator (GTK_APPLICATION (bloat_pad), "F11", "win.fullscreen", NULL); status = g_application_run (G_APPLICATION (bloat_pad), argc, argv); g_object_unref (bloat_pad); return status; } |
GtkApplication optionally registers with a session manager of the users session (if you set the "register-session" property) and offers various functionality related to the session life-cycle.
An application can block various ways to end the session with
the gtk_application_inhibit()
function. Typical use cases for
this kind of inhibiting are long-running, uninterruptible operations,
such as burning a CD or performing a disk backup. The session
manager may not honor the inhibitor, but it can be expected to
inform the user about the negative consequences of ending the
session while inhibitors are present.
GtkApplication * gtk_application_new (const gchar *application_id
,GApplicationFlags flags
);
Creates a new GtkApplication instance.
When using GtkApplication, it is not necessary to call gtk_init()
manually. It is called as soon as the application gets registered as
the primary instance.
Concretely, gtk_init()
is called in the default handler for the
"startup" signal. Therefore, GtkApplication subclasses should
chain up in their "startup" handler before using any GTK+ API.
Note that commandline arguments are not passed to gtk_init()
.
All GTK+ functionality that is available via commandline arguments
can also be achieved by setting suitable environment variables
such as G_DEBUG
, so this should not be a big
problem. If you absolutely must support GTK+ commandline arguments,
you can explicitly call gtk_init()
before creating the application
instance.
If non-NULL
, the application ID must be valid. See
g_application_id_is_valid()
.
If no application ID is given then some features (most notably application uniqueness) will be disabled. A null application ID is only allowed with GTK+ 3.6 or later.
|
The application ID. [allow-none] |
|
the application flags |
Returns : |
a new GtkApplication instance |
Since 3.0
void gtk_application_add_window (GtkApplication *application
,GtkWindow *window
);
Adds a window to application
.
This call is equivalent to setting the "application"
property of window
to application
.
Normally, the connection between the application and the window
will remain until the window is destroyed, but you can explicitly
remove it with gtk_application_remove_window()
.
GTK+ will keep the application running as long as it has any windows.
|
a GtkApplication |
|
a GtkWindow |
Since 3.0
void gtk_application_remove_window (GtkApplication *application
,GtkWindow *window
);
Remove a window from application
.
If window
belongs to application
then this call is equivalent to
setting the "application" property of window
to
NULL
.
The application may stop running as a result of a call to this function.
|
a GtkApplication |
|
a GtkWindow |
Since 3.0
GList * gtk_application_get_windows (GtkApplication *application
);
Gets a list of the GtkWindows associated with application
.
The list is sorted by most recently focused window, such that the first element is the currently focused window. (Useful for choosing a parent for a transient window.)
The list that is returned should not be modified in any way. It will only remain valid until the next focus change or window creation or deletion.
|
a GtkApplication |
Returns : |
a GList of GtkWindow. [element-type GtkWindow][transfer none] |
Since 3.0
GtkWindow * gtk_application_get_window_by_id (GtkApplication *application
,guint id
);
Returns the GtkApplicationWindow with the given ID.
|
a GtkApplication |
|
an identifier number |
Returns : |
the window with ID id , or
NULL if there is no window with this ID. [transfer none]
|
Since 3.6
GtkWindow * gtk_application_get_active_window (GtkApplication *application
);
Gets the "active" window for the application.
The active window is the one that was most recently focused (within the application). This window may not have the focus at the moment if another application has it -- this is just the most recently-focused window within this application.
|
a GtkApplication |
Returns : |
the active window. [transfer none] |
Since 3.6
typedef enum { GTK_APPLICATION_INHIBIT_LOGOUT = (1 << 0), GTK_APPLICATION_INHIBIT_SWITCH = (1 << 1), GTK_APPLICATION_INHIBIT_SUSPEND = (1 << 2), GTK_APPLICATION_INHIBIT_IDLE = (1 << 3) } GtkApplicationInhibitFlags;
Types of user actions that may be blocked by gtk_application_inhibit()
.
Inhibit ending the user session by logging out or by shutting down the computer | |
Inhibit user switching | |
Inhibit suspending the session or computer | |
Inhibit the session being marked as idle (and possibly locked) |
Since 3.4
guint gtk_application_inhibit (GtkApplication *application
,GtkWindow *window
,GtkApplicationInhibitFlags flags
,const gchar *reason
);
Inform the session manager that certain types of actions should be inhibited. This is not guaranteed to work on all platforms and for all types of actions.
Applications should invoke this method when they begin an operation
that should not be interrupted, such as creating a CD or DVD. The
types of actions that may be blocked are specified by the flags
parameter. When the application completes the operation it should
call gtk_application_uninhibit()
to remove the inhibitor. Note that
an application can have multiple inhibitors, and all of the must
be individually removed. Inhibitors are also cleared when the
application exits.
Applications should not expect that they will always be able to block the action. In most cases, users will be given the option to force the action to take place.
Reasons should be short and to the point.
If window
is given, the session manager may point the user to
this window to find out more about why the action is inhibited.
|
the GApplication |
|
a GtkWindow, or NULL . [allow-none]
|
|
what types of actions should be inhibited |
|
a short, human-readable string that explains why these operations are inhibited. [allow-none] |
Returns : |
A non-zero cookie that is used to uniquely identify this
request. It should be used as an argument to gtk_application_uninhibit()
in order to remove the request. If the platform does not support
inhibiting or the request failed for some reason, 0 is returned. |
Since 3.4
void gtk_application_uninhibit (GtkApplication *application
,guint cookie
);
Removes an inhibitor that has been established with gtk_application_inhibit()
.
Inhibitors are also cleared when the application exits.
|
the GApplication |
|
a cookie that was returned by gtk_application_inhibit()
|
Since 3.4
gboolean gtk_application_is_inhibited (GtkApplication *application
,GtkApplicationInhibitFlags flags
);
Determines if any of the actions specified in flags
are
currently inhibited (possibly by another application).
|
the GApplication |
|
what types of actions should be queried |
Returns : |
TRUE if any of the actions specified in flags are inhibited |
Since 3.4
GMenuModel * gtk_application_get_app_menu (GtkApplication *application
);
Returns the menu model that has been set with
gtk_application_set_app_menu()
.
|
a GtkApplication |
Returns : |
the application menu of application . [transfer none]
|
Since 3.4
void gtk_application_set_app_menu (GtkApplication *application
,GMenuModel *app_menu
);
Sets or unsets the application menu for application
.
This can only be done in the primary instance of the application, after it has been registered. "startup" is a good place to call this.
The application menu is a single menu containing items that typically impact the application as a whole, rather than acting on a specific window or document. For example, you would expect to see "Preferences" or "Quit" in an application menu, but not "Save" or "Print".
If supported, the application menu will be rendered by the desktop environment.
Use the base GActionMap interface to add actions, to respond to the user selecting these menu items.
|
a GtkApplication |
|
a GMenuModel, or NULL . [allow-none]
|
Since 3.4
GMenuModel * gtk_application_get_menubar (GtkApplication *application
);
Returns the menu model that has been set with
gtk_application_set_menubar()
.
|
a GtkApplication |
Returns : |
the menubar for windows of application . [transfer none]
|
Since 3.4
void gtk_application_set_menubar (GtkApplication *application
,GMenuModel *menubar
);
Sets or unsets the menubar for windows of application
.
This is a menubar in the traditional sense.
This can only be done in the primary instance of the application, after it has been registered. "startup" is a good place to call this.
Depending on the desktop environment, this may appear at the top of each window, or at the top of the screen. In some environments, if both the application menu and the menubar are set, the application menu will be presented as if it were the first item of the menubar. Other environments treat the two as completely separate -- for example, the application menu may be rendered by the desktop shell while the menubar (if set) remains in each individual window.
Use the base GActionMap interface to add actions, to respond to the user selecting these menu items.
|
a GtkApplication |
|
a GMenuModel, or NULL . [allow-none]
|
Since 3.4
void gtk_application_add_accelerator (GtkApplication *application
,const gchar *accelerator
,const gchar *action_name
,GVariant *parameter
);
Installs an accelerator that will cause the named action
to be activated when the key combination specificed by accelerator
is pressed.
accelerator
must be a string that can be parsed by
gtk_accelerator_parse()
, e.g. "<Primary>q" or
"<Control><Alt>p".
action_name
must be the name of an action as it would be used
in the app menu, i.e. actions that have been added to the application
are referred to with an "app." prefix, and window-specific actions
with a "win." prefix.
GtkApplication also extracts accelerators out of 'accel' attributes
in the GMenuModels passed to gtk_application_set_app_menu()
and
gtk_application_set_menubar()
, which is usually more convenient
than calling this function for each accelerator.
|
a GtkApplication |
|
accelerator string |
|
the name of the action to activate |
|
parameter to pass when activating the action,
or NULL if the action does not accept an activation parameter. [allow-none]
|
Since 3.4
void gtk_application_remove_accelerator (GtkApplication *application
,const gchar *action_name
,GVariant *parameter
);
Removes an accelerator that has been previously added
with gtk_application_add_accelerator()
.
|
a GtkApplication |
|
the name of the action to activate |
|
parameter to pass when activating the action,
or NULL if the action does not accept an activation parameter. [allow-none]
|
Since 3.4
gchar ** gtk_application_list_action_descriptions
(GtkApplication *application
);
Lists the detailed action names which have associated accelerators.
See gtk_application_set_accels_for_action()
.
|
a GtkApplication |
Returns : |
a NULL -terminated array of strings,
free with g_strfreev() when done. [transfer full]
|
Since 3.12
gchar ** gtk_application_get_accels_for_action (GtkApplication *application
,const gchar *detailed_action_name
);
Gets the accelerators that are currently associated with the given action.
|
a GtkApplication |
|
a detailed action name, specifying and action and target to obtain accelerators for |
Returns : |
accelerators for detailed_action_name , as
a NULL -terminated array. Free with g_strfreev() when no longer needed. [transfer full]
|
Since 3.12
void gtk_application_set_accels_for_action (GtkApplication *application
,const gchar *detailed_action_name
,const gchar * const *accels
);
Sets one or more keyboard accelerator that will trigger the
given action. The first item in accels
will be the primary
accelerator, which may be displayed in the UI.
|
a GtkApplication |
|
a detailed action name, specifying and action and target to associate accelerators with |
|
a list of accelerators in the format understood by
gtk_accelerator_parse() . [array zero-terminated=1]
|
Since 3.12
"active-window"
property"active-window" GtkWindow* : Read
The window which most recently had focus.
"app-menu"
property "app-menu" GMenuModel* : Read / Write
The GMenuModel for the application menu.
"window-added"
signalvoid user_function (GtkApplication *application,
GtkWindow *window,
gpointer user_data) : Run First
Emitted when a GtkWindow is added to application
through
gtk_application_add_window()
.
|
the GtkApplication which emitted the signal |
|
the newly-added GtkWindow |
|
user data set when the signal handler was connected. |
Since 3.2
"window-removed"
signalvoid user_function (GtkApplication *application,
GtkWindow *window,
gpointer user_data) : Run First
Emitted when a GtkWindow is removed from application
,
either as a side-effect of being destroyed or explicitly
through gtk_application_remove_window()
.
|
the GtkApplication which emitted the signal |
|
the GtkWindow that is being removed |
|
user data set when the signal handler was connected. |
Since 3.2