EShellTaskbar

## EShellTaskbar EShellTaskbar — the bottom of the main window |

## Synopsis

    #include <shell/e-shell-taskbar.h>

    struct              EShellTaskbar;
    GtkWidget *	        e_shell_taskbar_new                 (struct _EShellView *shell_view);
    struct _EShellView * e_shell_taskbar_get_shell_view     (EShellTaskbar *shell_taskbar);
    const gchar *	      e_shell_taskbar_get_message         (EShellTaskbar *shell_taskbar);
    void                e_shell_taskbar_set_message         (EShellTaskbar *shell_taskbar,
                                                             const gchar *message);
    void                e_shell_taskbar_unset_message       (EShellTaskbar *shell_taskbar);
    guint               e_shell_taskbar_get_activity_count  (EShellTaskbar *shell_taskbar);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkWidget
                   +----GtkContainer
                         +----GtkBox
                               +----GtkHBox
                                     +----EShellTaskbar

## Implemented Interfaces

EShellTaskbar implements AtkImplementorIface, GtkBuildable, GtkOrientable and EExtensible.

## Properties

      "message"                  gchar*                : Read / Write / Construct
      "shell-view"               EShellView*           : Read / Write / Construct Only

## Description

## Details

### struct EShellTaskbar

    struct EShellTaskbar;

Contains only private data that should be read and manipulated using the functions below.

### e_shell_taskbar_new ()

    GtkWidget *	        e_shell_taskbar_new                 (struct _EShellView *shell_view);

Creates a new EShellTaskbar instance belonging to `shell_view`.

`shell_view` : | an EShellView
Returns : | a new EShellTaskbar instance

### e_shell_taskbar_get_shell_view ()

    struct _EShellView * e_shell_taskbar_get_shell_view     (EShellTaskbar *shell_taskbar);

Returns the EShellView that was passed to `e_shell_taskbar_new()`.

`shell_taskbar` : | an EShellTaskbar
Returns : | the EShellView to which `shell_taskbar` belongs

### e_shell_taskbar_get_message ()

    const gchar *	      e_shell_taskbar_get_message         (EShellTaskbar *shell_taskbar);

Returns the message currently shown in the taskbar, or an empty string if no message is shown. Taskbar messages are used primarily for menu tooltips.

`shell_taskbar` : | an EShellTaskbar
Returns : | the current taskbar message

### e_shell_taskbar_set_message ()

    void                e_shell_taskbar_set_message         (EShellTaskbar *shell_taskbar,
                                                             const gchar *message);

Shows a message in the taskbar. If `message` is `NULL` or an empty string, the taskbar message is cleared. Taskbar messages are used primarily for menu tooltips.

`shell_taskbar` : | an EShellTaskbar
`message` : | the message to show

### e_shell_taskbar_unset_message ()

    void                e_shell_taskbar_unset_message       (EShellTaskbar *shell_taskbar);

This is equivalent to passing a `NULL` message to `e_shell_taskbar_set_message()`.

`shell_taskbar` : | an EShellTaskbar

### e_shell_taskbar_get_activity_count ()

    guint               e_shell_taskbar_get_activity_count  (EShellTaskbar *shell_taskbar);

Returns the number of active EActivity instances being tracked.

`shell_taskbar` : | an EShellTaskbar
Returns : | the number of EActivity instances

## Property Details

### The `"message"` property

      "message"                  gchar*                : Read / Write / Construct

The message to display in the taskbar.

Default value: NULL

### The `"shell-view"` property

      "shell-view"               EShellView*           : Read / Write / Construct Only

The EShellView to which the taskbar widget belongs.