Document the IconLoader

This commit is contained in:
David Sansome 2011-02-15 22:36:28 +00:00
parent 7f3f4f4107
commit f5d5451c16
1 changed files with 26 additions and 0 deletions

View File

@ -4,8 +4,34 @@ class IconLoader {
#include "ui/iconloader.h"
%End
%Docstring
Singleton class that loads icons from the system theme if possible, falling
back on Clementine's builtin icons otherwise.
You can access the IconLoader directly, there is no need to create an instance
of the class first.
>>> clementine.IconLoader.Load("media-pause")
Icons are identified by their name without any extension, and they follow the
U{Freedesktop icon naming specification<http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html#names>}.
You can find the list of icons bundled with Clementine in the
U{data/icons/<http://code.google.com/p/clementine-player/source/browse/#svn%2Ftrunk%2Fdata%2Ficons%2F22x22>}
directory in Clementine's source tree.
%End
public:
static QIcon Load(const QString& name);
%Docstring
Load(name) -> QIcon
Tries to load an icon with the given name.
@param name: The name of an icon from the Freedesktop icon naming specification.
@type name: C{str}
@return: If the icon was loaded successfully then a valid QIcon is returned.
Otherwise a null QIcon is returned (C{.isNull()} will return C{True}).
%End
private:
IconLoader();