Top | ![]() |
![]() |
![]() |
![]() |
FmBookmarks * | fm_bookmarks_dup () |
#define | fm_bookmarks_append() |
FmBookmarkItem * | fm_bookmarks_insert () |
void | fm_bookmarks_remove () |
void | fm_bookmarks_reorder () |
void | fm_bookmarks_rename () |
const GList * | fm_bookmarks_list_all () |
FmBookmarkItem * | fm_bookmark_item_ref () |
void | fm_bookmark_item_unref () |
GList * | fm_bookmarks_get_all () |
include
: libfm/fm.h
The application that uses libfm can use user-wide bookmark list via class FmBookmarks.
FmBookmarks *
fm_bookmarks_dup (void
);
Returns reference to bookmarks list singleton descriptor.
This API is not thread-safe and should be used only in default context.
Since: 0.1.99
#define fm_bookmarks_append(bookmarks, path, name) fm_bookmarks_insert(bookmarks, path, name, -1)
FmBookmarkItem * fm_bookmarks_insert (FmBookmarks *bookmarks
,FmPath *path
,const char *name
,int pos
);
Adds a bookmark into bookmark list. Returned structure is managed by
bookmarks list and should not be freed by caller. If you want to save
returned data then call fm_bookmark_item_ref()
on it.
bookmarks |
bookmarks list |
|
path |
path requested to add to bookmarks |
|
name |
name new bookmark will be seen in list with |
|
pos |
where to insert a bookmark into list |
Since: 0.1.0
void fm_bookmarks_remove (FmBookmarks *bookmarks
,FmBookmarkItem *item
);
Removes a bookmark from bookmark list.
Since: 0.1.0
void fm_bookmarks_reorder (FmBookmarks *bookmarks
,FmBookmarkItem *item
,int pos
);
Changes position of existing bookmark item.
bookmarks |
bookmarks list |
|
item |
bookmark item which will be changed |
|
pos |
new position for bookmark item in list |
Since: 0.1.0
void fm_bookmarks_rename (FmBookmarks *bookmarks
,FmBookmarkItem *item
,const char *new_name
);
Changes name of existing bookmark item.
bookmarks |
bookmarks list |
|
item |
bookmark item which will be changed |
|
new_name |
new name for bookmark item to be seen in list |
Since: 0.1.0
const GList *
fm_bookmarks_list_all (FmBookmarks *bookmarks
);
fm_bookmarks_list_all
has been deprecated since version 1.0.2 and should not be used in newly-written code.
Use fm_bookmarks_get_all()
instead.
Returns list of FmBookmarkItem retrieved from bookmarks list. Returned list is owned by bookmarks list and should not be freed by caller.
Since: 0.1.0
FmBookmarkItem *
fm_bookmark_item_ref (FmBookmarkItem *item
);
Increases reference counter on item
.
Since: 1.0.2
void
fm_bookmark_item_unref (FmBookmarkItem *item
);
Decreases reference counter on item
and frees data when it reaches 0.
Since: 1.0.2
GList *
fm_bookmarks_get_all (FmBookmarks *bookmarks
);
Returns list of FmBookmarkItem retrieved from bookmarks list. Returned list should be freed with g_list_free_full(list, fm_bookmark_item_unref).
Since: 1.0.2
“changed”
signalvoid user_function (FmBookmarks *bookmarks, gpointer user_data)
The "changed" signal is emitted when some bookmark item is changed, added, or removed.
bookmarks |
pointer to bookmarks list singleton descriptor |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
Since: 0.1.0