From eab4ebf7f6c82580b61205f34e1cfe535aeada60 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Sun, 3 May 2009 01:21:55 +0200 Subject: Add docs for the gio.ThemedIcon class --- docs/reference/pygio-classes.xml | 1 + docs/reference/pygio-themedicon.xml | 204 ++++++++++++++++++++++++++++++++++++ 2 files changed, 205 insertions(+) create mode 100644 docs/reference/pygio-themedicon.xml (limited to 'docs/reference') diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index fa0823a..8cc47bc 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -23,6 +23,7 @@ + diff --git a/docs/reference/pygio-themedicon.xml b/docs/reference/pygio-themedicon.xml new file mode 100644 index 0000000..fe0e44c --- /dev/null +++ b/docs/reference/pygio-themedicon.xml @@ -0,0 +1,204 @@ + + + + + + gio.ThemedIcon + Icon theming support. + + + + Synopsis + + + gio.ThemedIcon + gobject.GObject + + + gio.ThemedIcon + + + + + append_name + + + + get_names + + + + prepend_name + + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.ThemedIcon + + + + + + gio.ThemedIcon Properties + +
+ + + + + + + + "name" + Write/Contruct Only + + The icon name. Default value: None + + + + "names" + Read/Write/Contruct Only + + A list of icon names. + + + + "use-default-fallbacks" + Read/Write/Contruct Only + + Whether to use the default fallbacks found by shortening the + icon name at '-' characters. If the "names" array has more + than one element, ignores any past the first. + + + + + +
+ + + + Description + + + gio.ThemedIcon + is an implementation of gio.Icon + that supports icon themes. GThemedIcon contains a list of all of the icons present in an icon + theme, so that icons can be looked up quickly. + + + gio.ThemedIcon + does not provide actual pixmaps for icons, just the icon names. Ideally something like + gtk.IconTheme.choose_icon() + should be used to resolve the list of names so that fallback icons work nicely + with themes that inherit other themes + + + + + Constructor + + + gio.ThemedIcon + name + use_default_fallbacksFalse + + + + name : + a string containing an icon name. + + + + Returns : + a new + gio.ThemedIcon. + + + + + + Creates a new themed icon from icon name, if instead of an icon name you + provide a list of icon names, the gio.ThemedIcon + will be constructed using the items in the list. + + + + + + Methods + + + gio.ThemedIcon.append_name + + + append_name + + + + + + name : + name of icon to append to list of icons from within icon. + + + + + + The append_name() method appends a name to + the list of icons from within icon. + + + + + gio.ThemedIcon.get_names + + + get_names + + + + + + Returns : + a list of icon names. + + + + + + The get_names() method gets the names + of icons from within icon. + + + + + gio.ThemedIcon.prepend_name + + + prepend_name + + + + + + name : + name of icon to prepend to list of icons from within icon. + + + + + + The prepend_name() method prepends a name to + the list of icons from within icon. + + + + -- cgit