luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-19 16:56:15 +02:00
Code Issues Packages Projects Releases Wiki Activity
wip/antoniof/g-set-str-documentation
glib/gio/gactiongroup.h

164 lines
9.0 KiB
C
Raw Permalink Normal View History

add GActionGroup base class
2010-08-18 06:30:44 +02:00
/*
* Copyright © 2010 Codethink Limited
*
gio: Add SPDX license headers automatically Add SPDX license (but not copyright) headers to all files which follow a certain pattern in their existing non-machine-readable header comment. This commit was entirely generated using the command: ``` git ls-files gio/*.[ch] | xargs perl -0777 -pi -e 's/\n \*\n \* This library is free software; you can redistribute it and\/or\n \* modify it under the terms of the GNU Lesser General Public/\n \*\n \* SPDX-License-Identifier: LGPL-2.1-or-later\n \*\n \* This library is free software; you can redistribute it and\/or\n \* modify it under the terms of the GNU Lesser General Public/igs' ``` Signed-off-by: Philip Withnall <pwithnall@endlessos.org> Helps: #1415
2022-05-18 10:12:45 +02:00
* SPDX-License-Identifier: LGPL-2.1-or-later
*
gio/: LGPLv2+ -> LGPLv2.1+ Sub-directories inside gio/ already processed in a previous commit: - fam/ - gdbus-2.0/ (which contains only codegen/) - gvdb/ - inotify/ - tests/ - win32/ - xdgmime/ Other sub-directories inside gio/: - completion/: no license headers - kqueue/: not LGPL, BSD-style license https://bugzilla.gnome.org/show_bug.cgi?id=776504
2017-05-27 18:21:30 +02:00
* 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.1 of the License, or (at your option) any later version.
add GActionGroup base class
2010-08-18 06:30:44 +02:00
*
* 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
Updated FSF's address
2014-01-23 12:58:29 +01:00
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
add GActionGroup base class
2010-08-18 06:30:44 +02:00
*
* Authors: Ryan Lortie <desrt@desrt.ca>
*/
Move single-include guards inside include guards gcc has optimizations for include guards that only work if they are outermost in the the header. https://bugzilla.gnome.org/show_bug.cgi?id=689810
2012-12-28 05:43:14 +01:00
#ifndef __G_ACTION_GROUP_H__
#define __G_ACTION_GROUP_H__
add GActionGroup base class
2010-08-18 06:30:44 +02:00
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
#include <gio/giotypes.h>
G_BEGIN_DECLS
Implement (untested) GApplication actions support
2010-10-25 20:32:07 +02:00
#define G_TYPE_ACTION_GROUP (g_action_group_get_type ())
#define G_ACTION_GROUP(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
G_TYPE_ACTION_GROUP, GActionGroup))
#define G_IS_ACTION_GROUP(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
G_TYPE_ACTION_GROUP))
#define G_ACTION_GROUP_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), \
G_TYPE_ACTION_GROUP, GActionGroupInterface))
GActionGroup is now an interface - make GAction.get_state() return a reference - fix some leaks/warnings in the tests - fix signal propagation in GSimpleActionGroup
2010-08-30 17:31:06 +02:00
typedef struct _GActionGroupInterface GActionGroupInterface;
add GActionGroup base class
2010-08-18 06:30:44 +02:00
GActionGroup is now an interface - make GAction.get_state() return a reference - fix some leaks/warnings in the tests - fix signal propagation in GSimpleActionGroup
2010-08-30 17:31:06 +02:00
struct _GActionGroupInterface
add GActionGroup base class
2010-08-18 06:30:44 +02:00
{
GActionGroup is now an interface - make GAction.get_state() return a reference - fix some leaks/warnings in the tests - fix signal propagation in GSimpleActionGroup
2010-08-30 17:31:06 +02:00
GTypeInterface g_iface;
add GActionGroup base class
2010-08-18 06:30:44 +02:00
/* virtual functions */
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
gboolean (* has_action) (GActionGroup *action_group,
const gchar *action_name);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
gchar ** (* list_actions) (GActionGroup *action_group);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
gboolean (* get_action_enabled) (GActionGroup *action_group,
const gchar *action_name);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
const GVariantType * (* get_action_parameter_type) (GActionGroup *action_group,
const gchar *action_name);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
const GVariantType * (* get_action_state_type) (GActionGroup *action_group,
const gchar *action_name);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
GVariant * (* get_action_state_hint) (GActionGroup *action_group,
const gchar *action_name);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
GVariant * (* get_action_state) (GActionGroup *action_group,
const gchar *action_name);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
void (* change_action_state) (GActionGroup *action_group,
const gchar *action_name,
GVariant *value);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
void (* activate_action) (GActionGroup *action_group,
const gchar *action_name,
GVariant *parameter);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
/* signals */
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
void (* action_added) (GActionGroup *action_group,
const gchar *action_name);
void (* action_removed) (GActionGroup *action_group,
const gchar *action_name);
void (* action_enabled_changed) (GActionGroup *action_group,
const gchar *action_name,
gboolean enabled);
Implement (untested) GApplication actions support
2010-10-25 20:32:07 +02:00
void (* action_state_changed) (GActionGroup *action_group,
const gchar *action_name,
[gi] Fix parameter name typos in Gio docstrings Found by GIR compiler when building gobject-introspection: gir/gio-2.0.c:33525: Warning: Gio: g_tls_password_set_description: unknown parameter 'flags' in documentation comment, should be one of 'password', 'description' gir/gio-2.0.c:14568: Warning: Gio: g_action_group_action_state_changed: unknown parameter 'state' in documentation comment, should be one of 'action_group', 'action_name', 'value'
2011-08-11 11:05:31 +02:00
GVariant *state);
Add g_action_group_query_action() This new API allows requesting multiple pieces of information about a particular action in one go and also simplifies the burden for GActionGroup implementations -- they need not implement all the separate APIs now.
2011-11-25 01:52:48 +01:00
/* more virtual functions */
gboolean (* query_action) (GActionGroup *action_group,
const gchar *action_name,
gboolean *enabled,
const GVariantType **parameter_type,
const GVariantType **state_type,
GVariant **state_hint,
GVariant **state);
add GActionGroup base class
2010-08-18 06:30:44 +02:00
};
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
add GActionGroup base class
2010-08-18 06:30:44 +02:00
GType g_action_group_get_type (void) G_GNUC_CONST;
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
add GActionGroup base class
2010-08-18 06:30:44 +02:00
gboolean g_action_group_has_action (GActionGroup *action_group,
const gchar *action_name);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
add GActionGroup base class
2010-08-18 06:30:44 +02:00
gchar ** g_action_group_list_actions (GActionGroup *action_group);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
const GVariantType * g_action_group_get_action_parameter_type (GActionGroup *action_group,
add GActionGroup base class
2010-08-18 06:30:44 +02:00
const gchar *action_name);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
const GVariantType * g_action_group_get_action_state_type (GActionGroup *action_group,
add GActionGroup base class
2010-08-18 06:30:44 +02:00
const gchar *action_name);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
GVariant * g_action_group_get_action_state_hint (GActionGroup *action_group,
add GActionGroup base class
2010-08-18 06:30:44 +02:00
const gchar *action_name);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
gboolean g_action_group_get_action_enabled (GActionGroup *action_group,
add GActionGroup base class
2010-08-18 06:30:44 +02:00
const gchar *action_name);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
GVariant * g_action_group_get_action_state (GActionGroup *action_group,
add GActionGroup base class
2010-08-18 06:30:44 +02:00
const gchar *action_name);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
void g_action_group_change_action_state (GActionGroup *action_group,
add GActionGroup base class
2010-08-18 06:30:44 +02:00
const gchar *action_name,
GVariant *value);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
Rename methods on GActionGroup to include 'action' Makes explicit the fact that you are interacting with the individual action rather than the group and removes potential namespace conflicts with classes implementing the interface (like g_application_activate() vs g_application_activate_action()).
2010-10-11 16:45:51 +02:00
void g_action_group_activate_action (GActionGroup *action_group,
add GActionGroup base class
2010-08-18 06:30:44 +02:00
const gchar *action_name,
GVariant *parameter);
/* signals */
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
add GActionGroup base class
2010-08-18 06:30:44 +02:00
void g_action_group_action_added (GActionGroup *action_group,
const gchar *action_name);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
add GActionGroup base class
2010-08-18 06:30:44 +02:00
void g_action_group_action_removed (GActionGroup *action_group,
const gchar *action_name);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
add GActionGroup base class
2010-08-18 06:30:44 +02:00
void g_action_group_action_enabled_changed (GActionGroup *action_group,
const gchar *action_name,
gboolean enabled);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_ALL
add GActionGroup base class
2010-08-18 06:30:44 +02:00
void g_action_group_action_state_changed (GActionGroup *action_group,
const gchar *action_name,
GVariant *state);
Rename all visibility macros
2022-10-05 19:39:21 +02:00
GIO_AVAILABLE_IN_2_32
Add g_action_group_query_action() This new API allows requesting multiple pieces of information about a particular action in one go and also simplifies the burden for GActionGroup implementations -- they need not implement all the separate APIs now.
2011-11-25 01:52:48 +01:00
gboolean g_action_group_query_action (GActionGroup *action_group,
const gchar *action_name,
gboolean *enabled,
const GVariantType **parameter_type,
const GVariantType **state_type,
GVariant **state_hint,
actiongroup: Add a compiler warning Warn when the boolean return isn't used, since we may not initialize the out arguments in the FALSE case. Update all internal callers to use the return value. They were already safe, but users outside GLib may not be.
2023-04-07 14:12:06 +02:00
GVariant **state) G_GNUC_WARN_UNUSED_RESULT;
Add g_action_group_query_action() This new API allows requesting multiple pieces of information about a particular action in one go and also simplifies the burden for GActionGroup implementations -- they need not implement all the separate APIs now.
2011-11-25 01:52:48 +01:00
add GActionGroup base class
2010-08-18 06:30:44 +02:00
G_END_DECLS
#endif /* __G_ACTION_GROUP_H__ */
Reference in New Issue Copy Permalink