MateIconEntry

MateIconEntry

Synopsis

#include <libmateui/libmateui.h>

                    MateIconEntryPrivate;
struct              MateIconEntry;
GtkWidget *         mate_icon_entry_new                (const gchar *history_id,
                                                         const gchar *browse_dialog_title);
void                mate_icon_entry_construct          (MateIconEntry *ientry,
                                                         const gchar *history_id,
                                                         const gchar *browse_dialog_title);
void                mate_icon_entry_set_pixmap_subdir  (MateIconEntry *ientry,
                                                         const gchar *subdir);
gchar *             mate_icon_entry_get_filename       (MateIconEntry *ientry);
gboolean            mate_icon_entry_set_filename       (MateIconEntry *ientry,
                                                         const gchar *filename);
void                mate_icon_entry_set_browse_dialog_title
                                                        (MateIconEntry *ientry,
                                                         const gchar *browse_dialog_title);
void                mate_icon_entry_set_history_id     (MateIconEntry *ientry,
                                                         const gchar *history_id);
void                mate_icon_entry_set_max_saved      (MateIconEntry *ientry,
                                                         guint max_saved);
GtkWidget *         mate_icon_entry_pick_dialog        (MateIconEntry *ientry);
void                mate_icon_entry_set_icon           (MateIconEntry *ientry,
                                                         const gchar *filename);
GtkWidget *         mate_icon_entry_mate_file_entry   (MateIconEntry *ientry);
GtkWidget *         mate_icon_entry_mate_entry        (MateIconEntry *ientry);
GtkWidget *         mate_icon_entry_gtk_entry          (MateIconEntry *ientry);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GtkVBox
                                       +----MateIconEntry

Implemented Interfaces

MateIconEntry implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

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

Signals

  "browse"                                         : Run Last
  "changed"                                        : Run Last

Description

Details

MateIconEntryPrivate

typedef struct _MateIconEntryPrivate MateIconEntryPrivate;


struct MateIconEntry

struct MateIconEntry;


mate_icon_entry_new ()

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

Creates a new icon entry widget

history_id :

the id given to mate_entry_new

browse_dialog_title :

title of the browse dialog and icon selection dialog

Returns :

Returns the new object

mate_icon_entry_construct ()

void                mate_icon_entry_construct          (MateIconEntry *ientry,
                                                         const gchar *history_id,
                                                         const gchar *browse_dialog_title);

For language bindings and subclassing, from C use mate_icon_entry_new

ientry :

the MateIconEntry to work with

history_id :

the id given to mate_entry_new in the browse dialog

browse_dialog_title :

title of the icon selection dialog

mate_icon_entry_set_pixmap_subdir ()

void                mate_icon_entry_set_pixmap_subdir  (MateIconEntry *ientry,
                                                         const gchar *subdir);

Sets the subdirectory below mate'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.

ientry :

the MateIconEntry to work with

subdir :

subdirectory

mate_icon_entry_get_filename ()

gchar *             mate_icon_entry_get_filename       (MateIconEntry *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.

ientry :

the MateIconEntry to work with

Returns :

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

mate_icon_entry_set_filename ()

gboolean            mate_icon_entry_set_filename       (MateIconEntry *ientry,
                                                         const gchar *filename);

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

ientry :

the MateIconEntry to work with

filename :

a filename

Returns :

TRUE if icon was loaded ok, FALSE otherwise

mate_icon_entry_set_browse_dialog_title ()

void                mate_icon_entry_set_browse_dialog_title
                                                        (MateIconEntry *ientry,
                                                         const gchar *browse_dialog_title);

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

ientry :

the MateIconEntry to work with

browse_dialog_title :

title of the icon selection dialog

mate_icon_entry_set_history_id ()

void                mate_icon_entry_set_history_id     (MateIconEntry *ientry,
                                                         const gchar *history_id);

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

ientry :

the MateIconEntry to work with

history_id :

the id given to mate_entry_new in the browse dialog

mate_icon_entry_set_max_saved ()

void                mate_icon_entry_set_max_saved      (MateIconEntry *ientry,
                                                         guint max_saved);

Set the max_saved of the entry in the browse dialog

ientry :

the MateIconEntry to work with

max_saved :

the maximum number of saved entries

Since 2.4


mate_icon_entry_pick_dialog ()

GtkWidget *         mate_icon_entry_pick_dialog        (MateIconEntry *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.

ientry :

the MateIconEntry to work with

Returns :

The pick dialog or NULL if none exists

mate_icon_entry_set_icon ()

void                mate_icon_entry_set_icon           (MateIconEntry *ientry,
                                                         const gchar *filename);

Deprecated in favour of mate_icon_entry_set_filename

ientry :

the MateIconEntry to work with

filename :

a filename

mate_icon_entry_mate_file_entry ()

GtkWidget *         mate_icon_entry_mate_file_entry   (MateIconEntry *ientry);

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

ientry :

the MateIconEntry to work with

Returns :

Returns MateFileEntry widget

mate_icon_entry_mate_entry ()

GtkWidget *         mate_icon_entry_mate_entry        (MateIconEntry *ientry);

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

ientry :

the MateIconEntry to work with

Returns :

Returns MateEntry widget

mate_icon_entry_gtk_entry ()

GtkWidget *         mate_icon_entry_gtk_entry          (MateIconEntry *ientry);

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

ientry :

the MateIconEntry to work with

Returns :

Returns GtkEntry widget

Property Details

The "browse-dialog-title" property

  "browse-dialog-title"      gchar*                : Read / Write

Title for the Browse icon dialog.

Default value: NULL


The "filename" property

  "filename"                 gchar*                : Read / Write

Filename that should be displayed in the icon entry.

Default value: NULL


The "history-id" property

  "history-id"               gchar*                : Read / Write

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

Default value: NULL


The "pick-dialog" property

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


The "pixmap-subdir" property

  "pixmap-subdir"            gchar*                : Read / Write

Directory that will be searched for icons.

Default value: NULL

Signal Details

The "browse" signal

void                user_function                      (MateIconEntry *iconentry,
                                                        gpointer        user_data)      : Run Last

iconentry :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "changed" signal

void                user_function                      (MateIconEntry *iconentry,
                                                        gpointer        user_data)      : Run Last

iconentry :

the object which received the signal.

user_data :

user data set when the signal handler was connected.