gtkapplication.h 5.76 KB
Newer Older
Allison Karlitskaya's avatar
Allison Karlitskaya committed
1
2
/*
 * Copyright © 2010 Codethink Limited
Matthias Clasen's avatar
Matthias Clasen committed
3
4
5
6
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
Allison Karlitskaya's avatar
Allison Karlitskaya committed
7
 * version 2 of the licence, or (at your option) any later version.
Matthias Clasen's avatar
Matthias Clasen committed
8
9
10
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Allison Karlitskaya's avatar
Allison Karlitskaya committed
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Matthias Clasen's avatar
Matthias Clasen committed
12
13
14
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Matthias Clasen's avatar
Matthias Clasen committed
16
 *
Allison Karlitskaya's avatar
Allison Karlitskaya committed
17
 * Author: Ryan Lortie <desrt@desrt.ca>
Matthias Clasen's avatar
Matthias Clasen committed
18
19
 */

20
21
22
#ifndef __GTK_APPLICATION_H__
#define __GTK_APPLICATION_H__

Matthias Clasen's avatar
Matthias Clasen committed
23
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
Matthias Clasen's avatar
Matthias Clasen committed
24
25
26
#error "Only <gtk/gtk.h> can be included directly."
#endif

Allison Karlitskaya's avatar
Allison Karlitskaya committed
27
28
#include <gtk/gtkwidget.h>
#include <gio/gio.h>
Matthias Clasen's avatar
Matthias Clasen committed
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

G_BEGIN_DECLS

#define GTK_TYPE_APPLICATION            (gtk_application_get_type ())
#define GTK_APPLICATION(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_APPLICATION, GtkApplication))
#define GTK_APPLICATION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_APPLICATION, GtkApplicationClass))
#define GTK_IS_APPLICATION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_APPLICATION))
#define GTK_IS_APPLICATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_APPLICATION))
#define GTK_APPLICATION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_APPLICATION, GtkApplicationClass))

typedef struct _GtkApplication        GtkApplication;
typedef struct _GtkApplicationClass   GtkApplicationClass;

struct _GtkApplication
{
44
  GApplication parent_instance;
Matthias Clasen's avatar
Matthias Clasen committed
45
46
};

William Jon McCann's avatar
William Jon McCann committed
47
48
49
/**
 * GtkApplicationClass:
 * @parent_class: The parent class.
Matthias Clasen's avatar
Matthias Clasen committed
50
 * @window_added: Signal emitted when a `GtkWindow` is added to
William Jon McCann's avatar
William Jon McCann committed
51
 *    application through gtk_application_add_window().
Matthias Clasen's avatar
Matthias Clasen committed
52
 * @window_removed: Signal emitted when a `GtkWindow` is removed from
William Jon McCann's avatar
William Jon McCann committed
53
54
55
 *    application, either as a side-effect of being destroyed or
 *    explicitly through gtk_application_remove_window().
 */
Matthias Clasen's avatar
Matthias Clasen committed
56
57
58
59
struct _GtkApplicationClass
{
  GApplicationClass parent_class;

William Jon McCann's avatar
William Jon McCann committed
60
61
  /*< public >*/

62
63
64
65
66
  void (*window_added)   (GtkApplication *application,
                          GtkWindow      *window);
  void (*window_removed) (GtkApplication *application,
                          GtkWindow      *window);

Allison Karlitskaya's avatar
Allison Karlitskaya committed
67
  /*< private >*/
Matthias Clasen's avatar
Matthias Clasen committed
68
  gpointer padding[8];
Matthias Clasen's avatar
Matthias Clasen committed
69
70
};

71
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
72
GType            gtk_application_get_type      (void) G_GNUC_CONST;
Allison Karlitskaya's avatar
Allison Karlitskaya committed
73

74
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
75
GtkApplication * gtk_application_new           (const char        *application_id,
Matthias Clasen's avatar
Matthias Clasen committed
76
                                                GApplicationFlags  flags);
Matthias Clasen's avatar
Matthias Clasen committed
77

78
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
79
80
void             gtk_application_add_window    (GtkApplication    *application,
                                                GtkWindow         *window);
81

82
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
83
84
void             gtk_application_remove_window (GtkApplication    *application,
                                                GtkWindow         *window);
85
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
86
GList *          gtk_application_get_windows   (GtkApplication    *application);
87

Matthias Clasen's avatar
Matthias Clasen committed
88
GDK_AVAILABLE_IN_ALL
89
GMenuModel *     gtk_application_get_menubar   (GtkApplication    *application);
Matthias Clasen's avatar
Matthias Clasen committed
90
GDK_AVAILABLE_IN_ALL
91
void             gtk_application_set_menubar   (GtkApplication    *application,
92
                                                GMenuModel        *menubar);
93

94
95
96
97
98
99
100
101
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;

Matthias Clasen's avatar
Matthias Clasen committed
102
GDK_AVAILABLE_IN_ALL
103
104
105
guint            gtk_application_inhibit            (GtkApplication             *application,
                                                     GtkWindow                  *window,
                                                     GtkApplicationInhibitFlags  flags,
Benjamin Otte's avatar
Benjamin Otte committed
106
                                                     const char                 *reason);
Matthias Clasen's avatar
Matthias Clasen committed
107
GDK_AVAILABLE_IN_ALL
108
109
110
void             gtk_application_uninhibit          (GtkApplication             *application,
                                                     guint                       cookie);

Matthias Clasen's avatar
Matthias Clasen committed
111
GDK_AVAILABLE_IN_ALL
112
113
114
GtkWindow *      gtk_application_get_window_by_id   (GtkApplication             *application,
                                                     guint                       id);

Matthias Clasen's avatar
Matthias Clasen committed
115
GDK_AVAILABLE_IN_ALL
116
117
GtkWindow *      gtk_application_get_active_window  (GtkApplication             *application);

Matthias Clasen's avatar
Matthias Clasen committed
118
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
119
char **         gtk_application_list_action_descriptions        (GtkApplication       *application);
120

Matthias Clasen's avatar
Matthias Clasen committed
121
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
122
123
char **         gtk_application_get_accels_for_action           (GtkApplication       *application,
                                                                  const char           *detailed_action_name);
Matthias Clasen's avatar
Matthias Clasen committed
124
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
125
126
char **         gtk_application_get_actions_for_accel           (GtkApplication       *application,
                                                                  const char           *accel);
127

128

Matthias Clasen's avatar
Matthias Clasen committed
129
GDK_AVAILABLE_IN_ALL
130
void             gtk_application_set_accels_for_action           (GtkApplication       *application,
Benjamin Otte's avatar
Benjamin Otte committed
131
132
                                                                  const char           *detailed_action_name,
                                                                  const char * const  *accels);
133

Matthias Clasen's avatar
Matthias Clasen committed
134
GDK_AVAILABLE_IN_ALL
135
GMenu *          gtk_application_get_menu_by_id                  (GtkApplication       *application,
Benjamin Otte's avatar
Benjamin Otte committed
136
                                                                  const char           *id);
137

138
139
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkApplication, g_object_unref)

Matthias Clasen's avatar
Matthias Clasen committed
140
141
142
G_END_DECLS

#endif /* __GTK_APPLICATION_H__ */