polkitactiondescription.h 3.87 KB
Newer Older
David Zeuthen's avatar
David Zeuthen committed
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
/*
 * Copyright (C) 2008 Red Hat, Inc.
 *
 * 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 License, 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, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: David Zeuthen <davidz@redhat.com>
 */

#if !defined (_POLKIT_COMPILATION) && !defined(_POLKIT_INSIDE_POLKIT_H)
#error "Only <polkit/polkit.h> can be included directly, this file may disappear or change contents."
#endif

#ifndef __POLKIT_ACTION_DESCRIPTION_H__
#define __POLKIT_ACTION_DESCRIPTION_H__

#include <glib-object.h>
#include <gio/gio.h>

G_BEGIN_DECLS

#define POLKIT_TYPE_ACTION_DESCRIPTION         (polkit_action_description_get_type ())
#define POLKIT_ACTION_DESCRIPTION(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), POLKIT_TYPE_ACTION_DESCRIPTION, PolkitActionDescription))
#define POLKIT_ACTION_DESCRIPTION_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), POLKIT_TYPE_ACTION_DESCRIPTION, PolkitActionDescriptionClass))
#define POLKIT_IS_ACTION_DESCRIPTION(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), POLKIT_TYPE_ACTION_DESCRIPTION))
#define POLKIT_IS_ACTION_DESCRIPTION_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), POLKIT_TYPE_ACTION_DESCRIPTION))
#define POLKIT_ACTION_DESCRIPTION_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), POLKIT_TYPE_ACTION_DESCRIPTION, PolkitActionDescriptionClass))

typedef struct _PolkitActionDescription        PolkitActionDescription;
typedef struct _PolkitActionDescriptionClass   PolkitActionDescriptionClass;
typedef struct _PolkitActionDescriptionPrivate PolkitActionDescriptionPrivate;

struct _PolkitActionDescription
{
47 48
  GObject                         parent_instance;
  PolkitActionDescriptionPrivate *priv;
David Zeuthen's avatar
David Zeuthen committed
49 50 51 52
};

struct _PolkitActionDescriptionClass
{
53
  GObjectClass parent_class;
David Zeuthen's avatar
David Zeuthen committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
};

GType                      polkit_action_description_get_type           (void) G_GNUC_CONST;
GList *                    polkit_action_description_new_from_file      (GFile                    *file,
                                                                         GCancellable             *cancellable,
                                                                         GError                  **error);
GList *                    polkit_action_description_new_from_directory (GFile                    *directory,
                                                                         GCancellable             *cancellable,
                                                                         GError                  **error);
const gchar *              polkit_action_description_get_action_id      (PolkitActionDescription  *action_description);
GIcon *                    polkit_action_description_get_icon           (PolkitActionDescription  *action_description);
const gchar *              polkit_action_description_get_description    (PolkitActionDescription  *action_description);
const gchar *              polkit_action_description_get_message        (PolkitActionDescription  *action_description);
const gchar *              polkit_action_description_get_vendor_name    (PolkitActionDescription  *action_description);
const gchar *              polkit_action_description_get_vendor_url     (PolkitActionDescription  *action_description);
GHashTable *               polkit_action_description_get_annotations    (PolkitActionDescription  *action_description);

G_END_DECLS

#endif /* __POLKIT_ACTION_DESCRIPTION_H__ */