src/io-desktop/fma-desktop-file.h

   1 /*
   2  * FileManager-Actions
   3  * A file-manager extension which offers configurable context menu actions.
   4  *
   5  * Copyright (C) 2005 The GNOME Foundation
   6  * Copyright (C) 2006-2008 Frederic Ruaudel and others (see AUTHORS)
   7  * Copyright (C) 2009-2015 Pierre Wieser and others (see AUTHORS)
   8  *
   9  * FileManager-Actions is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * FileManager-Actions is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with FileManager-Actions; see the file COPYING. If not, see
  21  * <http://www.gnu.org/licenses/>.
  22  *
  23  * Authors:
  24  *   Frederic Ruaudel <grumz@grumz.net>
  25  *   Rodrigo Moya <rodrigo@gnome-db.org>
  26  *   Pierre Wieser <pwieser@trychlos.org>
  27  *   ... and many others (see AUTHORS)
  28  */
  29
  30 #ifndef __IO_DESKTOP_FMA_DESKTOP_FILE_H__
  31 #define __IO_DESKTOP_FMA_DESKTOP_FILE_H__
  32
  33 /**
  34  * SECTION: fma_desktop_file
  35  * @short_description: #FMADesktopFile class definition.
  36  * @include: fma-desktop-file.h
  37  *
  38  * This class encapŝulates the EggDesktopFile structure, adding some
  39  * private properties. An instance of this class is associated with
  40  * every #FMAObjectItem for this provider.
  41  */
  42
  43 #include <glib-object.h>
  44
  45 G_BEGIN_DECLS
  46
  47 #define FMA_TYPE_DESKTOP_FILE                ( fma_desktop_file_get_type())
  48 #define FMA_DESKTOP_FILE( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, FMA_TYPE_DESKTOP_FILE, FMADesktopFile ))
  49 #define FMA_DESKTOP_FILE_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, FMA_TYPE_DESKTOP_FILE, FMADesktopFileClass ))
  50 #define FMA_IS_DESKTOP_FILE( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, FMA_TYPE_DESKTOP_FILE ))
  51 #define FMA_IS_DESKTOP_FILE_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), FMA_TYPE_DESKTOP_FILE ))
  52 #define FMA_DESKTOP_FILE_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), FMA_TYPE_DESKTOP_FILE, FMADesktopFileClass ))
  53
  54 typedef struct _FMADesktopFilePrivate        FMADesktopFilePrivate;
  55
  56 typedef struct {
  57         /*< private >*/
  58         GObject                parent;
  59         FMADesktopFilePrivate *private;
  60 }
  61         FMADesktopFile;
  62
  63 typedef struct _FMADesktopFileClassPrivate   FMADesktopFileClassPrivate;
  64
  65 typedef struct {
  66         /*< private >*/
  67         GObjectClass                parent;
  68         FMADesktopFileClassPrivate *private;
  69 }
  70         FMADesktopFileClass;
  71
  72 /* standard suffix for desktop files
  73  */
  74 #define FMA_DESKTOP_FILE_SUFFIX         ".desktop"
  75
  76 GType           fma_desktop_file_get_type         ( void );
  77
  78 FMADesktopFile *fma_desktop_file_new              ( void );
  79 FMADesktopFile *fma_desktop_file_new_from_path    ( const gchar *path );
  80 FMADesktopFile *fma_desktop_file_new_from_uri     ( const gchar *uri );
  81 FMADesktopFile *fma_desktop_file_new_for_write    ( const gchar *path );
  82
  83 GKeyFile       *fma_desktop_file_get_key_file     ( const FMADesktopFile *ndf );
  84 gchar          *fma_desktop_file_get_key_file_uri ( const FMADesktopFile *ndf );
  85 gboolean        fma_desktop_file_write            ( FMADesktopFile *ndf );
  86
  87 gchar          *fma_desktop_file_get_file_type    ( const FMADesktopFile *ndf );
  88 gchar          *fma_desktop_file_get_id           ( const FMADesktopFile *ndf );
  89 GSList         *fma_desktop_file_get_profiles     ( const FMADesktopFile *ndf );
  90
  91 gboolean        fma_desktop_file_has_profile      ( const FMADesktopFile *ndf, const gchar *profile_id );
  92
  93 void            fma_desktop_file_remove_key       ( const FMADesktopFile *ndf, const gchar *group, const gchar *key );
  94 void            fma_desktop_file_remove_profile   ( const FMADesktopFile *ndf, const gchar *profile_id );
  95
  96 gboolean        fma_desktop_file_get_boolean      ( const FMADesktopFile *ndf, const gchar *group, const gchar *key, gboolean *key_found, gboolean default_value );
  97 gchar          *fma_desktop_file_get_locale_string( const FMADesktopFile *ndf, const gchar *group, const gchar *key, gboolean *key_found, const gchar *default_value );
  98 gchar          *fma_desktop_file_get_string       ( const FMADesktopFile *ndf, const gchar *group, const gchar *key, gboolean *key_found, const gchar *default_value );
  99 GSList         *fma_desktop_file_get_string_list  ( const FMADesktopFile *ndf, const gchar *group, const gchar *key, gboolean *key_found, const gchar *default_value );
 100 guint           fma_desktop_file_get_uint         ( const FMADesktopFile *ndf, const gchar *group, const gchar *key, gboolean *key_found, guint default_value );
 101
 102 void            fma_desktop_file_set_boolean      ( const FMADesktopFile *ndf, const gchar *group, const gchar *key, gboolean value );
 103 void            fma_desktop_file_set_locale_string( const FMADesktopFile *ndf, const gchar *group, const gchar *key, const gchar *value );
 104 void            fma_desktop_file_set_string       ( const FMADesktopFile *ndf, const gchar *group, const gchar *key, const gchar *value );
 105 void            fma_desktop_file_set_string_list  ( const FMADesktopFile *ndf, const gchar *group, const gchar *key, GSList *value );
 106 void            fma_desktop_file_set_uint         ( const FMADesktopFile *ndf, const gchar *group, const gchar *key, guint value );
 107
 108 G_END_DECLS
 109
 110 #endif /* __IO_DESKTOP_FMA_DESKTOP_FILE_H__ */