gtk2/gtk/gtkapplication.h
Matthias Clasen 91f7b9663f gtk: Clean up docs syntax
Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-22 17:25:26 -04:00

143 lines
5.8 KiB
C

/*
* Copyright © 2010 Codethink Limited
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the licence, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Author: Ryan Lortie <desrt@desrt.ca>
*/
#ifndef __GTK_APPLICATION_H__
#define __GTK_APPLICATION_H__
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#include <gtk/gtkwidget.h>
#include <gio/gio.h>
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
{
GApplication parent_instance;
};
/**
* GtkApplicationClass:
* @parent_class: The parent class.
* @window_added: Signal emitted when a `GtkWindow` is added to
* application through gtk_application_add_window().
* @window_removed: Signal emitted when a `GtkWindow` is removed from
* application, either as a side-effect of being destroyed or
* explicitly through gtk_application_remove_window().
*/
struct _GtkApplicationClass
{
GApplicationClass parent_class;
/*< public >*/
void (*window_added) (GtkApplication *application,
GtkWindow *window);
void (*window_removed) (GtkApplication *application,
GtkWindow *window);
/*< private >*/
gpointer padding[8];
};
GDK_AVAILABLE_IN_ALL
GType gtk_application_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
GtkApplication * gtk_application_new (const char *application_id,
GApplicationFlags flags);
GDK_AVAILABLE_IN_ALL
void gtk_application_add_window (GtkApplication *application,
GtkWindow *window);
GDK_AVAILABLE_IN_ALL
void gtk_application_remove_window (GtkApplication *application,
GtkWindow *window);
GDK_AVAILABLE_IN_ALL
GList * gtk_application_get_windows (GtkApplication *application);
GDK_AVAILABLE_IN_ALL
GMenuModel * gtk_application_get_menubar (GtkApplication *application);
GDK_AVAILABLE_IN_ALL
void gtk_application_set_menubar (GtkApplication *application,
GMenuModel *menubar);
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;
GDK_AVAILABLE_IN_ALL
guint gtk_application_inhibit (GtkApplication *application,
GtkWindow *window,
GtkApplicationInhibitFlags flags,
const char *reason);
GDK_AVAILABLE_IN_ALL
void gtk_application_uninhibit (GtkApplication *application,
guint cookie);
GDK_AVAILABLE_IN_ALL
GtkWindow * gtk_application_get_window_by_id (GtkApplication *application,
guint id);
GDK_AVAILABLE_IN_ALL
GtkWindow * gtk_application_get_active_window (GtkApplication *application);
GDK_AVAILABLE_IN_ALL
char ** gtk_application_list_action_descriptions (GtkApplication *application);
GDK_AVAILABLE_IN_ALL
char ** gtk_application_get_accels_for_action (GtkApplication *application,
const char *detailed_action_name);
GDK_AVAILABLE_IN_ALL
char ** gtk_application_get_actions_for_accel (GtkApplication *application,
const char *accel);
GDK_AVAILABLE_IN_ALL
void gtk_application_set_accels_for_action (GtkApplication *application,
const char *detailed_action_name,
const char * const *accels);
GDK_AVAILABLE_IN_ALL
GMenu * gtk_application_get_menu_by_id (GtkApplication *application,
const char *id);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkApplication, g_object_unref)
G_END_DECLS
#endif /* __GTK_APPLICATION_H__ */