epoc32/include/stdapis/glib-2.0/glib/gkeyfile.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/* gkeyfile.h - desktop entry file parser
williamr@2
     2
 *
williamr@2
     3
 *  Copyright 2004 Red Hat, Inc.
williamr@2
     4
 *
williamr@2
     5
 *  Ray Strode <halfline@hawaii.rr.com>
williamr@2
     6
 * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
williamr@2
     7
 *
williamr@2
     8
 * GLib is free software; you can redistribute it and/or modify it
williamr@2
     9
 * under the terms of the GNU Lesser General Public License as
williamr@2
    10
 * published by the Free Software Foundation; either version 2 of the
williamr@2
    11
 * License, or (at your option) any later version.
williamr@2
    12
 *
williamr@2
    13
 * GLib is distributed in the hope that it will be useful,
williamr@2
    14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
williamr@2
    15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
williamr@2
    16
 * Lesser General Public License for more details.
williamr@2
    17
 *
williamr@2
    18
 * You should have received a copy of the GNU Lesser General Public
williamr@2
    19
 * License along with GLib; see the file COPYING.LIB.  If not,
williamr@2
    20
 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
williamr@2
    21
 *   Boston, MA 02111-1307, USA.
williamr@2
    22
 */
williamr@2
    23
williamr@2
    24
#ifndef __G_KEY_FILE_H__
williamr@2
    25
#define __G_KEY_FILE_H__
williamr@2
    26
williamr@2
    27
#include <_ansi.h>
williamr@2
    28
#include <glib/gerror.h>
williamr@2
    29
williamr@2
    30
G_BEGIN_DECLS
williamr@2
    31
williamr@2
    32
typedef enum
williamr@2
    33
{
williamr@2
    34
  G_KEY_FILE_ERROR_UNKNOWN_ENCODING,
williamr@2
    35
  G_KEY_FILE_ERROR_PARSE,
williamr@2
    36
  G_KEY_FILE_ERROR_NOT_FOUND,
williamr@2
    37
  G_KEY_FILE_ERROR_KEY_NOT_FOUND,
williamr@2
    38
  G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
williamr@2
    39
  G_KEY_FILE_ERROR_INVALID_VALUE
williamr@2
    40
} GKeyFileError;
williamr@2
    41
williamr@2
    42
#define G_KEY_FILE_ERROR g_key_file_error_quark()
williamr@2
    43
williamr@2
    44
IMPORT_C GQuark g_key_file_error_quark (void);
williamr@2
    45
williamr@2
    46
typedef struct _GKeyFile GKeyFile;
williamr@2
    47
williamr@2
    48
typedef enum
williamr@2
    49
{
williamr@2
    50
  G_KEY_FILE_NONE              = 0,
williamr@2
    51
  G_KEY_FILE_KEEP_COMMENTS     = 1 << 0,
williamr@2
    52
  G_KEY_FILE_KEEP_TRANSLATIONS = 1 << 1
williamr@2
    53
} GKeyFileFlags;
williamr@2
    54
williamr@2
    55
IMPORT_C GKeyFile *g_key_file_new                    (void);
williamr@2
    56
IMPORT_C void      g_key_file_free                   (GKeyFile             *key_file);
williamr@2
    57
IMPORT_C void      g_key_file_set_list_separator     (GKeyFile             *key_file,
williamr@2
    58
					     gchar                 separator);
williamr@2
    59
IMPORT_C gboolean  g_key_file_load_from_file         (GKeyFile             *key_file,
williamr@2
    60
					     const gchar          *file,
williamr@2
    61
					     GKeyFileFlags         flags,
williamr@2
    62
					     GError              **error);
williamr@2
    63
IMPORT_C gboolean  g_key_file_load_from_data         (GKeyFile             *key_file,
williamr@2
    64
					     const gchar          *data,
williamr@2
    65
					     gsize                 length,
williamr@2
    66
					     GKeyFileFlags         flags,
williamr@2
    67
					     GError              **error);
williamr@2
    68
IMPORT_C gboolean g_key_file_load_from_data_dirs    (GKeyFile             *key_file,
williamr@2
    69
					     const gchar          *file,
williamr@2
    70
					     gchar               **full_path,
williamr@2
    71
					     GKeyFileFlags         flags,
williamr@2
    72
					     GError              **error);
