GBookmarkFile

typedef struct _GBookmarkFile GBookmarkFile;

Структура GBookmarkFile содержит только закрытые данные к которым нет прямого доступа.

G_BOOKMARK_FILE_ERROR

#define G_BOOKMARK_FILE_ERROR	(g_bookmark_file_error_quark ())

Домен ошибки для анализатора файла закладок. Ошибки в этом домене из перечисления GBookmarkFileError. Смотрите GError для информации о доменах ошибки.

enum GBookmarkFileError

typedef enum
{
  G_BOOKMARK_FILE_ERROR_INVALID_URI,
  G_BOOKMARK_FILE_ERROR_INVALID_VALUE,
  G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED,
  G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND,
  G_BOOKMARK_FILE_ERROR_READ,
  G_BOOKMARK_FILE_ERROR_UNKNOWN_ENCODING,
  G_BOOKMARK_FILE_ERROR_WRITE,
  G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND
} GBookmarkFileError;

Коды ошибок возвращаемые анализатором файла закладок.

g_bookmark_file_new ()

GBookmarkFile* g_bookmark_file_new          (void);

Создаёт новый пустой объект GBookmarkFile.

Используйте g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data() или g_bookmark_file_load_from_data_dirs() для чтения существующего файла закладок.

Начиная с версии 2.12

g_bookmark_file_free ()

void        g_bookmark_file_free            (GBookmarkFile *bookmark);

Освобождает GBookmarkFile.

Начиная с версии 2.12

g_bookmark_file_load_from_file ()

gboolean    g_bookmark_file_load_from_file  (GBookmarkFile *bookmark,
                                             const gchar *filename,
                                             GError **error);

Загружает desktop bookmark file в пустую структуру GBookmarkFile. Если файл не загружен, то устанавливается error в GFileError или GBookmarkFileError.

Начиная с версии 2.12

g_bookmark_file_load_from_data ()

gboolean    g_bookmark_file_load_from_data  (GBookmarkFile *bookmark,
                                             const gchar *data,
                                             gsize length,
                                             GError **error);

Загружает файл закладок из памяти в пустую структуру GBookmarkFile. Если объект не создан, то устанавливается error в GBookmarkFileError.

Начиная с версии 2.12

g_bookmark_file_load_from_data_dirs ()

gboolean    g_bookmark_file_load_from_data_dirs
                                            (GBookmarkFile *bookmark,
                                             const gchar *file,
                                             gchar **full_path,
                                             GError **error);

Эта функция находит desktop bookmark file с именем file в пути который возвращает g_get_user_data_dir() и g_get_system_data_dirs(), загружает в файл bookmark и возвращает полный путь файла в full_path. Если файл не загружен, то error устанавливается либо в GFileError, либо в GBookmarkFileError.

Начиная с версии 2.12

g_bookmark_file_to_data ()

gchar*      g_bookmark_file_to_data         (GBookmarkFile *bookmark,
                                             gsize *length,
                                             GError **error);

Эта функция выводит bookmark как строку.

Начиная с версии 2.12

g_bookmark_file_to_file ()

gboolean    g_bookmark_file_to_file         (GBookmarkFile *bookmark,
                                             const gchar *filename,
                                             GError **error);

Эта функция выводит bookmark в файл. Пишущий процесс будет гарантировано атомарным при внутреннем использовании g_file_set_contents().

Начиная с версии 2.12

g_bookmark_file_has_item ()

gboolean    g_bookmark_file_has_item        (GBookmarkFile *bookmark,
                                             const gchar *uri);

Находит имеет ли desktop закладка элемент URI установленный в uri.

Начиная с версии 2.12

g_bookmark_file_has_group ()

gboolean    g_bookmark_file_has_group       (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *group,
                                             GError **error);

Проверяет относится ли group к списку групп к которым принадлежит закладка для uri.

В случае когда URI не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_has_application ()

gboolean    g_bookmark_file_has_application (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *name,
                                             GError **error);

Проверяет имеет ли закладка для uri внутри bookmark регистрацию приложения name.

В случае когда URI не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_get_size ()

gint        g_bookmark_file_get_size        (GBookmarkFile *bookmark);

Определяет количество закладок в bookmark.

Начиная с версии 2.12

g_bookmark_file_get_uris ()

gchar**     g_bookmark_file_get_uris        (GBookmarkFile *bookmark,
                                             gsize *length);

Возвращает все URIs закладок в файле bookmark. Массив возвращаемых URIs будет NULL-завершённый, поэтому length может опционально быть NULL.

Начиная с версии 2.12

g_bookmark_file_get_title ()

gchar*      g_bookmark_file_get_title       (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             GError **error);

Возвращает заголовок закладки для uri.

Если uri это NULL, возвращает заголовок bookmark.

В случае когда URI не найден, возвращает NULL и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_get_description ()

gchar*      g_bookmark_file_get_description (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             GError **error);

