manpagez: man pages & more
html files: gio
Home | html | info | man

GEmblem

GEmblem — An object for emblems

Properties

GObject * icon Read / Write / Construct Only
GEmblemOrigin origin Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GEmblem

Implemented Interfaces

GEmblem implements GIcon.

Includes

#include <gio/gio.h>

Description

GEmblem is an implementation of GIcon that supports having an emblem, which is an icon with additional properties. It can than be added to a GEmblemedIcon.

Currently, only metainformation about the emblem's origin is supported. More may be added in the future.

Functions

g_emblem_new ()

GEmblem *
g_emblem_new (GIcon *icon);

Creates a new emblem for icon .

Parameters

icon

a GIcon containing the icon.

 

Returns

a new GEmblem.

Since 2.18


g_emblem_new_with_origin ()

GEmblem *
g_emblem_new_with_origin (GIcon *icon,
                          GEmblemOrigin origin);

Creates a new emblem for icon .

Parameters

icon

a GIcon containing the icon.

 

origin

a GEmblemOrigin enum defining the emblem's origin

 

Returns

a new GEmblem.

Since 2.18


g_emblem_get_icon ()

GIcon *
g_emblem_get_icon (GEmblem *emblem);

Gives back the icon from emblem .

Parameters

emblem

a GEmblem from which the icon should be extracted.

 

Returns

a GIcon. The returned object belongs to the emblem and should not be modified or freed.

[transfer none]

Since 2.18


g_emblem_get_origin ()

GEmblemOrigin
g_emblem_get_origin (GEmblem *emblem);

Gets the origin of the emblem.

Parameters

emblem

a GEmblem

 

Returns

the origin of the emblem.

[transfer none]

Since 2.18

Types and Values

GEmblem

typedef struct _GEmblem GEmblem;

An object for Emblems


enum GEmblemOrigin

GEmblemOrigin is used to add information about the origin of the emblem to GEmblem.

Members

G_EMBLEM_ORIGIN_UNKNOWN

Emblem of unknown origin

 

G_EMBLEM_ORIGIN_DEVICE

Emblem adds device-specific information

 

G_EMBLEM_ORIGIN_LIVEMETADATA

Emblem depicts live metadata, such as "readonly"

 

G_EMBLEM_ORIGIN_TAG

Emblem comes from a user-defined tag, e.g. set by nautilus (in the future)

 

Since 2.18

Property Details

The “icon” property

  “icon”                     GObject *

The actual icon of the emblem.

Flags: Read / Write / Construct Only


The “origin” property

  “origin”                   GEmblemOrigin

Tells which origin the emblem is derived from.

Flags: Read / Write / Construct Only

Default value: G_EMBLEM_ORIGIN_UNKNOWN

© manpagez.com 2000-2024
Individual documents may contain additional copyright information.