williamr@2
    73
IMPORT_C gchar    *g_key_file_to_data                (GKeyFile             *key_file,
williamr@2
    74
					     gsize                *length,
williamr@2
    75
					     GError              **error) G_GNUC_MALLOC;
williamr@2
    76
IMPORT_C gchar    *g_key_file_get_start_group        (GKeyFile             *key_file) G_GNUC_MALLOC;
williamr@2
    77
IMPORT_C gchar   **g_key_file_get_groups             (GKeyFile             *key_file,
williamr@2
    78
					     gsize                *length) G_GNUC_MALLOC;
williamr@2
    79
IMPORT_C gchar   **g_key_file_get_keys               (GKeyFile             *key_file,
williamr@2
    80
					     const gchar          *group_name,
williamr@2
    81
					     gsize                *length,
williamr@2
    82
					     GError              **error) G_GNUC_MALLOC;
williamr@2
    83
IMPORT_C gboolean  g_key_file_has_group              (GKeyFile             *key_file,
williamr@2
    84
					     const gchar          *group_name);
williamr@2
    85
IMPORT_C gboolean  g_key_file_has_key                (GKeyFile             *key_file,
williamr@2
    86
					     const gchar          *group_name,
williamr@2
    87
					     const gchar          *key,
williamr@2
    88
					     GError              **error);
williamr@2
    89
IMPORT_C gchar    *g_key_file_get_value              (GKeyFile             *key_file,
williamr@2
    90
					     const gchar          *group_name,
williamr@2
    91
					     const gchar          *key,
williamr@2
    92
					     GError              **error) G_GNUC_MALLOC;
williamr@2
    93
IMPORT_C void      g_key_file_set_value              (GKeyFile             *key_file,
williamr@2
    94
					     const gchar          *group_name,
williamr@2
    95
					     const gchar          *key,
williamr@2
    96
					     const gchar          *value);
williamr@2
    97
IMPORT_C gchar    *g_key_file_get_string             (GKeyFile             *key_file,
williamr@2
    98
					     const gchar          *group_name,
williamr@2
    99
					     const gchar          *key,
williamr@2
   100
					     GError              **error) G_GNUC_MALLOC;
williamr@2
   101
IMPORT_C void      g_key_file_set_string             (GKeyFile             *key_file,
williamr@2
   102
					     const gchar          *group_name,
williamr@2
   103
					     const gchar          *key,
williamr@2
   104
					     const gchar          *string);
williamr@2
   105
IMPORT_C gchar    *g_key_file_get_locale_string      (GKeyFile             *key_file,
williamr@2
   106
					     const gchar          *group_name,
williamr@2
   107
					     const gchar          *key,
williamr@2
   108
					     const gchar          *locale,
williamr@2
   109
					     GError              **error) G_GNUC_MALLOC;
williamr@2
   110
IMPORT_C void      g_key_file_set_locale_string      (GKeyFile             *key_file,
williamr@2
   111
					     const gchar          *group_name,
williamr@2
   112
					     const gchar          *key,
williamr@2
   113
					     const gchar          *locale,
williamr@2
   114
					     const gchar          *string);
williamr@2
   115
IMPORT_C gboolean  g_key_file_get_boolean            (GKeyFile             *key_file,
williamr@2
   116
					     const gchar          *group_name,
williamr@2
   117
					     const gchar          *key,
williamr@2
   118
					     GError              **error);
williamr@2
   119
IMPORT_C void      g_key_file_set_boolean            (GKeyFile             *key_file,
williamr@2
   120
					     const gchar          *group_name,
williamr@2
   121
					     const gchar          *key,
williamr@2
   122
					     gboolean              value);
williamr@2
   123
IMPORT_C gint      g_key_file_get_integer            (GKeyFile             *key_file,
williamr@2
   124
					     const gchar          *group_name,
williamr@2
   125
					     const gchar          *key,
williamr@2
   126
					     GError              **error);
williamr@2
   127
IMPORT_C void      g_key_file_set_integer            (GKeyFile             *key_file,
williamr@2
   128
					     const gchar          *group_name,
williamr@2
   129
					     const gchar          *key,
williamr@2
   130
					     gint                  value);
williamr@2
   131
