## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

## Index

Package: G_Icon

- Goto spec source

# Description

    package Glib.G_Icon is

--------------------------------------------------------------------- GtkAda - Ada95 binding for Gtk+/Gnome -- -- Copyright (C) 2010-2013, AdaCore -- -- This library is free software; you can redistribute it and/or -- modify it under the terms of the GNU General Public -- License as published by the Free Software Foundation; either -- version 2 of the License, or (at your option) any later version. -- -- This library is distributed in the hope that it will be useful, -- but WITHOUT ANY WARRANTY; without even the implied warranty of -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- General Public License for more details. -- -- You should have received a copy of the GNU General Public -- License along with this library; if not, write to the -- Free Software Foundation, Inc., 59 Temple Place - Suite 330, -- Boston, MA 02111-1307, USA. -- -- As a special exception, if other files instantiate generics from -- this unit, or you link this unit with other files to produce an -- executable, this unit does not by itself cause the resulting -- executable to be covered by the GNU General Public License. This -- exception does not however invalidate any other reasons why the -- executable file might be covered by the GNU Public License. -- ---------------------------------------------------------------------

# Types

### G_Icon

- Goto declaration in source

    type G_Icon is private;

# Constants & Global variables

### Null_G_Icon

- Goto declaration in source

(G_Icon)

    Null_G_Icon : constant G_Icon;

# Subprograms & Entries

### G_Icon_Get_Type

- Goto spec in source

    function G_Icon_Get_Type return GType;

### =

- Goto spec in source

    function "=" (Icon1, Icon2: G_Icon) return Boolean;

Returns whether two icons are equal.

### Hash

- Goto spec in source

    function Hash (Icon: G_Icon) return Guint;

Returns a Guint containing a hash for the Icon, suitable for use in a GHashTable or similar data structure.

### To_String

- Goto spec in source

    function To_String (Icon: G_Icon) return UTF8_String;

Generates a textual representation of Icon that can be used for serialization such as when passing Icon to a different process or saving it to persistent storage. Use New_For_String to get Icon back from the returned string. The encoding of the returned string is proprietary to G_Icon except in the following two cases: If Icon is a GFileIcon, the returned string is a native path (such as "/path/to/my icon.png") without escaping if the GFile for Icon is a native file. If the file is not native, the returned string is the result of g_file_get_uri() (such as "sftp://path/to/my%%20icon.png"). If Icon is a GThemedIcon with exactly one name, the encoding is simply the name (such as "network-server").

### New_For_String

- Goto spec in source

    procedure New_For_String (Widget: out G_Icon;Str: String);

Generate a G_Icon instance from Str. This function can fail if Str is not valid - see To_String for discussion. Returns Null_G_Icon on failure. If your application or library provides one or more G_Icon implementations you need to ensure that each GType is registered with the type system prior to calling New_For_String.