GnomeIconEntry

Name

GnomeIconEntry -- 

Synopsis


#include <libgnomeui/libgnomeui.h>


struct      GnomeIconEntryPrivate;
struct      GnomeIconEntry;
GtkWidget*  gnome_icon_entry_new            (const gchar *history_id,
                                             const gchar *browse_dialog_title);
void        gnome_icon_entry_construct      (GnomeIconEntry *ientry,
                                             const gchar *history_id,
                                             const gchar *browse_dialog_title);
void        gnome_icon_entry_set_pixmap_subdir
                                            (GnomeIconEntry *ientry,
                                             const gchar *subdir);
gchar*      gnome_icon_entry_get_filename   (GnomeIconEntry *ientry);
gboolean    gnome_icon_entry_set_filename   (GnomeIconEntry *ientry,
                                             const gchar *filename);
void        gnome_icon_entry_set_browse_dialog_title
                                            (GnomeIconEntry *ientry,
                                             const gchar *browse_dialog_title);
void        gnome_icon_entry_set_history_id (GnomeIconEntry *ientry,
                                             const gchar *history_id);
GtkWidget*  gnome_icon_entry_pick_dialog    (GnomeIconEntry *ientry);
void        gnome_icon_entry_set_icon       (GnomeIconEntry *ientry,
                                             const gchar *filename);
GtkWidget*  gnome_icon_entry_gnome_file_entry
                                            (GnomeIconEntry *ientry);
GtkWidget*  gnome_icon_entry_gnome_entry    (GnomeIconEntry *ientry);
GtkWidget*  gnome_icon_entry_gtk_entry      (GnomeIconEntry *ientry);

Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkVBox
                                 +----GnomeIconEntry

Properties


  "history-id"           gchararray           : Read / Write
  "browse-dialog-title"  gchararray           : Read / Write
  "pixmap-subdir"        gchararray           : Read / Write
  "filename"             gchararray           : Read / Write
  "pick-dialog"          GtkDialog            : Read

Signal Prototypes


"browse"    void        user_function      (GnomeIconEntry *iconentry,
                                            gpointer user_data);
"changed"   void        user_function      (GnomeIconEntry *iconentry,
                                            gpointer user_data);

Description

Details

struct GnomeIconEntryPrivate

struct GnomeIconEntryPrivate;


struct GnomeIconEntry

struct GnomeIconEntry;


gnome_icon_entry_new ()

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

Creates a new icon entry widget


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


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.


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.


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


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.


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


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.


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


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


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


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

Properties

"history-id" (gchararray : Read / Write)

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

"browse-dialog-title" (gchararray : Read / Write)

Title for the Browse icon dialog.

"pixmap-subdir" (gchararray : Read / Write)

Directory that will be searched for icons.

"filename" (gchararray : Read / Write)

Filename that should be displayed in the icon entry.

"pick-dialog" (GtkDialog : Read)

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

Signals

The "browse" signal

void        user_function                  (GnomeIconEntry *iconentry,
                                            gpointer user_data);


The "changed" signal

void        user_function                  (GnomeIconEntry *iconentry,
                                            gpointer user_data);