Gjsify LogoGjsify Logo

Hierarchy

  • IconSource

Index

Constructors

  • Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or image filename) that serves as the base image for one or more of the icons in a #GtkIconSet, 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. #GtkIconSet contains a list of #GtkIconSource from which it can derive specific icon variants in the set.

    In the simplest case, #GtkIconSet 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.

    Returns Gtk.IconSource

Properties

name: string

Methods

  • free(): void
  • Frees a dynamically-allocated icon source, along with its filename, size, and pixbuf fields if those are not %NULL.

    Returns void

  • get_direction_wildcarded(): boolean
  • get_filename(): 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.

    Returns string

  • get_icon_name(): 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.

    Returns string

  • 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.

    Returns Pixbuf

  • get_size(): number
  • Obtains the icon size this source applies to. The return value is only useful/meaningful if the icon size is not wildcarded.

    Returns number

  • get_size_wildcarded(): boolean
  • get_state_wildcarded(): boolean
  • 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.

    Parameters

    Returns void

  • set_direction_wildcarded(setting: boolean): void
  • If the text direction is wildcarded, this source can be used as the base image for an icon in any #GtkTextDirection. 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.

    #GtkIconSet prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible.

    Parameters

    • setting: boolean

      %TRUE to wildcard the text direction

    Returns void

  • set_filename(filename: string): void
  • Sets the name of an image file to use as a base image when creating icon variants for #GtkIconSet. The filename must be absolute.

    Parameters

    • filename: string

      image file to use

    Returns void

  • set_icon_name(icon_name: string): void
  • 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 #GtkIconSet.

    Parameters

    • icon_name: string

      name of icon to use

    Returns void

  • set_pixbuf(pixbuf: Pixbuf): void
  • Sets a pixbuf to use as a base image when creating icon variants for #GtkIconSet.

    Parameters

    • pixbuf: Pixbuf

      pixbuf to use as a source

    Returns void

  • set_size(size: number): void
  • 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.

    Parameters

    • size: number

      icon size (#GtkIconSize) this source applies to

    Returns void

  • set_size_wildcarded(setting: boolean): void
  • 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.

    #GtkIconSet prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible.

    #GtkIconSet 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.

    Parameters

    • setting: boolean

      %TRUE to wildcard the widget state

    Returns void

  • 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.

    Parameters

    Returns void

  • set_state_wildcarded(setting: boolean): void
  • If the widget state is wildcarded, this source can be used as the base image for an icon in any #GtkStateType. 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.

    #GtkIconSet prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible.

    #GtkIconSet 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.

    Parameters

    • setting: boolean

      %TRUE to wildcard the widget state

    Returns void

  • Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or image filename) that serves as the base image for one or more of the icons in a #GtkIconSet, 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. #GtkIconSet contains a list of #GtkIconSource from which it can derive specific icon variants in the set.

    In the simplest case, #GtkIconSet 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.

    Returns Gtk.IconSource

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method