aboutsummaryrefslogtreecommitdiffstats
path: root/shell/e-shell-view.h
blob: f9f027d0bb11c98da906e14b18513fd8d321ef36 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*-
 * e-shell-view.h
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

/**
 * SECTION: e-shell-view
 * @short_description: views within the main window
 * @include: shell/e-shell-view.h
 **/

#ifndef E_SHELL_VIEW_H
#define E_SHELL_VIEW_H

#include <shell/e-shell-common.h>
#include <shell/e-shell-content.h>
#include <shell/e-shell-module.h>
#include <shell/e-shell-sidebar.h>
#include <shell/e-shell-taskbar.h>
#include <shell/e-shell-window.h>

#include <widgets/misc/e-activity.h>
#include <widgets/menus/gal-view-collection.h>

/* Standard GObject macros */
#define E_TYPE_SHELL_VIEW \
    (e_shell_view_get_type ())
#define E_SHELL_VIEW(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_SHELL_VIEW, EShellView))
#define E_SHELL_VIEW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_SHELL_VIEW, EShellViewClass))
#define E_IS_SHELL_VIEW(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_SHELL_VIEW))
#define E_IS_SHELL_VIEW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_SHELL_VIEW))
#define E_SHELL_VIEW_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_SHELL_VIEW, EShellViewClass))

G_BEGIN_DECLS

typedef struct _EShellView EShellView;
typedef struct _EShellViewClass EShellViewClass;
typedef struct _EShellViewPrivate EShellViewPrivate;

/**
 * EShellView:
 *
 * Contains only private data that should be read and manipulated using the
 * functions below.
 **/
struct _EShellView {
    GObject parent;
    EShellViewPrivate *priv;
};

struct _EShellViewClass {
    GObjectClass parent_class;

    /* Initial switcher action values. */
    const gchar *label;
    const gchar *icon_name;

    /* Base name of the UI definition file. */
    const gchar *ui_definition;

    /* Widget path to the search entry popup menu. */
    const gchar *search_options;

    /* Subclasses should set this via the "class_data" field in
     * the GTypeInfo they pass to g_type_module_register_type(). */
    GTypeModule *type_module;

    /* A unique instance is created for each subclass. */
    GalViewCollection *view_collection;

    /* Factory Methods */
    GtkWidget * (*new_shell_content)    (EShellView *shell_view);
    GtkWidget * (*new_shell_sidebar)    (EShellView *shell_view);
    GtkWidget * (*new_shell_taskbar)    (EShellView *shell_view);

    /* Signals */
    void        (*toggled)      (EShellView *shell_view);
    void        (*update_actions)   (EShellView *shell_view);
};

GType       e_shell_view_get_type       (void);
const gchar *   e_shell_view_get_name       (EShellView *shell_view);
GtkAction * e_shell_view_get_action     (EShellView *shell_view);
const gchar *   e_shell_view_get_title      (EShellView *shell_view);
void        e_shell_view_set_title      (EShellView *shell_view,
                         const gchar *title);
const gchar *   e_shell_view_get_view_id    (EShellView *shell_view);
void        e_shell_view_set_view_id    (EShellView *shell_view,
                         const gchar *view_id);
gboolean    e_shell_view_is_active      (EShellView *shell_view);
void        e_shell_view_add_activity   (EShellView *shell_view,
                         EActivity *activity);
gint        e_shell_view_get_page_num   (EShellView *shell_view);
GtkSizeGroup *  e_shell_view_get_size_group (EShellView *shell_view);
EShellContent * e_shell_view_get_shell_content  (EShellView *shell_view);
EShellSidebar * e_shell_view_get_shell_sidebar  (EShellView *shell_view);
EShellTaskbar * e_shell_view_get_shell_taskbar  (EShellView *shell_view);
EShellWindow *  e_shell_view_get_shell_window   (EShellView *shell_view);
EShellModule *  e_shell_view_get_shell_module   (EShellView *shell_view);
void        e_shell_view_update_actions (EShellView *shell_view);
void        e_shell_view_show_popup_menu    (EShellView *shell_view,
                         const gchar *widget_path,
                         GdkEventButton *event);

G_END_DECLS

#endif /* E_SHELL_VIEW_H */