Находит описание закладки для uri.

В случае когда URI не найден, возвращает NULL и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_get_mime_type ()

gchar*      g_bookmark_file_get_mime_type   (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             GError **error);

Находит MIME тип источника на который указывает uri.

В случае когда URI не найден, возвращает NULL и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. В случае когда MIME тип не найден, возвращает NULL и устанавливает error в G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

Начиная с версии 2.12

g_bookmark_file_get_is_private ()

gboolean    g_bookmark_file_get_is_private  (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             GError **error);

Определяет установлен ли приватный флаг закладки для uri.

В случае когда URI не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. В случае когда приватный флаг не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

Начиная с версии 2.12

g_bookmark_file_get_icon ()

gboolean    g_bookmark_file_get_icon        (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             gchar **href,
                                             gchar **mime_type,
                                             GError **error);

Определяет значок закладки для uri.

В случае когда URI не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_get_added ()

time_t      g_bookmark_file_get_added       (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             GError **error);

Определяет время добавления закладки для uri в bookmark

В случае когда URI не найден, возвращает -1 и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_get_modified ()

time_t      g_bookmark_file_get_modified    (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             GError **error);

Определяет время последней модификации закладки для uri.

В случае когда URI не найден, возвращает -1 и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_get_visited ()

time_t      g_bookmark_file_get_visited     (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             GError **error);

Определяет время последнего посещения закладки для uri was last visited.

В случае когда URI не найден, возвращает -1 и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_get_groups ()

gchar**     g_bookmark_file_get_groups      (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             gsize *length,
                                             GError **error);

Находит имена групп к которым принадлежит закладка для uri.

В случае когда URI не найден, возвращает NULL и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Возвращаемый массив является NULL-завершённым, поэтому length может опционально быть NULL.

Начиная с версии 2.12

g_bookmark_file_get_applications ()

gchar**     g_bookmark_file_get_applications
                                            (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             gsize *length,
                                             GError **error);

Находит имена приложений которые зарегистрированы закладкой для uri.

В случае когда URI не найден, возвращает NULL и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12

g_bookmark_file_get_app_info ()

gboolean    g_bookmark_file_get_app_info    (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *name,
                                             gchar **exec,
                                             guint *count,
                                             time_t *stamp,
                                             GError **error);

Получает регистрационную информацию app_name закладки для uri. Смотрите g_bookmark_file_set_app_info() для получения информации о возвращаемых данных.

Строка возвращаемая в app_exec должна быть освобождена.

В случае когда URI не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. В случае когда нет приложения с именем app_name зарегистрированного закладкой для uri, возвращает FALSE и устанавливает ошибку в G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.

Начиная с версии 2.12

g_bookmark_file_set_title ()

void        g_bookmark_file_set_title       (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *title);

Устанавливает title как заголовок закладки для uri внутри файла закладок bookmark.

Если uri это NULL, устанавливает заголовок bookmark.

Если закладка для uri не найдена, то она создаётся.

Начиная с версии 2.12

g_bookmark_file_set_description ()

void        g_bookmark_file_set_description (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *description);

Устанавливает description как описание закладки для uri.

Если uri это NULL, устанавливает описание bookmark.

Если закладка для uri не найдена, то она создаётся.

Начиная с версии 2.12

g_bookmark_file_set_mime_type ()

void        g_bookmark_file_set_mime_type   (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *mime_type);

Устанавливает mime_type как MIME тип закладки для uri.

Если закладка для uri не найдена, то она создаётся.

Начиная с версии 2.12

g_bookmark_file_set_is_private ()

void        g_bookmark_file_set_is_private  (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             gboolean is_private);

Устанавливает приватный флаг закладки для uri.

Если закладка для uri не найдена, то она создаётся.

Начиная с версии 2.12

g_bookmark_file_set_icon ()

void        g_bookmark_file_set_icon        (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *href,
                                             const gchar *mime_type);

Устанавливает значок закладки для uri. Если href это NULL, сбрасывает установленный в текущий момент значок.

Если нет найденной закладки для uri, она создаётся.

Начиная с версии 2.12

g_bookmark_file_set_added ()

void        g_bookmark_file_set_added       (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             time_t added);

Устанавливает время добавления закладки для uri в bookmark.

Если нет найденной закладки для uri, то она создаётся.

Начиная с версии 2.12

g_bookmark_file_set_groups ()

void        g_bookmark_file_set_groups      (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar **groups,
                                             gsize length);

Устанавливает список имён групп для элементов с uri. Каждое предварительно установленное имя группы списка удаляется.

Если uri не найден, то элементы для него создаются.

Начиная с версии 2.12

g_bookmark_file_set_modified ()

void        g_bookmark_file_set_modified    (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             time_t modified);

Устанавливает время последнего изменения закладки для uri.

Если закладка для uri не найдена, то она создаётся.

