e-message-popover: Evolution Utilities Reference Manual

e-message-popover

e-message-popover — a GtkPopover with a message text

Functions

EMessagePopover *	e_message_popover_new ()
void	e_message_popover_set_text ()
void	e_message_popover_set_text_literal ()
void	e_message_popover_set_markup ()
void	e_message_popover_set_markup_literal ()
void	e_message_popover_show ()

Properties

EMessagePopoverFlags

flags

Read / Write / Construct Only

Types and Values

#define	E_TYPE_MESSAGE_POPOVER
	EMessagePopover

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── GtkPopover
                        ╰── EMessagePopover

Implemented Interfaces

EMessagePopover implements AtkImplementorIface and GtkBuildable.

Includes

#include <e-util/e-util.h>

Description

EMessagePopover is a simple modal GtkPopover showing a message attached to a provided widget.

Create the instance with e_message_popover_new(), then set the text of the message with either of e_message_popover_set_text(), e_message_popover_set_markup() or their "literal" variants, and then show the popover with e_message_popover_show(). After this the popover is freed when closed.

Functions

e_message_popover_new ()

EMessagePopover *
e_message_popover_new (GtkWidget *relative_to,
                       EMessagePopoverFlags flags);

Creates a new EMessagePopover. The flags influence the behaviour and look out of the popover.

The relative_to widget cannot be changed after the creation.

Parameters

relative_to	a GtkWidget to tight the message popover to
flags	a bit-or of EMessagePopoverFlags flags

Returns

a new EMessagePopover.

[transfer full]

Since: 3.60

e_message_popover_set_text ()

void
e_message_popover_set_text (EMessagePopover *self,
                            const gchar *format,
                            ...);

Sets plain text content of the message popover, formatted according to format . Use e_message_popover_set_text_literal() to set text directly.

See e_message_popover_set_markup().

Parameters

self	an EMessagePopover
format	a printf-like format of the text
...	parameters for the `format`

Since: 3.60

e_message_popover_set_text_literal ()

void
e_message_popover_set_text_literal (EMessagePopover *self,
                                    const gchar *text);

Sets the text as the message shown in the self .

See e_message_popover_set_text(), e_message_popover_set_markup_literal().

Parameters

self	an EMessagePopover
text	a text to set

Since: 3.60

e_message_popover_set_markup ()

void
e_message_popover_set_markup (EMessagePopover *self,
                              const gchar *format,
                              ...);

Sets markup content of the message popover, formatted according to format . Use e_message_popover_set_markup_literal() to set markup directly.

See e_message_popover_set_text().

Parameters

self	an EMessagePopover
format	a printf-like format of the markup
...	parameters for the `format`

Since: 3.60

e_message_popover_set_markup_literal ()

void
e_message_popover_set_markup_literal (EMessagePopover *self,
                                      const gchar *markup);

Sets the markup as the message shown in the self .

See e_message_popover_set_markup(), e_message_popover_set_text_literal().

Parameters

self	an EMessagePopover
markup	a markup to set

Since: 3.60

e_message_popover_show ()

void
e_message_popover_show (EMessagePopover *self);

Shows the message popover and frees it once it's closed.

Parameters

self

an EMessagePopover.

[transfer full]

Since: 3.60

Types and Values

E_TYPE_MESSAGE_POPOVER

#define E_TYPE_MESSAGE_POPOVER (e_message_popover_get_type ())