GnomeDItemEdit

GnomeDItemEdit —

Synopsis


#include <libgnome/gnome-ditem-edit.h>


            GnomeDItemEdit;
GtkWidget*  gnome_ditem_edit_new            (void);
void        gnome_ditem_edit_clear          (GnomeDItemEdit *dee);
gboolean    gnome_ditem_edit_load_uri       (GnomeDItemEdit *dee,
                                             const gchar *uri,
                                             GError **error);
void        gnome_ditem_edit_set_ditem      (GnomeDItemEdit *dee,
                                             const GnomeDesktopItem *ditem);
GnomeDesktopItem* gnome_ditem_edit_get_ditem
                                            (GnomeDItemEdit *dee);
gchar*      gnome_ditem_edit_get_icon       (GnomeDItemEdit *dee);
gchar*      gnome_ditem_edit_get_name       (GnomeDItemEdit *dee);
void        gnome_ditem_edit_set_entry_type (GnomeDItemEdit *dee,
                                             const char *type);
void        gnome_ditem_edit_set_directory_only
                                            (GnomeDItemEdit *dee,
                                             gboolean directory_only);
void        gnome_ditem_edit_grab_focus     (GnomeDItemEdit *dee);
void        gnome_ditem_edit_set_editable   (GnomeDItemEdit *dee,
                                             gboolean editable);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkNotebook
                                 +----GnomeDItemEdit

Implemented Interfaces

GnomeDItemEdit implements AtkImplementorIface.

Signals


"changed"   void        user_function      (GnomeDItemEdit *ditemedit,
                                            gpointer        user_data)      : Run last
"icon-changed"
            void        user_function      (GnomeDItemEdit *ditemedit,
                                            gpointer        user_data)      : Run last
"name-changed"
            void        user_function      (GnomeDItemEdit *ditemedit,
                                            gpointer        user_data)      : Run last

Description

Details

GnomeDItemEdit

typedef struct _GnomeDItemEdit GnomeDItemEdit;

gnome_ditem_edit_new ()

GtkWidget*  gnome_ditem_edit_new            (void);

Creates a new GnomeDItemEdit widget. A widget for the purpose of editing GnomeDesktopItems

Returns : Newly-created GnomeDItemEdit widget.

gnome_ditem_edit_clear ()

void        gnome_ditem_edit_clear          (GnomeDItemEdit *dee);

Clear the editting areas. And unref any stored GnomeDesktopItem.

dee : GnomeDItemEdit object to work with

gnome_ditem_edit_load_uri ()

gboolean    gnome_ditem_edit_load_uri       (GnomeDItemEdit *dee,
                                             const gchar *uri,
                                             GError **error);

Load a .desktop file and update the editting areas of the object accordingly.

dee : GnomeDItemEdit object to work with
uri : file to load into the editting areas
error : location to store error, or NULL
Returns : TRUE if successful, FALSE otherwise

gnome_ditem_edit_set_ditem ()

void        gnome_ditem_edit_set_ditem      (GnomeDItemEdit *dee,
                                             const GnomeDesktopItem *ditem);

Set the ditem edit UI to this item. This makes a copy internally so do not worry about modifying this item later yourself. Note that since the entire item is stored, any hidden fields will be preserved when you later get it with gnome_ditem_edit_get_ditem.

dee : GnomeDItemEdit object to work with
ditem : GnomeDesktopItem to use

gnome_ditem_edit_get_ditem ()

GnomeDesktopItem* gnome_ditem_edit_get_ditem
                                            (GnomeDItemEdit *dee);

Get the current status of the editting areas as a GnomeDesktopItem structure. It will give you a pointer to the internal structure. If you wish to modify it, make a copy of it with gnome_desktop_item_copy

dee : GnomeDItemEdit object to work with
Returns : a pointer to the internal GnomeDesktopItem structure.

gnome_ditem_edit_get_icon ()

gchar*      gnome_ditem_edit_get_icon       (GnomeDItemEdit *dee);

Get the icon filename.

dee : GnomeDItemEdit object to work with
Returns : a newly allocated string with the filename of the icon

gnome_ditem_edit_get_name ()

gchar*      gnome_ditem_edit_get_name       (GnomeDItemEdit *dee);

Get the Name field from the ditem for the current language.

dee : GnomeDItemEdit object to work with
Returns : a newly allocated string with the name of the ditem

gnome_ditem_edit_set_entry_type ()

void        gnome_ditem_edit_set_entry_type (GnomeDItemEdit *dee,
                                             const char *type);

dee :
type :

gnome_ditem_edit_set_directory_only ()

void        gnome_ditem_edit_set_directory_only
                                            (GnomeDItemEdit *dee,
                                             gboolean directory_only);

dee :
directory_only :

gnome_ditem_edit_grab_focus ()

void        gnome_ditem_edit_grab_focus     (GnomeDItemEdit *dee);

dee :

gnome_ditem_edit_set_editable ()

void        gnome_ditem_edit_set_editable   (GnomeDItemEdit *dee,
                                             gboolean editable);

dee :
editable :

Signal Details

The "changed" signal

void        user_function                  (GnomeDItemEdit *ditemedit,
                                            gpointer        user_data)      : Run last

ditemedit : the object which received the signal.
user_data : user data set when the signal handler was connected.

The "icon-changed" signal

void        user_function                  (GnomeDItemEdit *ditemedit,
                                            gpointer        user_data)      : Run last

ditemedit : the object which received the signal.
user_data : user data set when the signal handler was connected.

The "name-changed" signal

void        user_function                  (GnomeDItemEdit *ditemedit,
                                            gpointer        user_data)      : Run last

ditemedit : the object which received the signal.
user_data : user data set when the signal handler was connected.