aboutsummaryrefslogtreecommitdiffstats
path: root/shell/e-shell-window.h
blob: 0bd71075c93923ce2e47f7188c3cfb6b00236161 (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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * e-shell-window.h
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

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

#ifndef E_SHELL_WINDOW_H
#define E_SHELL_WINDOW_H

#include <shell/e-shell.h>
#include <misc/e-focus-tracker.h>

/* Standard GObject macros */
#define E_TYPE_SHELL_WINDOW \
    (e_shell_window_get_type ())
#define E_SHELL_WINDOW(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_SHELL_WINDOW, EShellWindow))
#define E_SHELL_WINDOW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_SHELL_WINDOW, EShellWindowClass))
#define E_IS_SHELL_WINDOW(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_SHELL_WINDOW))
#define E_IS_SHELL_WINDOW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((obj), E_TYPE_SHELL_WINDOW))
#define E_SHELL_WINDOW_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_SHELL_WINDOW, EShellWindowClass))

G_BEGIN_DECLS

/* Avoid including <e-shell-view.h>, because it includes us! */
struct _EShellView;

typedef struct _EShellWindow EShellWindow;
typedef struct _EShellWindowClass EShellWindowClass;
typedef struct _EShellWindowPrivate EShellWindowPrivate;

/**
 * EShellWindow:
 *
 * Contains only private data that should be read and manipulated using the
 * functions below.
 **/
struct _EShellWindow {
    GtkWindow parent;
    EShellWindowPrivate *priv;
};

struct _EShellWindowClass {
    GtkWindowClass parent_class;

    /* Signals */
    void        (*shell_view_created)   (EShellWindow *shell_window,
                         struct _EShellView *shell_view);

    /* These are all protected methods.  Not for public use. */
    GtkWidget * (*construct_menubar)    (EShellWindow *shell_window);
    GtkWidget * (*construct_toolbar)    (EShellWindow *shell_window);
    GtkWidget * (*construct_sidebar)    (EShellWindow *shell_window);
    GtkWidget * (*construct_content)    (EShellWindow *shell_window);
    GtkWidget * (*construct_taskbar)    (EShellWindow *shell_window);
    struct _EShellView *
            (*create_shell_view)    (EShellWindow *shell_window,
                         const gchar *view_name);
};

GType       e_shell_window_get_type     (void);
GtkWidget * e_shell_window_new      (EShell *shell,
                         gboolean safe_mode,
                         const gchar *geometry);
EShell *    e_shell_window_get_shell    (EShellWindow *shell_window);
struct _EShellView *
        e_shell_window_get_shell_view   (EShellWindow *shell_window,
                         const gchar *view_name);
struct _EShellView *
        e_shell_window_peek_shell_view  (EShellWindow *shell_window,
                         const gchar *view_name);
GtkAction * e_shell_window_get_shell_view_action
                        (EShellWindow *shell_window,
                         const gchar *view_name);
EFocusTracker * e_shell_window_get_focus_tracker(EShellWindow *shell_window);
GtkUIManager *  e_shell_window_get_ui_manager   (EShellWindow *shell_window);
GtkAction * e_shell_window_get_action   (EShellWindow *shell_window,
                         const gchar *action_name);
GtkActionGroup *e_shell_window_get_action_group (EShellWindow *shell_window,
                         const gchar *group_name);
GtkWidget * e_shell_window_get_managed_widget
                        (EShellWindow *shell_window,
                         const gchar *widget_path);
const gchar *   e_shell_window_get_active_view  (EShellWindow *shell_window);
void        e_shell_window_set_active_view  (EShellWindow *shell_window,
                         const gchar *view_name);
gboolean    e_shell_window_get_safe_mode    (EShellWindow *shell_window);
void        e_shell_window_set_safe_mode    (EShellWindow *shell_window,
                         gboolean safe_mode);
void        e_shell_window_add_action_group (EShellWindow *shell_window,
                         const gchar *group_name);
gboolean    e_shell_window_get_sidebar_visible
                        (EShellWindow *shell_window);
void        e_shell_window_set_sidebar_visible
                        (EShellWindow *shell_window,
                         gboolean sidebar_visible);
gboolean    e_shell_window_get_switcher_visible
                        (EShellWindow *shell_window);
void        e_shell_window_set_switcher_visible
                        (EShellWindow *shell_window,
                         gboolean switcher_visible);
gboolean    e_shell_window_get_taskbar_visible
                        (EShellWindow *shell_window);
void        e_shell_window_set_taskbar_visible
                        (EShellWindow *shell_window,
                         gboolean taskbar_visible);
gboolean    e_shell_window_get_toolbar_visible
                        (EShellWindow *shell_window);
void        e_shell_window_set_toolbar_visible
                        (EShellWindow *shell_window,
                         gboolean toolbar_visible);

/* These should be called from the shell backend's window_created() handler. */

void        e_shell_window_register_new_item_actions
                        (EShellWindow *shell_window,
                         const gchar *backend_name,
                         GtkActionEntry *entries,
                         guint n_entries);
void        e_shell_window_register_new_source_actions
                        (EShellWindow *shell_window,
                         const gchar *backend_name,
                         GtkActionEntry *entries,
                         guint n_entries);

G_END_DECLS

#endif /* E_SHELL_WINDOW_H */