polkitsubject.h 4.37 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * 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>
 */

22 23 24 25
#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

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
#ifndef __POLKIT_SUBJECT_H
#define __POLKIT_SUBJECT_H

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

G_BEGIN_DECLS

#define POLKIT_TYPE_SUBJECT         (polkit_subject_get_type())
#define POLKIT_SUBJECT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), POLKIT_TYPE_SUBJECT, PolkitSubject))
#define POLKIT_IS_SUBJECT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), POLKIT_TYPE_SUBJECT))
#define POLKIT_SUBJECT_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), POLKIT_TYPE_SUBJECT, PolkitSubjectIface))

#if 0
David Zeuthen's avatar
David Zeuthen committed
41 42 43 44 45
/**
 * PolkitSubject:
 *
 * Generic type for all objects that can be used as subjects.
 */
46 47 48 49
typedef struct _PolkitSubject PolkitSubject; /* Dummy typedef */
#endif
typedef struct _PolkitSubjectIface PolkitSubjectIface;

David Zeuthen's avatar
David Zeuthen committed
50 51 52 53 54 55 56
/**
 * PolkitSubjectIface:
 * @parent_iface: The parent interface.
 * @hash: Gets a hash value for a #PolkitSubject.
 * @equal: Checks if two #PolkitSubject<!-- -->s are equal.
 * @to_string: Serializes a #PolkitSubject to a string that can be
 * used in polkit_subject_from_string().
57 58 59
 * @exists: Asynchronously check if a #PolkitSubject exists.
 * @exists_finish: Finishes checking if a #PolkitSubject exists.
 * @exists_sync: Synchronously check if a #PolkitSubject exists.
David Zeuthen's avatar
David Zeuthen committed
60 61 62
 *
 * An interface for subjects.
 */
63 64 65 66
struct _PolkitSubjectIface
{
  GTypeInterface parent_iface;

67
  guint    (*hash)          (PolkitSubject       *subject);
68

69 70
  gboolean (*equal)         (PolkitSubject       *a,
                             PolkitSubject       *b);
71

72 73 74 75 76 77 78 79 80 81 82 83 84 85
  gchar *  (*to_string)     (PolkitSubject       *subject);

  void     (*exists)        (PolkitSubject       *subject,
                             GCancellable        *cancellable,
                             GAsyncReadyCallback  callback,
                             gpointer             user_data);

  gboolean (*exists_finish) (PolkitSubject       *subject,
                             GAsyncResult        *res,
                             GError             **error);

  gboolean (*exists_sync)   (PolkitSubject       *subject,
                             GCancellable        *cancellable,
                             GError             **error);
86 87
};

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
GType          polkit_subject_get_type      (void) G_GNUC_CONST;
guint          polkit_subject_hash          (PolkitSubject       *subject);
gboolean       polkit_subject_equal         (PolkitSubject       *a,
                                             PolkitSubject       *b);
gchar         *polkit_subject_to_string     (PolkitSubject       *subject);
PolkitSubject *polkit_subject_from_string   (const gchar         *str,
                                             GError             **error);
void           polkit_subject_exists        (PolkitSubject       *subject,
                                             GCancellable        *cancellable,
                                             GAsyncReadyCallback  callback,
                                             gpointer             user_data);
gboolean       polkit_subject_exists_finish (PolkitSubject       *subject,
                                             GAsyncResult        *res,
                                             GError             **error);
gboolean       polkit_subject_exists_sync   (PolkitSubject       *subject,
                                             GCancellable        *cancellable,
                                             GError             **error);
105 106 107 108

G_END_DECLS

#endif /* __POLKIT_SUBJECT_H */