Index

Package: Icon_Source

Description

package Gtk.Icon_Source is

An icon source contains a Gdk_Pixbuf (or image filename) that serves as the base image for one or more of the icons in an icon set, along with a specification for which icons in the icon set will be based on that pixbuf or image file. An icon set contains a set of icons that represent "the same" logical concept in different states, different global text directions, and different sizes.

So for example a web browser's "Back to Previous Page" icon might point in a different direction in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode (small/large icons). So a single icon set would contain all those variants of the icon. An icon set contains a list of icon sources from which it can derive specific icon variants in the set.

In the simplest case, an icon set contains one source pixbuf from which it derives all variants.

If you want to use a different base pixbuf for different icon variants, you create multiple icon sources, mark which variants they'll be used to create, and add them to the icon set with Add_Source (see below).

By default, the icon source has all parameters wildcarded. That is, the icon source will be used as the base icon for any desired text direction, widget state, or icon size.

Classes

Gtk_Icon_Source

type Gtk_Icon_Source is new Glib.C_Boxed with null record;

Ancestors:

Primitive operations:

From_Object_Free
Get_Direction
Get_Direction_Wildcarded
Get_Filename
Get_Icon_Name
Get_Size_Wildcarded
Get_State_Wildcarded
Gtk_Icon_Source_New
Set_Direction
Set_Direction_Wildcarded
Set_Filename
Set_Icon_Name
Set_Size_Wildcarded
Set_State_Wildcarded

Constants & Global variables

Null_Gtk_Icon_Source (Gtk_Icon_Source)

Null_Gtk_Icon_Source : constant Gtk_Icon_Source;

Subprograms & Entries

From_Object

function From_Object 
(Object: System.Address) return Gtk_Icon_Source;

From_Object_Free

