obt/linkbase.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    obt/linkbase.h for the Openbox window manager
   4    Copyright (c) 2010        Dana Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #ifndef __obt_linkbase_h
  20 #define __obt_linkbase_h
  21
  22 struct _ObtPaths;
  23
  24 #include <glib.h>
  25
  26 G_BEGIN_DECLS
  27
  28 struct _ObtLink;
  29
  30 typedef struct _ObtLinkBase ObtLinkBase;
  31
  32 typedef enum {
  33     OBT_LINKBASE_ADDED,
  34     OBT_LINKBASE_REMOVED,
  35 } ObtLinkBaseUpdateType;
  36
  37 typedef void (*ObtLinkBaseUpdateFunc)(ObtLinkBase *lb,
  38                                       ObtLinkBaseUpdateType type,
  39                                       struct _ObtLink *link,
  40                                       gpointer data);
  41
  42 /*! Create a new database of ObtLinks.
  43   @param paths An ObtPaths structure.
  44   @param locale The value of LC_MESSAGES.
  45   @param environments A bitflag of values from ObtLinkEnvFlags indicating
  46     which environments are to be considered active.
  47 */
  48 ObtLinkBase* obt_linkbase_new(struct _ObtPaths *paths, const gchar *locale,
  49                               guint environments);
  50 void obt_linkbase_ref(ObtLinkBase *lb);
  51 void obt_linkbase_unref(ObtLinkBase *lb);
  52
  53 void obt_linkbase_set_update_func(ObtLinkBase *lb, ObtLinkBaseUpdateFunc func,
  54                                   gpointer data);
  55
  56 /*! Returns a list of all known ObtLink* which belong in the given category. */
  57 GSList *obt_linkbase_category(ObtLinkBase *lb, GQuark category);
  58
  59 G_END_DECLS
  60
  61 #endif