Время изменения закладки должно устанавливаться только когда meta-данные были фактически изменены. Все функции GBookmarkFile которые изменяют закладку также изменяют время модификации, за исключением g_bookmark_file_set_visited().

Начиная с версии 2.12

g_bookmark_file_set_visited ()

void        g_bookmark_file_set_visited     (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             time_t visited);

Устанавливает время последнего посещения закладки для uri.

Если закладка для uri не найдена, то она создаётся.

Время посещения должно устанавливаться только если закладка была задействована, любое использование командной строки найденное с помощью g_bookmark_file_get_app_info() или приложение по умолчанию для закладки MIME типа найденное с использованием g_bookmark_file_get_mime_type(). Изменение времени "посещения" не влияет на время "модификации".

Начиная с версии 2.12

g_bookmark_file_set_app_info ()

gboolean    g_bookmark_file_set_app_info    (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *name,
                                             const gchar *exec,
                                             gint count,
                                             time_t stamp,
                                             GError **error);

Устанавливает meta-данные приложения name в список приложений которые были зарегистрированы закладкой для uri внутри bookmark.

Вы должны редко использовать эту функцию; вместо неё используйте g_bookmark_file_add_application() и g_bookmark_file_remove_application().

name может быть любой строкой в кодировке UTF-8 используемой для идентификации приложения. exec может иметь один из двух модификаторов: "f", который будет расшифрован как локальное имя файла полученное из URI закладки; "u", который будет расшифрован как закладка URI. Расшифровка выполняется автоматически когда находится сохранённая командная строка используя функцию g_bookmark_file_get_app_info(). count это количество регистраций приложения закладкой; если < 0, текущее количество регистраций будет увеличено на одну, если 0, приложение с именем name будет удалено из списка зарегистрированных приложений. stamp Unix время последней регистрации; если -1, используется текущее время.

Если вы попытаетесь удалить приложение установив количество его регистраций в ноль, а закладка для uri не найдена, то вернётся FALSE и установится error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; точно так же, в случае когда нет приложения с именем name зарегистрированного закладкой для uri, то возвращается FALSE и устанавливается ошибка в G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Иначе, если закладка для uri не найдена, то она создаётся.

Начиная с версии 2.12

g_bookmark_file_add_group ()

void        g_bookmark_file_add_group       (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *group);

Добавляет group в список групп к которым принадлежит закладка для uri.

Если закладка для uri не найдена, то она создаётся.

Начиная с версии 2.12

g_bookmark_file_add_application ()

void        g_bookmark_file_add_application (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *name,
                                             const gchar *exec);

Добавляет приложение с именем name и exec в список приложений, которые зарегистрированы закладкой для uri, в bookmark.

Все закладки внутри GBookmarkFile должны иметь по меньшей мере одно зарегистрированное приложение. Каждое приложение должно иметь имя, командная строка полезна для запуска закладки, количество регистраций закладкой приложения и время последней регистрации приложения этой закладкой.

Если name это NULL, имя приложения будет тем что возвращает функция g_get_application(); если exec это NULL, командная строка будет состоять из имени программы которое возвращает g_get_prgname() и модификатора "u", который будет расшифрован как URI закладки.

Эта функция автоматически обновляет количество регистраций и timestamping в случае когда приложение с именем name уже зарегистрировано закладкой для uri внутри bookmark.

Если закладка для uri не найдена, то она создаётся.

Начиная с версии 2.12

g_bookmark_file_remove_group ()

gboolean    g_bookmark_file_remove_group    (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *group,
                                             GError **error);

Удаляет group из списка групп к которым принадлежит закладка для uri.

В случае когда URI не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. В случае когда группа не определена, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

Начиная с версии 2.12

g_bookmark_file_remove_application ()

gboolean    g_bookmark_file_remove_application
                                            (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             const gchar *name,
                                             GError **error);

Удаляет регистрацию приложения с именем name из списка приложений которые зарегистрированы закладкой для uri внутри bookmark.

В случае когда URI не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. В случае когда приложение с именем app_name не зарегистрировано закладкой для uri, возвращает FALSE и устанавливает ошибку в G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.

Начиная с версии 2.12

g_bookmark_file_remove_item ()

gboolean    g_bookmark_file_remove_item     (GBookmarkFile *bookmark,
                                             const gchar *uri,
                                             GError **error);

Удаляет закладку для uri из файла закладок bookmark.

Начиная с версии 2.12

g_bookmark_file_move_item ()

gboolean    g_bookmark_file_move_item       (GBookmarkFile *bookmark,
                                             const gchar *old_uri,
                                             const gchar *new_uri,
                                             GError **error);

Изменяет URI закладки из параметра old_uri на new_uri. Любые существующие закладки для new_uri будут переписаны. Если new_uri это NULL, тогда закладка удаляется.

В случае когда URI не найден, возвращает FALSE и устанавливает error в G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Начиная с версии 2.12