EphyDialog

EphyDialog — A customized GtkDialog for Epiphany

Synopsis

                    EphyDialog;
                    EphyDialogProperty;
EphyDialog *        ephy_dialog_new                     (void);
EphyDialog *        ephy_dialog_new_with_parent         (GtkWidget *parent_window);
void                ephy_dialog_construct               (EphyDialog *dialog,
                                                         const char *file,
                                                         const char *name,
                                                         const char *domain);
void                ephy_dialog_set_size_group          (EphyDialog *dialog,
                                                         const char *first_id,
                                                         ...);
int                 ephy_dialog_run                     (EphyDialog *dialog);
void                ephy_dialog_show                    (EphyDialog *dialog);
void                ephy_dialog_hide                    (EphyDialog *dialog);
void                ephy_dialog_set_parent              (EphyDialog *dialog,
                                                         GtkWidget *parent);
GtkWidget *         ephy_dialog_get_parent              (EphyDialog *dialog);
GtkWidget *         ephy_dialog_get_control             (EphyDialog *dialog,
                                                         const char *property_id);
void                ephy_dialog_get_controls            (EphyDialog *dialog,
                                                         const char *first_id,
                                                         ...);

Object Hierarchy

  GObject
   +----EphyDialog

Properties

  "default-height"           gint                  : Read / Write / Construct Only
  "default-width"            gint                  : Read / Write / Construct Only
  "parent-window"            GtkWindow*            : Read / Write
  "persist-position"         gboolean              : Read / Write / Construct Only

Signals

  "changed"                                        : Has Details

Description

A customized GtkDialog for Epiphany.

Details

EphyDialog

typedef struct _EphyDialog EphyDialog;

EphyDialogProperty

typedef struct _EphyDialogProperty EphyDialogProperty;

ephy_dialog_new ()

EphyDialog *        ephy_dialog_new                     (void);

Creates a new EphyDialog.

Returns :

 a new EphyDialog

ephy_dialog_new_with_parent ()

EphyDialog *        ephy_dialog_new_with_parent         (GtkWidget *parent_window);

Creates a new EphyDialog with parent_window as its parent.

parent_window :

 a window to be parent of the new dialog

Returns :

 a new EphyDialog

ephy_dialog_construct ()

void                ephy_dialog_construct               (EphyDialog *dialog,
                                                         const char *file,
                                                         const char *name,
                                                         const char *domain);

Constructs the widget part of dialog using the widget identified by name in the GtkBuilder file found at file.

dialog :

 an EphyDialog

file :

 the path to a GtkBuilder file

name :

 name of the widget to use for dialog, found in file

domain :

 translation domain to set for dialog

ephy_dialog_set_size_group ()

void                ephy_dialog_set_size_group          (EphyDialog *dialog,
                                                         const char *first_id,
                                                         ...);

Put first_id and Varargs widgets into the same GtkSizeGroup. Note that this are all widgets inside dialog.

dialog :

 an EphyDialog

first_id :

 id of a widget in dialog

ephy_dialog_run ()

int                 ephy_dialog_run                     (EphyDialog *dialog);

Runs gtk_dialog_run on dialog and waits for a response.

dialog :

 an EphyDialog

Returns :

 the user response to gtk_dialog_run or 0 if dialog is not valid

ephy_dialog_show ()

void                ephy_dialog_show                    (EphyDialog *dialog);

Shows dialog on screen.

dialog :

 an EphyDialog

ephy_dialog_hide ()

void                ephy_dialog_hide                    (EphyDialog *dialog);

Calls gtk_widget_hide on dialog.

dialog :

 an EphyDialog

ephy_dialog_set_parent ()

void                ephy_dialog_set_parent              (EphyDialog *dialog,
                                                         GtkWidget *parent);

Sets parent as the parent-window of dialog.

dialog :

 an EphyDialog

parent :

 new parent for dialog

ephy_dialog_get_parent ()

GtkWidget *         ephy_dialog_get_parent              (EphyDialog *dialog);

Gets dialog's parent-window.

dialog :

 an EphyDialog

Returns :

 the parent-window of dialog. [transfer none]

ephy_dialog_get_control ()

GtkWidget *         ephy_dialog_get_control             (EphyDialog *dialog,
                                                         const char *property_id);

Gets the internal widget corresponding to property_id from dialog.

dialog :

 an EphyDialog

property_id :

 the string identifier of the requested control

Returns :

 the GtkWidget corresponding to property_id or NULL. [transfer none]

ephy_dialog_get_controls ()

void                ephy_dialog_get_controls            (EphyDialog *dialog,
                                                         const char *first_id,
                                                         ...);

Gets the requested controls according to given property-store_location pairs. Properties are given as strings (const char *), controls are returned as GtkWidget elements. Rename to: ephy_dialog_get_controls

dialog :

 an EphyDialog

first_id :

 identifier of the requested control

Property Details

The "default-height" property

  "default-height"           gint                  : Read / Write / Construct Only

The dialog default height.

Allowed values: >= -1

Default value: -1

The "default-width" property

  "default-width"            gint                  : Read / Write / Construct Only

The dialog default width.

Allowed values: >= -1

Default value: -1

The "parent-window" property

  "parent-window"            GtkWindow*            : Read / Write

Dialog's parent window.

The "persist-position" property

  "persist-position"         gboolean              : Read / Write / Construct Only

If dialog position should be persistent.

Default value: FALSE

Signal Details

The "changed" signal

void                user_function                      (EphyDialog *dialog,
                                                        gpointer    value,
                                                        gpointer    user_data)      : Has Details

Emitted everytime a child widget of the dialog has its changed or clicked signal emitted.

dialog :

 the object on which the signal is emitted

value :

 new value of the modified widget, as a GValue

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.18