IMPORT_C gchar   **g_key_file_get_string_list        (GKeyFile             *key_file,
williamr@2
   132
					     const gchar          *group_name,
williamr@2
   133
					     const gchar          *key,
williamr@2
   134
					     gsize                *length,
williamr@2
   135
					     GError              **error) G_GNUC_MALLOC;
williamr@2
   136
IMPORT_C void      g_key_file_set_string_list        (GKeyFile             *key_file,
williamr@2
   137
					     const gchar          *group_name,
williamr@2
   138
					     const gchar          *key,
williamr@2
   139
					     const gchar * const   list[],
williamr@2
   140
					     gsize                 length);
williamr@2
   141
IMPORT_C gchar   **g_key_file_get_locale_string_list (GKeyFile             *key_file,
williamr@2
   142
					     const gchar          *group_name,
williamr@2
   143
					     const gchar          *key,
williamr@2
   144
					     const gchar          *locale,
williamr@2
   145
					     gsize                *length,
williamr@2
   146
					     GError              **error) G_GNUC_MALLOC;
williamr@2
   147
IMPORT_C void      g_key_file_set_locale_string_list (GKeyFile             *key_file,
williamr@2
   148
					     const gchar          *group_name,
williamr@2
   149
					     const gchar          *key,
williamr@2
   150
					     const gchar          *locale,
williamr@2
   151
					     const gchar * const   list[],
williamr@2
   152
					     gsize                 length);
williamr@2
   153
IMPORT_C gboolean *g_key_file_get_boolean_list       (GKeyFile             *key_file,
williamr@2
   154
					     const gchar          *group_name,
williamr@2
   155
					     const gchar          *key,
williamr@2
   156
					     gsize                *length,
williamr@2
   157
					     GError              **error) G_GNUC_MALLOC;
williamr@2
   158
IMPORT_C void      g_key_file_set_boolean_list       (GKeyFile             *key_file,
williamr@2
   159
					     const gchar          *group_name,
williamr@2
   160
					     const gchar          *key,
williamr@2
   161
					     gboolean              list[],
williamr@2
   162
					     gsize                 length);
williamr@2
   163
IMPORT_C gint     *g_key_file_get_integer_list       (GKeyFile             *key_file,
williamr@2
   164
					     const gchar          *group_name,
williamr@2
   165
					     const gchar          *key,
williamr@2
   166
					     gsize                *length,
williamr@2
   167
					     GError              **error) G_GNUC_MALLOC;
williamr@2
   168
IMPORT_C void      g_key_file_set_integer_list       (GKeyFile             *key_file,
williamr@2
   169
					     const gchar          *group_name,
williamr@2
   170
					     const gchar          *key,
williamr@2
   171
					     gint                  list[],
williamr@2
   172
					     gsize                 length);
williamr@2
   173
IMPORT_C void      g_key_file_set_comment            (GKeyFile             *key_file,
williamr@2
   174
                                             const gchar          *group_name,
williamr@2
   175
                                             const gchar          *key,
williamr@2
   176
                                             const gchar          *comment,
williamr@2
   177
                                             GError              **error);
williamr@2
   178
IMPORT_C gchar    *g_key_file_get_comment            (GKeyFile             *key_file,
williamr@2
   179
                                             const gchar          *group_name,
williamr@2
   180
                                             const gchar          *key,
williamr@2
   181
                                             GError              **error) G_GNUC_MALLOC;
williamr@2
   182
williamr@2
   183
IMPORT_C void      g_key_file_remove_comment         (GKeyFile             *key_file,
williamr@2
   184
                                             const gchar          *group_name,
williamr@2
   185
                                             const gchar          *key,
williamr@2
   186
					     GError              **error);
williamr@2
   187
IMPORT_C void      g_key_file_remove_key             (GKeyFile             *key_file,
williamr@2
   188
					     const gchar          *group_name,
williamr@2
   189
					     const gchar          *key,
williamr@2
   190
					     GError              **error);
williamr@2
   191
IMPORT_C void      g_key_file_remove_group           (GKeyFile             *key_file,
williamr@2
   192
					     const gchar          *group_name,
williamr@2
   193
					     GError              **error);
williamr@2
   194
williamr@2
   195
G_END_DECLS
williamr@2
   196
williamr@2
   197
#endif /* __G_KEY_FILE_H__ */