path: root/modules/addressbook/e-book-shell-view-private.h

/*
 * e-book-shell-view-private.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)
 *
 */

#ifndef E_BOOK_SHELL_VIEW_PRIVATE_H
#define E_BOOK_SHELL_VIEW_PRIVATE_H

#include "e-book-shell-view.h"

#include <string.h>
#include <glib/gi18n.h>
#include <gdk/gdkkeysyms.h>
#include <libebook/e-book.h>
#include <libedataserver/e-categories.h>
#include <libedataserver/e-sexp.h>
#include <libedataserverui/e-book-auth-util.h>
#include <libedataserverui/e-source-selector.h>

#include "e-util/e-util.h"
#include "e-util/e-file-utils.h"
#include "e-util/gconf-bridge.h"
#include "shell/e-shell-content.h"
#include "shell/e-shell-searchbar.h"
#include "shell/e-shell-sidebar.h"
#include "shell/e-shell-utils.h"
#include "misc/e-popup-action.h"
#include "misc/e-selectable.h"

#include "addressbook/util/eab-book-util.h"
#include "addressbook/gui/contact-editor/e-contact-editor.h"
#include "addressbook/gui/contact-list-editor/e-contact-list-editor.h"
#include "addressbook/gui/widgets/eab-gui-util.h"
#include "addressbook/gui/widgets/e-addressbook-view.h"
#include "addressbook/gui/widgets/e-addressbook-selector.h"

#include "e-book-shell-backend.h"
#include "e-book-shell-content.h"
#include "e-book-shell-sidebar.h"
#include "e-book-shell-view-actions.h"

/* backward-compatibility cruft */
#include "e-util/gtk-compat.h"

#define E_BOOK_SHELL_VIEW_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE \
    ((obj), E_TYPE_BOOK_SHELL_VIEW, EBookShellViewPrivate))

/* Shorthand, requires a variable named "shell_window". */
#define ACTION(name) \
    (E_SHELL_WINDOW_ACTION_##name (shell_window))
#define ACTION_GROUP(name) \
    (E_SHELL_WINDOW_ACTION_GROUP_##name (shell_window))

/* For use in dispose() methods. */
#define DISPOSE(obj) \
    G_STMT_START { \
    if ((obj) != NULL) { g_object_unref (obj); (obj) = NULL; } \
    } G_STMT_END

/* ETable Specifications */
#define ETSPEC_FILENAME     "e-addressbook-view.etspec"

G_BEGIN_DECLS

typedef struct _EditorUidClosure EditorUidClosure;

struct _EditorUidClosure {
    GtkWidget *editor;
    gchar *uid;
    EBookShellView *view;
};

/* List these in the order to be displayed.
 * Positive values are reserved for categories. */
enum {
    CONTACT_FILTER_ANY_CATEGORY = -2,
    CONTACT_FILTER_UNMATCHED    = -1
};

/* List these in the order to be displayed. */
enum {
    CONTACT_SEARCH_ADVANCED = -1,
    CONTACT_SEARCH_NAME_CONTAINS,
    CONTACT_SEARCH_EMAIL_BEGINS_WITH,
    CONTACT_SEARCH_ANY_FIELD_CONTAINS
};

struct _EBookShellViewPrivate {

    /* These are just for convenience. */
    EBookShellBackend *book_shell_backend;
    EBookShellContent *book_shell_content;
    EBookShellSidebar *book_shell_sidebar;

    GHashTable *uid_to_view;
    GHashTable *uid_to_editor;

    gint preview_index;

    /* Can track whether search changed while locked,
     * but it is not usable at the moment. */
    gint search_locked;
};

void        e_book_shell_view_private_init
                    (EBookShellView *book_shell_view,
                     EShellViewClass *shell_view_class);
void        e_book_shell_view_private_constructed
                    (EBookShellView *book_shell_view);
void        e_book_shell_view_private_dispose
                    (EBookShellView *book_shell_view);
void        e_book_shell_view_private_finalize
                    (EBookShellView *book_shell_view);

/* Private Utilities */

void        e_book_shell_view_actions_init
                    (EBookShellView *book_shell_view);
void        e_book_shell_view_editor_weak_notify
                    (EditorUidClosure *closure,
                     GObject *where_the_object_was);
void        e_book_shell_view_update_search_filter
                    (EBookShellView *book_shell_view);

G_END_DECLS

#endif /* E_BOOK_SHELL_VIEW_PRIVATE_H */