## EogMessageArea

EogMessageArea

## Synopsis

                        EogMessageArea;
    GtkWidget*          eog_message_area_new                (void);
    GtkWidget*          eog_message_area_new_with_buttons   (const gchar *first_button_text,
                                                             ...);
    void                eog_message_area_set_contents       (EogMessageArea *message_area,
                                                             GtkWidget *contents);
    void                eog_message_area_add_action_widget  (EogMessageArea *message_area,
                                                             GtkWidget *child,
                                                             gint response_id);
    GtkWidget*          eog_message_area_add_button         (EogMessageArea *message_area,
                                                             const gchar *button_text,
                                                             gint response_id);
    GtkWidget*          eog_message_area_add_stock_button_with_text
                                                            (EogMessageArea *message_area,
                                                             const gchar *text,
                                                             const gchar *stock_id,
                                                             gint response_id);
    void                eog_message_area_add_buttons        (EogMessageArea *message_area,
                                                             const gchar *first_button_text,
                                                             ...);
    void                eog_message_area_set_response_sensitive
                                                            (EogMessageArea *message_area,
                                                             gint response_id,
                                                             gboolean setting);
    void                eog_message_area_set_default_response
                                                            (EogMessageArea *message_area,
                                                             gint response_id);
    void                eog_message_area_response           (EogMessageArea *message_area,
                                                             gint response_id);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkHBox
                                           +----EogMessageArea

## Implemented Interfaces

EogMessageArea implements GtkBuildable and AtkImplementorIface.

## Signals

      "close"                                          : Run Last / Action
      "response"                                       : Run Last

## Description

## Details

### EogMessageArea

    typedef struct _EogMessageArea EogMessageArea;

### eog_message_area_new ()

    GtkWidget*          eog_message_area_new                (void);

Returns : |

### eog_message_area_new_with_buttons ()

    GtkWidget*          eog_message_area_new_with_buttons   (const gchar *first_button_text,
                                                             ...);

Creates a new EogMessageArea with default buttons.

`first_button_text` : | The text for the first button.
`...` : | additional buttons, terminated with `NULL`.
Returns : | A newly created EogMessageArea widget.

### eog_message_area_set_contents ()

    void                eog_message_area_set_contents       (EogMessageArea *message_area,
                                                             GtkWidget *contents);

Sets the contents of `message_area`. The `contents` will be packed into the message area.

`message_area` : | an EogMessageArea.
`contents` : | a GtkWidget.

### eog_message_area_add_action_widget ()

    void                eog_message_area_add_action_widget  (EogMessageArea *message_area,
                                                             GtkWidget *child,
                                                             gint response_id);

Adds a widget to the action area of `message_area`. Only 'activatable' widgets can be packed into the action area of a EogMessageArea.

`message_area` : | an EogMessageArea.
`child` : | The widget to be packed into the message area.
`response_id` : | A response id for `child`.

### eog_message_area_add_button ()

    GtkWidget*          eog_message_area_add_button         (EogMessageArea *message_area,
                                                             const gchar *button_text,
                                                             gint response_id);

Adds a single button to `message_area`.

`message_area` : | an EogMessageArea.
`button_text` : | The text for the button to be added.
`response_id` : | A response id.
Returns : | The newly added GtkButton.

### eog_message_area_add_stock_button_with_text ()

    GtkWidget*          eog_message_area_add_stock_button_with_text
                                                            (EogMessageArea *message_area,
                                                             const gchar *text,
                                                             const gchar *stock_id,
                                                             gint response_id);

Adds a new button to `message_area` containing a image from stock and a user defined text. Stock items may have a macro defined, like `GTK_STOCK_OK`.

`message_area` : | An EogMessageArea.
`text` : | The text for the button.
`stock_id` : | A stock item.
`response_id` : | A response id for the button.
Returns : | the newly added GtkButton.

### eog_message_area_add_buttons ()

    void                eog_message_area_add_buttons        (EogMessageArea *message_area,
                                                             const gchar *first_button_text,
                                                             ...);

Adds one or more buttons to `message_area`.

`message_area` : | An EogMessageArea.
`first_button_text` : | the text for the first button to be added.
`...` : | text for extra buttons, terminated with `NULL`.

### eog_message_area_set_response_sensitive ()

    void                eog_message_area_set_response_sensitive
                                                            (EogMessageArea *message_area,
                                                             gint response_id,
                                                             gboolean setting);

Sets sensitivity in `message_area`'s child widget associated to `response_id`.

`message_area` : | a EogMessageArea.
`response_id` : | the response id associated to the widget whose sensitivity is to be set.
`setting` : | `TRUE` to set the widget sensitive, `FALSE` otherwise.

### eog_message_area_set_default_response ()

    void                eog_message_area_set_default_response
                                                            (EogMessageArea *message_area,
                                                             gint response_id);

Sets the default response in `message_area`. This is done by making the widget associated to `response_id` the default widget.

`message_area` : | an EogMessageArea.
`response_id` : | the response id associated to the widget to be set default.

### eog_message_area_response ()

    void                eog_message_area_response           (EogMessageArea *message_area,
                                                             gint response_id);

Emits a "response" signal to the given EogMessageArea.

`message_area` : | an EogMessageArea.
`response_id` : | The response id for the emission.

## Signal Details

### The `"close"` signal

    void                user_function                      (EogMessageArea *eogmessagearea,
                                                            gpointer        user_data)           : Run Last / Action

`eogmessagearea` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The `"response"` signal

    void                user_function                      (EogMessageArea *message_area,
                                                            gint            arg1,
                                                            gpointer        user_data)         : Run Last

The "response" signal is emitted when one of the activatable widgets packed into `message_area` is activated.

`message_area` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.