aboutsummaryrefslogtreecommitdiffstats
path: root/shell/evolution-shell-component.h
blob: 6fe70ac8feb2afbb1e0b7fc1b285b0aba32b8fea (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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* evolution-shell-component.h
 *
 * Copyright (C) 2000, 2001 Ximian, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Ettore Perazzoli
 */

#ifndef EVOLUTION_SHELL_COMPONENT_H
#define EVOLUTION_SHELL_COMPONENT_H

#include <bonobo/bonobo-xobject.h>
#include <bonobo/bonobo-control.h>

#include "Evolution.h"

#include "evolution-shell-client.h"

#ifdef cplusplus
extern "C" {
#pragma }
#endif /* cplusplus */

#define EVOLUTION_TYPE_SHELL_COMPONENT            (evolution_shell_component_get_type ())
#define EVOLUTION_SHELL_COMPONENT(obj)            (GTK_CHECK_CAST ((obj), EVOLUTION_TYPE_SHELL_COMPONENT, EvolutionShellComponent))
#define EVOLUTION_SHELL_COMPONENT_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), EVOLUTION_TYPE_SHELL_COMPONENT, EvolutionShellComponentClass))
#define EVOLUTION_IS_SHELL_COMPONENT(obj)         (GTK_CHECK_TYPE ((obj), EVOLUTION_TYPE_SHELL_COMPONENT))
#define EVOLUTION_IS_SHELL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EVOLUTION_TYPE_SHELL_COMPONENT))

#define EVOLUTION_SHELL_COMPONENT_POPUP_PLACEHOLDER "/popups/FolderPopup/ComponentPlaceholder"


typedef struct _EvolutionShellComponent        EvolutionShellComponent;
typedef struct _EvolutionShellComponentPrivate EvolutionShellComponentPrivate;
typedef struct _EvolutionShellComponentClass   EvolutionShellComponentClass;

enum _EvolutionShellComponentResult {
    EVOLUTION_SHELL_COMPONENT_OK,
    EVOLUTION_SHELL_COMPONENT_CORBAERROR,
    EVOLUTION_SHELL_COMPONENT_INTERRUPTED,
    EVOLUTION_SHELL_COMPONENT_INVALIDARG,
    EVOLUTION_SHELL_COMPONENT_ALREADYOWNED,
    EVOLUTION_SHELL_COMPONENT_NOTOWNED,
    EVOLUTION_SHELL_COMPONENT_NOTFOUND,
    EVOLUTION_SHELL_COMPONENT_UNSUPPORTEDTYPE,
    EVOLUTION_SHELL_COMPONENT_UNSUPPORTEDSCHEMA,
    EVOLUTION_SHELL_COMPONENT_UNSUPPORTEDOPERATION,
    EVOLUTION_SHELL_COMPONENT_INTERNALERROR,
    EVOLUTION_SHELL_COMPONENT_BUSY,
    EVOLUTION_SHELL_COMPONENT_EXISTS,
    EVOLUTION_SHELL_COMPONENT_INVALIDURI,
    EVOLUTION_SHELL_COMPONENT_PERMISSIONDENIED,
    EVOLUTION_SHELL_COMPONENT_HASSUBFOLDERS,
    EVOLUTION_SHELL_COMPONENT_NOSPACE,
    EVOLUTION_SHELL_COMPONENT_UNKNOWNERROR
};
typedef enum _EvolutionShellComponentResult EvolutionShellComponentResult;

typedef EvolutionShellComponentResult (* EvolutionShellComponentCreateViewFn)
                                                   (EvolutionShellComponent *shell_component,
                            const char *physical_uri,
                            const char *type,
                            BonoboControl **control_return,
                            void *closure);
typedef void (* EvolutionShellComponentCreateFolderFn) (EvolutionShellComponent *shell_component,
                                const char *physical_uri,
                                const char *type,
                                const GNOME_Evolution_ShellComponentListener listener,
                                void *closure);
typedef void (* EvolutionShellComponentRemoveFolderFn) (EvolutionShellComponent *shell_component,
                                const char *physical_uri,
                            const char *type,
                                const GNOME_Evolution_ShellComponentListener listener,
                                void *closure);
typedef void (* EvolutionShellComponentXferFolderFn)   (EvolutionShellComponent *shell_component,
                            const char *source_physical_uri,
                            const char *destination_physical_uri,
                            const char *type,
                            gboolean remove_source,
                                const GNOME_Evolution_ShellComponentListener listener,
                                void *closure);
typedef void (* EvolutionShellComponentPopulateFolderContextMenuFn) (EvolutionShellComponent *shell_component,
                                   BonoboUIComponent *uic,
                                   const char *physical_uri,
                                   const char *type,
                                   void *closure);
typedef char * (* EvolutionShellComponentGetDndSelectionFn) (EvolutionShellComponent *shell_component,
                                 const char *physical_uri,
                                 int type,
                                 int *format_return,
                                 const char **selection_return,
                                 int *selection_length_return,
                                 void *closure);

struct _EvolutionShellComponentFolderType {
    char *name;
    char *icon_name;
    char *display_name;
    char *description;

    gboolean user_creatable;

    /* The following are NULL-terminated arrays.  */
    char **accepted_dnd_types;
    char **exported_dnd_types;
};
typedef struct _EvolutionShellComponentFolderType EvolutionShellComponentFolderType;

struct _EvolutionShellComponent {
    BonoboXObject parent;

    EvolutionShellComponentPrivate *priv;
};

struct _EvolutionShellComponentClass {
    BonoboXObjectClass parent_class;

    POA_GNOME_Evolution_ShellComponent__epv epv;

    /* Signals.  */

    void (* owner_set)   (EvolutionShellComponent *shell_component,
                  EvolutionShellClient *shell_client,
                  const char *evolution_homedir);
    void (* owner_unset) (EvolutionShellComponent *shell_component);
    void (* debug)       (EvolutionShellComponent *shell_component);

    void (* handle_external_uri) (EvolutionShellComponent *shell_component,
                      const char *uri);

    void (* user_create_new_item) (EvolutionShellComponent *shell_component,
                       const char *id,
                       const char *parent_folder_physical_uri,
                       const char *parent_folder_type);
};


GtkType                  evolution_shell_component_get_type   (void);
void                     evolution_shell_component_construct  (EvolutionShellComponent                            *shell_component,
                                   const EvolutionShellComponentFolderType             folder_types[],
                                   const char                                         *external_uri_schemas[],
                                   EvolutionShellComponentCreateViewFn                 create_view_fn,
                                   EvolutionShellComponentCreateFolderFn               create_folder_fn,
                                   EvolutionShellComponentRemoveFolderFn               remove_folder_fn,
                                   EvolutionShellComponentXferFolderFn                 xfer_folder_fn,
                                   EvolutionShellComponentPopulateFolderContextMenuFn  populate_folder_context_menu_fn,
                                   EvolutionShellComponentGetDndSelectionFn            get_dnd_selection_fn,
                                   void                                               *closure);
EvolutionShellComponent *evolution_shell_component_new        (const EvolutionShellComponentFolderType             folder_types[],
                                   const char                                         *external_uri_schemas[],
                                   EvolutionShellComponentCreateViewFn                 create_view_fn,
                                   EvolutionShellComponentCreateFolderFn               create_folder_fn,
                                   EvolutionShellComponentRemoveFolderFn               remove_folder_fn,
                                   EvolutionShellComponentXferFolderFn                 xfer_folder_fn,
                                   EvolutionShellComponentPopulateFolderContextMenuFn  populate_folder_context_menu_fn,
                                   EvolutionShellComponentGetDndSelectionFn            get_dnd_selection_fn,
                                   void                                               *closure);
EvolutionShellClient    *evolution_shell_component_get_owner  (EvolutionShellComponent                            *shell_component);

void  evolution_shell_component_add_user_creatable_item  (EvolutionShellComponent *shell_component,
                              const char              *id,
                              const char              *description,
                              const char              *menu_description,
                              char                     menu_shortcut);

#ifdef cplusplus
}
#endif /* cplusplus */

#endif /* EVOLUTION_SHELL_COMPONENT_H */