MxIconTheme

## MxIconTheme MxIconTheme |

## Synopsis

    struct              MxIconTheme;
    struct              MxIconThemeClass;
    MxIconTheme *       mx_icon_theme_new                   (void);
    MxIconTheme *       mx_icon_theme_get_default           (void);
    const gchar *       mx_icon_theme_get_theme_name        (MxIconTheme *theme);
    void                mx_icon_theme_set_theme_name        (MxIconTheme *theme,
                                                             const gchar *theme_name);
    CoglHandle          mx_icon_theme_lookup                (MxIconTheme *theme,
                                                             const gchar *icon_name,
                                                             gint size);
    ClutterTexture *    mx_icon_theme_lookup_texture        (MxIconTheme *theme,
                                                             const gchar *icon_name,
                                                             gint size);
    gboolean            mx_icon_theme_has_icon              (MxIconTheme *theme,
                                                             const gchar *icon_name);
    const GList *       mx_icon_theme_get_search_paths      (MxIconTheme *theme);
    void                mx_icon_theme_set_search_paths      (MxIconTheme *theme,
                                                             const GList *paths);

## Object Hierarchy

      GObject
       +----MxIconTheme

## Properties

      "theme-name"               gchar*                : Read / Write

## Description

## Details

### struct MxIconTheme

    struct MxIconTheme;

The contents of this structure are private and should only be accessed through the public API.

### struct MxIconThemeClass

    struct MxIconThemeClass {
      GObjectClass parent_class;

      /* padding for future expansion */
      void (*_padding_0) (void);
      void (*_padding_1) (void);
      void (*_padding_2) (void);
      void (*_padding_3) (void);
      void (*_padding_4) (void);
    };

### mx_icon_theme_new ()

    MxIconTheme *       mx_icon_theme_new                   (void);

Create a new MxIconTheme. In most cicumstances, it is more useful to use mx_icon_theme_get_default to load the default icon theme.

Returns : | a newly allocated MxIconTheme.

### mx_icon_theme_get_default ()

    MxIconTheme *       mx_icon_theme_get_default           (void);

Return the default MxIconTheme object used by the toolkit.

Returns : | an MxIconTheme. [transfer none]

### mx_icon_theme_get_theme_name ()

    const gchar *       mx_icon_theme_get_theme_name        (MxIconTheme *theme);

Get the value of the "theme-name" property.

`theme` : | A MxIconTheme
Returns : | the current value of the "theme-name" property.

### mx_icon_theme_set_theme_name ()

    void                mx_icon_theme_set_theme_name        (MxIconTheme *theme,
                                                             const gchar *theme_name);

Set the value of the "theme-name" property. This will cause the icon theme to be loaded if it differs from the existing theme name. If the theme could not be loaded, it will fall back to using the default icon theme (hicolor).

This will override the system's theme setting. To revert to the system icon theme, this function can be called with a `NULL` `theme_name` argument.

`theme` : | A MxIconTheme
`theme_name` : | the name of an icon theme to load, or `NULL`

### mx_icon_theme_lookup ()

    CoglHandle          mx_icon_theme_lookup                (MxIconTheme *theme,
                                                             const gchar *icon_name,
                                                             gint size);

If the icon is available, returns a CoglHandle of the icon.

`theme` : | an MxIconTheme
`icon_name` : | The name of the icon
`size` : | The desired size of the icon
Returns : | a CoglHandle of the icon, or `NULL`. [transfer none]

### mx_icon_theme_lookup_texture ()

    ClutterTexture *    mx_icon_theme_lookup_texture        (MxIconTheme *theme,
                                                             const gchar *icon_name,
                                                             gint size);

If the icon is available, returns a ClutterTexture of the icon.

`theme` : | an MxIconTheme
`icon_name` : | The name of the icon
`size` : | The desired size of the icon
Returns : | a ClutterTexture of the icon, or `NULL`. [transfer none]

### mx_icon_theme_has_icon ()

    gboolean            mx_icon_theme_has_icon              (MxIconTheme *theme,
                                                             const gchar *icon_name);

### mx_icon_theme_get_search_paths ()

    const GList *       mx_icon_theme_get_search_paths      (MxIconTheme *theme);

Gets the directories the MxIconTheme will search in to find icons.

`theme` : | a MxIconTheme
Returns : | the search paths. [element-type utf8][transfer none]

### mx_icon_theme_set_search_paths ()

    void                mx_icon_theme_set_search_paths      (MxIconTheme *theme,
                                                             const GList *paths);

Sets the directories the MxIconTheme will search in to find icons. By default, it will look in the default system and local icon directories.

`theme` : | a MxIconTheme
`paths` : | a list of search paths. [element-type utf8]

## Property Details

### The `"theme-name"` property

      "theme-name"               gchar*                : Read / Write

The name of the currently loaded theme.

Default value: NULL