## GeditMessageArea

GeditMessageArea

## Synopsis

                        GeditMessageAreaPrivate;
                        GeditMessageArea;
    GtkWidget*          gedit_message_area_new              (void);
    GtkWidget*          gedit_message_area_new_with_buttons (const gchar *first_button_text,
                                                             ...);
    void                gedit_message_area_set_contents     (GeditMessageArea *message_area,
                                                             GtkWidget *contents);
    void                gedit_message_area_add_action_widget
                                                            (GeditMessageArea *message_area,
                                                             GtkWidget *child,
                                                             gint response_id);
    GtkWidget*          gedit_message_area_add_button       (GeditMessageArea *message_area,
                                                             const gchar *button_text,
                                                             gint response_id);
    GtkWidget*          gedit_message_area_add_stock_button_with_text
                                                            (GeditMessageArea *message_area,
                                                             const gchar *text,
                                                             const gchar *stock_id,
                                                             gint response_id);
    void                gedit_message_area_add_buttons      (GeditMessageArea *message_area,
                                                             const gchar *first_button_text,
                                                             ...);
    void                gedit_message_area_set_response_sensitive
                                                            (GeditMessageArea *message_area,
                                                             gint response_id,
                                                             gboolean setting);
    void                gedit_message_area_set_default_response
                                                            (GeditMessageArea *message_area,
                                                             gint response_id);
    void                gedit_message_area_response         (GeditMessageArea *message_area,
                                                             gint response_id);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkHBox
                                           +----GeditMessageArea
                                                 +----GeditProgressMessageArea

## Implemented Interfaces

GeditMessageArea implements AtkImplementorIface and GtkBuildable.

## Signals

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

## Description

## Details

### GeditMessageAreaPrivate

    typedef struct _GeditMessageAreaPrivate GeditMessageAreaPrivate;

### GeditMessageArea

    typedef struct _GeditMessageArea GeditMessageArea;

### gedit_message_area_new ()

    GtkWidget*          gedit_message_area_new              (void);

Creates a new GeditMessageArea object.

Returns : | a new GeditMessageArea object

### gedit_message_area_new_with_buttons ()

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

Creates a new GeditMessageArea with buttons. Button text/response ID pairs should be listed, with a NULL pointer ending the list. Button text can be either a stock ID such as GTK_STOCK_OK, or some arbitrary text. A response ID can be any positive number, or one of the values in the GtkResponseType enumeration. If the user clicks one of these dialog buttons, GeditMessageArea will emit the "response" signal with the corresponding response ID.

`first_button_text` : | stock ID or text to go in first button, or NULL
`...` : | response ID for first button, then additional buttons, ending with NULL
Returns : | a new GeditMessageArea

### gedit_message_area_set_contents ()

    void                gedit_message_area_set_contents     (GeditMessageArea *message_area,
                                                             GtkWidget *contents);

Adds the `contents` widget to the contents area of GeditMessageArea.

`message_area` : | a GeditMessageArea
`contents` : | widget you want to add to the contents area

### gedit_message_area_add_action_widget ()

    void                gedit_message_area_add_action_widget
                                                            (GeditMessageArea *message_area,
                                                             GtkWidget *child,
                                                             gint response_id);

`message_area` : |
`child` : |
`response_id` : |

### gedit_message_area_add_button ()

    GtkWidget*          gedit_message_area_add_button       (GeditMessageArea *message_area,
                                                             const gchar *button_text,
                                                             gint response_id);

Adds a button with the given text (or a stock button, if button_text is a stock ID) and sets things up so that clicking the button will emit the "response" signal with the given response_id. The button is appended to the end of the message area's action area. The button widget is returned, but usually you don't need it.

`message_area` : | a GeditMessageArea
`button_text` : | text of button, or stock ID
`response_id` : | response ID for the button
Returns : | the button widget that was added

### gedit_message_area_add_stock_button_with_text ()

    GtkWidget*          gedit_message_area_add_stock_button_with_text
                                                            (GeditMessageArea *message_area,
                                                             const gchar *text,
                                                             const gchar *stock_id,
                                                             gint response_id);

Same as `gedit_message_area_add_button()` but with a specific text.

`message_area` : | a GeditMessageArea
`text` : | the text to visualize in the button
`stock_id` : | the stock ID of the button
`response_id` : | a response ID
Returns : |

### gedit_message_area_add_buttons ()

    void                gedit_message_area_add_buttons      (GeditMessageArea *message_area,
                                                             const gchar *first_button_text,
                                                             ...);

Adds more buttons, same as calling `gedit_message_area_add_button()` repeatedly. The variable argument list should be NULL-terminated as with `gedit_message_area_new_with_buttons()`. Each button must have both text and response ID.

`message_area` : | a GeditMessageArea
`first_button_text` : | button text or stock ID
`...` : | response ID for first button, then more text-response_id pairs

### gedit_message_area_set_response_sensitive ()

    void                gedit_message_area_set_response_sensitive
                                                            (GeditMessageArea *message_area,
                                                             gint response_id,
                                                             gboolean setting);

Calls gtk_widget_set_sensitive (widget, setting) for each widget in the dialog's action area with the given response_id. A convenient way to sensitize/desensitize dialog buttons.

`message_area` : | a GeditMessageArea
`response_id` : | a response ID
`setting` : | TRUE for sensitive

### gedit_message_area_set_default_response ()

    void                gedit_message_area_set_default_response
                                                            (GeditMessageArea *message_area,
                                                             gint response_id);

Emits the 'response' signal with the given `response_id`.

`message_area` : | a GeditMessageArea
`response_id` : | a response ID

### gedit_message_area_response ()

    void                gedit_message_area_response         (GeditMessageArea *message_area,
                                                             gint response_id);

`message_area` : |
`response_id` : |

## Signal Details

### The `"close"` signal

    void                user_function                      (GeditMessageArea *geditmessagearea,
                                                            gpointer          user_data)             : Run Last / Action

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

### The `"response"` signal

    void                user_function                      (GeditMessageArea *geditmessagearea,
                                                            gint              arg1,
                                                            gpointer          user_data)             : Run Last

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