plugins/document-manager/anjuta-docman.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*
   3     anjuta-docman.h
   4     Copyright (C) 2003  Naba Kumar <naba@gnome.org>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  19 */
  20
  21 #ifndef _ANJUTA_DOCMAN_H_
  22 #define _ANJUTA_DOCMAN_H_
  23
  24 #include <gtk/gtk.h>
  25 #include <libanjuta/anjuta-shell.h>
  26 #include <libanjuta/interfaces/ianjuta-editor.h>
  27 #include <libanjuta/interfaces/ianjuta-document.h>
  28 #include <gio/gio.h>
  29
  30 #include "plugin.h"
  31
  32 #define ANJUTA_TYPE_DOCMAN        (anjuta_docman_get_type ())
  33 #define ANJUTA_DOCMAN(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), ANJUTA_TYPE_DOCMAN, AnjutaDocman))
  34 #define ANJUTA_DOCMAN_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), ANJUTA_TYPE_DOCMAN, AnjutaDocmanClass))
  35 #define ANJUTA_IS_DOCMAN(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), ANJUTA_TYPE_DOCMAN))
  36 #define ANJUTA_IS_DOCMAN_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), ANJUTA_TYPE_DOCMAN))
  37
  38 typedef struct _AnjutaDocman AnjutaDocman;
  39 typedef struct _AnjutaDocmanPriv AnjutaDocmanPriv;
  40 typedef struct _AnjutaDocmanClass AnjutaDocmanClass;
  41
  42 struct _AnjutaDocman {
  43         GtkGrid parent;
  44
  45         AnjutaDocmanPriv *priv;
  46         AnjutaShell *shell;
  47         gboolean maximized;
  48 };
  49
  50 struct _AnjutaDocmanClass {
  51         GtkGridClass parent_class;
  52
  53         /* Signals */
  54         void (*document_added) (IAnjutaDocument *document);
  55         void (*document_changed) (IAnjutaDocument *new_document);
  56         void (*document_removed) (IAnjutaDocument *document);
  57 };
  58
  59 GType anjuta_docman_get_type (void);
  60 GtkWidget* anjuta_docman_new (DocmanPlugin *plugin);
  61
  62 void anjuta_docman_set_popup_menu (AnjutaDocman *docman, GtkWidget *menu);
  63
  64 IAnjutaEditor *anjuta_docman_add_editor (AnjutaDocman *docman, GFile* file,
  65                                                                                  const gchar *name);
  66 void anjuta_docman_add_document (AnjutaDocman *docman, IAnjutaDocument *doc,
  67                                                                  GFile* file);
  68
  69 void anjuta_docman_remove_document (AnjutaDocman *docman, IAnjutaDocument *doc);
  70
  71 IAnjutaDocument *anjuta_docman_get_current_document (AnjutaDocman *docman);
  72 IAnjutaDocument *anjuta_docman_get_document_for_file (AnjutaDocman *docman,
  73                                                                                                           GFile* file);
  74
  75 GtkWidget *anjuta_docman_get_current_focus_widget (AnjutaDocman *docman);
  76
  77 GtkWidget *anjuta_docman_get_current_popup (AnjutaDocman *docman);
  78
  79 void anjuta_docman_set_current_document (AnjutaDocman *docman, IAnjutaDocument *doc);
  80
  81 void anjuta_docman_set_message_area (AnjutaDocman *docman, IAnjutaDocument *doc,
  82                                                                         GtkWidget *message_area);
  83
  84 IAnjutaEditor *anjuta_docman_goto_file_line (AnjutaDocman *docman,
  85                                                                                         GFile* file,
  86                                                                                         gint lineno);
  87 IAnjutaEditor *anjuta_docman_goto_file_line_mark (AnjutaDocman *docman,
  88                                                                                                 GFile* file,
  89                                                                                                 gint lineno,
  90                                                                                                 gboolean mark);
  91 void anjuta_docman_present_notebook_page (AnjutaDocman *docman, IAnjutaDocument *doc);
  92
  93 void anjuta_docman_delete_all_markers (AnjutaDocman *docman, gint marker);
  94 void anjuta_docman_delete_all_indicators (AnjutaDocman *docman);
  95
  96 void anjuta_docman_save_file_if_modified (AnjutaDocman *docman,
  97                                                                                   GFile* file);
  98 void anjuta_docman_reload_file (AnjutaDocman *docman, GFile* file);
  99
 100
 101 GFile *anjuta_docman_get_file (AnjutaDocman *docman, const gchar *filename);
 102
 103 GList *anjuta_docman_get_all_doc_widgets (AnjutaDocman *docman);
 104
 105 void anjuta_docman_open_file (AnjutaDocman *docman);
 106
 107 /* Returns TRUE if editor is saved */
 108 gboolean anjuta_docman_save_document (AnjutaDocman *docman, IAnjutaDocument *doc,
 109                                                                         GtkWidget *parent_window);
 110
 111 /* Returns TRUE if editor is saved */
 112 gboolean anjuta_docman_save_document_as (AnjutaDocman *docman,
 113                                                                                 IAnjutaDocument *doc,
 114                                                                                 GtkWidget *parent_window);
 115
 116 gboolean anjuta_docman_next_page (AnjutaDocman *docman);
 117 gboolean anjuta_docman_previous_page (AnjutaDocman *docman);
 118 gboolean anjuta_docman_set_page (AnjutaDocman *docman, gint page);
 119
 120 void anjuta_docman_project_path_updated (AnjutaDocman *docman);
 121
 122 typedef enum
 123 {
 124         ANJUTA_DOCMAN_OPEN_DOCUMENTS_MODE_TABS,
 125         ANJUTA_DOCMAN_OPEN_DOCUMENTS_MODE_COMBO,
 126         ANJUTA_DOCMAN_OPEN_DOCUMENTS_MODE_NONE
 127 } AnjutaDocmanOpenDocumentsMode;
 128
 129 void anjuta_docman_set_open_documents_mode (AnjutaDocman *docman,
 130                                                                                     AnjutaDocmanOpenDocumentsMode mode);
 131
 132 void anjuta_docman_set_tab_pos (AnjutaDocman *docman, GtkPositionType pos);
 133
 134 #endif