function From_Object_Free 
(B: access Gtk_Icon_Source'Class) return Gtk_Icon_Source;

Gtk_New

procedure Gtk_New 
(Self: out Gtk_Icon_Source);
Creates a new Gtk.Icon_Source.Gtk_Icon_Source. A Gtk.Icon_Source.Gtk_Icon_Source contains a Gdk.Pixbuf.Gdk_Pixbuf (or image filename) that serves as the base image for one or more of the icons in a Gtk.Icon_Set.Gtk_Icon_Set, along with a specification for which icons in the icon set will be based on that pixbuf or image file. An icon set contains a set of icons that represent "the same" logical concept in different states, different global text directions, and different sizes. So for example a web browser's "Back to Previous Page" icon might point in a different direction in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode (small/large icons). So a single icon set would contain all those variants of the icon. Gtk.Icon_Set.Gtk_Icon_Set contains a list of Gtk.Icon_Source.Gtk_Icon_Source from which it can derive specific icon variants in the set. In the simplest case, Gtk.Icon_Set.Gtk_Icon_Set contains one source pixbuf from which it derives all variants. The convenience function gtk_icon_set_new_from_pixbuf handles this case; if you only have one source pixbuf, just use that function. If you want to use a different base pixbuf for different icon variants, you create multiple icon sources, mark which variants they'll be used to create, and add them to the icon set with Gtk.Icon_Set.Add_Source. By default, the icon source has all parameters wildcarded. That is, the icon source will be used as the base icon for any desired text direction, widget state, or icon size.

Gtk_Icon_Source_New

function Gtk_Icon_Source_New return Gtk_Icon_Source;
Creates a new Gtk.Icon_Source.Gtk_Icon_Source. A Gtk.Icon_Source.Gtk_Icon_Source contains a Gdk.Pixbuf.Gdk_Pixbuf (or image filename) that serves as the base image for one or more of the icons in a Gtk.Icon_Set.Gtk_Icon_Set, along with a specification for which icons in the icon set will be based on that pixbuf or image file. An icon set contains a set of icons that represent "the same" logical concept in different states, different global text directions, and different sizes. So for example a web browser's "Back to Previous Page" icon might point in a different direction in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode (small/large icons). So a single icon set would contain all those variants of the icon. Gtk.Icon_Set.Gtk_Icon_Set contains a list of Gtk.Icon_Source.Gtk_Icon_Source from which it can derive specific icon variants in the set. In the simplest case, Gtk.Icon_Set.Gtk_Icon_Set contains one source pixbuf from which it derives all variants. The convenience function gtk_icon_set_new_from_pixbuf handles this case; if you only have one source pixbuf, just use that function. If you want to use a different base pixbuf for different icon variants, you create multiple icon sources, mark which variants they'll be used to create, and add them to the icon set with Gtk.Icon_Set.Add_Source. By default, the icon source has all parameters wildcarded. That is, the icon source will be used as the base icon for any desired text direction, widget state, or icon size.

Get_Type

function Get_Type return Glib.GType;

Copy

function Copy 
(Self: Gtk_Icon_Source) return Gtk_Icon_Source;
Creates a copy of Source; mostly useful for language bindings.

Free

procedure Free 
(Self: Gtk_Icon_Source);
Frees a dynamically-allocated icon source, along with its filename, size, and pixbuf fields if those are not null.

Get_Direction

function Get_Direction 
(Self: Gtk_Icon_Source) return Gtk.Enums.Gtk_Text_Direction;
Obtains the text direction this icon source applies to. The return value is only useful/meaningful if the text direction is *not* wildcarded.

Set_Direction

procedure Set_Direction 
(Self: Gtk_Icon_Source;
Direction: Gtk.Enums.Gtk_Text_Direction);
Sets the text direction this icon source is intended to be used with. Setting the text direction on an icon source makes no difference if the text direction is wildcarded. Therefore, you should usually call Gtk.Icon_Source.Set_Direction_Wildcarded to un-wildcard it in addition to calling this function. "direction": text direction this source applies to

Get_Direction_Wildcarded

function Get_Direction_Wildcarded 
(Self: Gtk_Icon_Source) return Boolean;

Set_Direction_Wildcarded

procedure Set_Direction_Wildcarded 
(Self: Gtk_Icon_Source;
Setting: Boolean);
If the text direction is wildcarded, this source can be used as the base image for an icon in any Gtk.Enums.Gtk_Text_Direction. If the text direction is not wildcarded, then the text direction the icon source applies to should be set with Gtk.Icon_Source.Set_Direction, and the icon source will only be used with that text direction. Gtk.Icon_Set.Gtk_Icon_Set prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. "setting": True to wildcard the text direction

Get_Filename

function Get_Filename 
(Self: Gtk_Icon_Source) return UTF8_String;
Retrieves the source filename, or null if none is set. The filename is not a copy, and should not be modified or expected to persist beyond the lifetime of the icon source.

Set_Filename

procedure Set_Filename 
(Self: Gtk_Icon_Source;
Filename: UTF8_String);
Sets the name of an image file to use as a base image when creating icon variants for Gtk.Icon_Set.Gtk_Icon_Set. The filename must be absolute. "filename": image file to use

Get_Icon_Name

function Get_Icon_Name 
(Self: Gtk_Icon_Source) return UTF8_String;
Retrieves the source icon name, or null if none is set. The icon_name is not a copy, and should not be modified or expected to persist beyond the lifetime of the icon source.

Set_Icon_Name

procedure Set_Icon_Name 
(Self: Gtk_Icon_Source;
Icon_Name: UTF8_String := "");
Sets the name of an icon to look up in the current icon theme to use as a base image when creating icon variants for Gtk.Icon_Set.Gtk_Icon_Set. "icon_name": name of icon to use

Get_Pixbuf

function Get_Pixbuf 
(Self: Gtk_Icon_Source) return Gdk.Pixbuf.Gdk_Pixbuf;
Retrieves the source pixbuf, or null if none is set. In addition, if a filename source is in use, this function in some cases will return the pixbuf from loaded from the filename. This is, for example, true for the GtkIconSource passed to the GtkStyle::render_icon virtual function. The reference count on the pixbuf is not incremented.

Set_Pixbuf

procedure Set_Pixbuf 
(Self: Gtk_Icon_Source;
Pixbuf: not null access Gdk.Pixbuf.Gdk_Pixbuf_Record'Class);
Sets a pixbuf to use as a base image when creating icon variants for Gtk.Icon_Set.Gtk_Icon_Set. "pixbuf": pixbuf to use as a source

Get_Size

function Get_Size 
(Self: Gtk_Icon_Source) return Gtk.Enums.Gtk_Icon_Size;
Obtains the icon size this source applies to. The return value is only useful/meaningful if the icon size is *not* wildcarded.

Set_Size

procedure Set_Size 
(Self: Gtk_Icon_Source;
Size: Gtk.Enums.Gtk_Icon_Size);
Sets the icon size this icon source is intended to be used with. Setting the icon size on an icon source makes no difference if the size is wildcarded. Therefore, you should usually call Gtk.Icon_Source.Set_Size_Wildcarded to un-wildcard it in addition to calling this function. "size": icon size this source applies to

Get_Size_Wildcarded

function Get_Size_Wildcarded 
(Self: Gtk_Icon_Source) return Boolean;
Gets the value set by Gtk.Icon_Source.Set_Size_Wildcarded.

Set_Size_Wildcarded

procedure Set_Size_Wildcarded 
(Self: Gtk_Icon_Source;
Setting: Boolean);
If the icon size is wildcarded, this source can be used as the base image for an icon of any size. If the size is not wildcarded, then the size the source applies to should be set with Gtk.Icon_Source.Set_Size and the icon source will only be used with that specific size. Gtk.Icon_Set.Gtk_Icon_Set prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. Gtk.Icon_Set.Gtk_Icon_Set will normally scale wildcarded source images to produce an appropriate icon at a given size, but will not change the size of source images that match exactly. "setting": True to wildcard the widget state

Get_State

function Get_State 
(Self: Gtk_Icon_Source) return Gtk.Enums.Gtk_State_Type;
Obtains the widget state this icon source applies to. The return value is only useful/meaningful if the widget state is *not* wildcarded.

Set_State

procedure Set_State 
(Self: Gtk_Icon_Source;
State: Gtk.Enums.Gtk_State_Type);
Sets the widget state this icon source is intended to be used with. Setting the widget state on an icon source makes no difference if the state is wildcarded. Therefore, you should usually call Gtk.Icon_Source.Set_State_Wildcarded to un-wildcard it in addition to calling this function. "state": widget state this source applies to

Get_State_Wildcarded

function Get_State_Wildcarded 
(Self: Gtk_Icon_Source) return Boolean;
Gets the value set by Gtk.Icon_Source.Set_State_Wildcarded.

Set_State_Wildcarded

procedure Set_State_Wildcarded 
(Self: Gtk_Icon_Source;
Setting: Boolean);
If the widget state is wildcarded, this source can be used as the base image for an icon in any Gtk.Enums.Gtk_State_Type. If the widget state is not wildcarded, then the state the source applies to should be set with Gtk.Icon_Source.Set_State and the icon source will only be used with that specific state. Gtk.Icon_Set.Gtk_Icon_Set prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. Gtk.Icon_Set.Gtk_Icon_Set will normally transform wildcarded source images to produce an appropriate icon for a given state, for example lightening an image on prelight, but will not modify source images that match exactly. "setting": True to wildcard the widget state