XfceHeading

XfceHeading

Functions

Properties

GdkPixbuf * icon Read / Write
gchar * icon-name Read / Write
gchar * subtitle Read / Write
gchar * title Read / Write

Types and Values

struct XfceHeading

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── XfceHeading

Implemented Interfaces

XfceHeading implements AtkImplementorIface and GtkBuildable.

Includes

#include <libxfcegui4/libxfcegui4.h>

Description

Functions

xfce_heading_new ()

GtkWidget *
xfce_heading_new (void);

Allocates a new XfceHeading instance.

Returns

the newly allocated XfceHeading.

Since 4.4.0


xfce_heading_get_icon ()

GdkPixbuf *
xfce_heading_get_icon (XfceHeading *heading);

Returns the GdkPixbuf that was set as icon for heading or NULL if no icon is set. The returned GdkPixbuf object is owned by heading .

Parameters

heading

a XfceHeading.

 

Returns

the icon for heading , or NULL.

Since 4.4.0


xfce_heading_set_icon ()

void
xfce_heading_set_icon (XfceHeading *heading,
                       GdkPixbuf *icon);

If icon is not NULL, heading will display the new icon aside the title. Else, if icon is NULL no icon is displayed unless an icon name was set with xfce_heading_set_icon_name().

Parameters

heading

a XfceHeading.

 

icon

the new icon or NULL.

 

Since 4.4.0


xfce_heading_get_icon_name ()

const gchar *
xfce_heading_get_icon_name (XfceHeading *heading);

Returns the icon name previously set by a call to xfce_heading_set_icon_name() or NULL if no icon name is set for heading .

Parameters

heading

a XfceHeading.

 

Returns

the icon name for heading , or NULL.

Since 4.4.0


xfce_heading_set_icon_name ()

void
xfce_heading_set_icon_name (XfceHeading *heading,
                            const gchar *icon_name);

If icon_name is not NULL and the "icon" property is set to NULL, see xfce_heading_set_icon(), the heading will display the name icon identified by the icon_name .

Parameters

heading

a XfceHeading.

 

icon_name

the new icon name, or NULL.

 

Since 4.4.0


xfce_heading_get_subtitle ()

const gchar *
xfce_heading_get_subtitle (XfceHeading *heading);

Returns the sub title displayed below the main title of the heading , or NULL if no subtitle is set.

Parameters

heading

a XfceHeading.

 

Returns

the subtitle of heading , or NULL.

Since 4.4.0


xfce_heading_set_subtitle ()

void
xfce_heading_set_subtitle (XfceHeading *heading,
                           const gchar *subtitle);

If subtitle is not NULL and not the empty string, it will be displayed by heading below the main title.

Parameters

heading

a XfceHeading.

 

subtitle

the new subtitle for heading , or NULL.

 

Since 4.4.0


xfce_heading_get_title ()

const gchar *
xfce_heading_get_title (XfceHeading *heading);

Returns the title displayed by the heading .

Parameters

heading

a XfceHeading.

 

Returns

the title displayed by the heading .

Since 4.4.0


xfce_heading_set_title ()

void
xfce_heading_set_title (XfceHeading *heading,
                        const gchar *title);

Sets the title displayed by the heading to the specified title .

Parameters

heading

a XfceHeading.

 

title

the new title for the heading .

 

Since 4.4.0

Types and Values

struct XfceHeading

struct XfceHeading;

Property Details

The “icon” property

  “icon”                     GdkPixbuf *

The GdkPixbuf to display as icon, or NULL to use the "icon-name" property.

Flags: Read / Write

Since 4.4.0


The “icon-name” property

  “icon-name”                gchar *

If the "icon" property value is NULL this is the name of the icon to display instead (looked up using the icon theme). If this property is also NULL or the specified icon does not exist in the selected icon theme, no icon will be displayed.

Flags: Read / Write

Default value: NULL

Since 4.4.0


The “subtitle” property

  “subtitle”                 gchar *

The sub title that should be displayed below the title. May be NULL or the empty string to display only the title.

Flags: Read / Write

Default value: NULL

Since 4.4.0


The “title” property

  “title”                    gchar *

The title text to display in the heading.

Flags: Read / Write

Default value: NULL

Since 4.4.0