GnomeIconEntry

GnomeIconEntry

Functions

Properties

gchar * browse-dialog-title Read / Write
gchar * filename Read / Write
gchar * history-id Read / Write
GtkDialog * pick-dialog Read
gchar * pixmap-subdir Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── GtkVBox
                            ╰── GnomeIconEntry

Implemented Interfaces

GnomeIconEntry implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Includes

#include <libgnomeui/libgnomeui.h>

Description

Functions

gnome_icon_entry_new ()

GtkWidget *
gnome_icon_entry_new (const gchar *history_id,
                      const gchar *browse_dialog_title);

Creates a new icon entry widget

Parameters

history_id

the id given to gnome_entry_new

 

browse_dialog_title

title of the browse dialog and icon selection dialog

 

Returns

Returns the new object


gnome_icon_entry_construct ()

void
gnome_icon_entry_construct (GnomeIconEntry *ientry,
                            const gchar *history_id,
                            const gchar *browse_dialog_title);

For language bindings and subclassing, from C use gnome_icon_entry_new

Parameters

ientry

the GnomeIconEntry to work with

 

history_id

the id given to gnome_entry_new in the browse dialog

 

browse_dialog_title

title of the icon selection dialog

 

gnome_icon_entry_set_pixmap_subdir ()

void
gnome_icon_entry_set_pixmap_subdir (GnomeIconEntry *ientry,
                                    const gchar *subdir);

Sets the subdirectory below gnome's default pixmap directory to use as the default path for the file entry. The path can also be an absolute one. If NULL is passed then the pixmap directory itself is used.

Parameters

ientry

the GnomeIconEntry to work with

 

subdir

subdirectory

 

gnome_icon_entry_get_filename ()

gchar *
gnome_icon_entry_get_filename (GnomeIconEntry *ientry);

Gets the file name of the image if it was possible to load it into the preview. That is, it will only return a filename if the image exists and it was possible to load it as an image.

Parameters

ientry

the GnomeIconEntry to work with

 

Returns

a newly allocated string with the path or NULL if it couldn't load the file


gnome_icon_entry_set_filename ()

gboolean
gnome_icon_entry_set_filename (GnomeIconEntry *ientry,
                               const gchar *filename);

Sets the icon of GnomeIconEntry to be the one pointed to by filename (in the current subdirectory).

Parameters

ientry

the GnomeIconEntry to work with

 

filename

a filename

 

Returns

TRUE if icon was loaded ok, FALSE otherwise


gnome_icon_entry_set_browse_dialog_title ()

void
gnome_icon_entry_set_browse_dialog_title
                               (GnomeIconEntry *ientry,
                                const gchar *browse_dialog_title);

Set the title of the browse dialog. It will not effect an existing dialog.

Parameters

ientry

the GnomeIconEntry to work with

 

browse_dialog_title

title of the icon selection dialog

 

gnome_icon_entry_set_history_id ()

void
gnome_icon_entry_set_history_id (GnomeIconEntry *ientry,
                                 const gchar *history_id);

Set the history_id of the entry in the browse dialog and reload the history

Parameters

ientry

the GnomeIconEntry to work with

 

history_id

the id given to gnome_entry_new in the browse dialog

 

gnome_icon_entry_set_max_saved ()

void
gnome_icon_entry_set_max_saved (GnomeIconEntry *ientry,
                                guint max_saved);

Set the max_saved of the entry in the browse dialog

Parameters

ientry

the GnomeIconEntry to work with

 

max_saved

the maximum number of saved entries

 

Since: 2.4


gnome_icon_entry_pick_dialog ()

GtkWidget *
gnome_icon_entry_pick_dialog (GnomeIconEntry *ientry);

If a pick dialog exists, return a pointer to it or return NULL. This is if you need to do something with all dialogs. You would use the browse signal with connect_after to get the pick dialog when it is displayed.

Parameters

ientry

the GnomeIconEntry to work with

 

Returns

The pick dialog or NULL if none exists


gnome_icon_entry_set_icon ()

void
gnome_icon_entry_set_icon (GnomeIconEntry *ientry,
                           const gchar *filename);

Deprecated in favour of gnome_icon_entry_set_filename

Parameters

ientry

the GnomeIconEntry to work with

 

filename

a filename

 

gnome_icon_entry_gnome_file_entry ()

GtkWidget *
gnome_icon_entry_gnome_file_entry (GnomeIconEntry *ientry);

Get the GnomeFileEntry widget that's part of the entry DEPRECATED! Use the "changed" signal for getting changes

Parameters

ientry

the GnomeIconEntry to work with

 

Returns

Returns GnomeFileEntry widget


gnome_icon_entry_gnome_entry ()

GtkWidget *
gnome_icon_entry_gnome_entry (GnomeIconEntry *ientry);

Get the GnomeEntry widget that's part of the entry DEPRECATED! Use the "changed" signal for getting changes

Parameters

ientry

the GnomeIconEntry to work with

 

Returns

Returns GnomeEntry widget


gnome_icon_entry_gtk_entry ()

GtkWidget *
gnome_icon_entry_gtk_entry (GnomeIconEntry *ientry);

Get the GtkEntry widget that's part of the entry. DEPRECATED! Use the "changed" signal for getting changes

Parameters

ientry

the GnomeIconEntry to work with

 

Returns

Returns GtkEntry widget

Types and Values

GnomeIconEntryPrivate

typedef struct _GnomeIconEntryPrivate GnomeIconEntryPrivate;

struct GnomeIconEntry

struct GnomeIconEntry;

Property Details

The “browse-dialog-title” property

  “browse-dialog-title”      gchar *

Title for the Browse icon dialog.

Flags: Read / Write

Default value: NULL


The “filename” property

  “filename”                 gchar *

Filename that should be displayed in the icon entry.

Flags: Read / Write

Default value: NULL


The “history-id” property

  “history-id”               gchar *

Unique identifier for the icon entry. This will be used to save the history list.

Flags: Read / Write

Default value: NULL


The “pick-dialog” property

  “pick-dialog”              GtkDialog *

Icon picker dialog. You can use this property to get the GtkDialog if you need to modify or query any of its properties.

Flags: Read


The “pixmap-subdir” property

  “pixmap-subdir”            gchar *

Directory that will be searched for icons.

Flags: Read / Write

Default value: NULL

Signal Details

The “browse” signal

void
user_function (GnomeIconEntry *iconentry,
               gpointer        user_data)

Flags: Run Last


The “changed” signal

void
user_function (GnomeIconEntry *iconentry,
               gpointer        user_data)

Flags: Run Last