---

mlview-editor.h

Go to the documentation of this file.

/*This file is part of GNU MlView
 *
 *GNU MlView 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, 
 *or (at your option) any later version.
 *
 *GNU MlView 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 MlView; 
 *see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *
 *Copyright 2001-2002 Dodji Seketeli.
 */

#ifndef __MLVIEW_EDITOR_H__
#define __MLVIEW_EDITOR_H__

#include <gnome.h>
#include <libxml/parser.h>

#include "mlview-node-editor.h"
#include "mlview-file-selection.h"
#include "mlview-app-context.h"
#include "mlview-xml-document.h"
#include "mlview-xml-document-view.h"

#ifdef __cplusplus
extern "C" {
#endif /*__cpluscplus*/
  
        /*Macros for casting a GtkWidget or GtkWidgetClass pointer to a MlViewEditor or MlviewClass pointer.
         *Macros for testing wheter 'widget' or 'klass' are of type MLVIEW_TYPE_EDITOR.
         */
#define MLVIEW_TYPE_EDITOR (mlview_editor_get_type ())
#define MLVIEW_EDITOR(widget) (GTK_CHECK_CAST ((widget), MLVIEW_TYPE_EDITOR, MlViewEditor))
#define MLVIEW_EDITOR_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), MLVIEW_TYPE_EDITOR, MlViewEditorClass))
#define MLVIEW_IS_EDITOR(widget) (GTK_CHECK_TYPE ((widget), MLVIEW_TYPE_EDITOR))
#define MLVIEW_IS_EDITOR_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), MLVIEW_TYPE_EDITOR))
        
        typedef struct _MlViewEditorPrivate MlViewEditorPrivate ;
        typedef struct _MlViewEditor MlViewEditor ;
        typedef struct _MlViewEditorClass MlViewEditorClass  ;
        
        enum MLVIEW_XML_DOC_VIEW_TYPE {
                MLVIEW_XML_DOC_TREE_VIEW
        } ;

        struct _MlViewEditor
        {
                GtkVBox box ;
                MlViewEditorPrivate * private ;
        };

        struct _MlViewEditorClass
        {
                GtkVBoxClass parent_class ;             
                /*signal default handlers*/
                void (*document_changed)(MlViewEditor* editor, gpointer data);
        };


        guint 
        mlview_editor_get_type (void);

        GtkWidget *
        mlview_editor_new (gchar *a_title, MlViewAppContext *a_context) ;

        void 
        mlview_editor_create_new_xml_document (MlViewEditor * a_editor) ;

        MlViewXMLDocumentView *
        mlview_editor_create_new_view_on_document (MlViewEditor *a_editor, 
                                                   MlViewXMLDocument *a_xml_doc,
                                                   enum MLVIEW_XML_DOC_VIEW_TYPE) ;

        MlViewXMLDocumentView *
        mlview_editor_create_new_view_on_current_document_interactive (MlViewEditor *a_editor) ;

        void 
        mlview_editor_load_xml_file (MlViewEditor *a_editor, 
                                     gchar * a_file_path) ;

        void 
        mlview_editor_open_local_xml_document_interactive (MlViewEditor * editor)  ;

        void 
        mlview_editor_add_xml_document_view (MlViewEditor * a_editor, 
                                             MlViewXMLDocumentView * a_xml_doc_view) ;

        void 
        mlview_editor_remove_xml_document_view (MlViewEditor * a_editor, 
                                                MlViewXMLDocumentView * a_xml_doc_view) ;

        void
        mlview_editor_set_current_view_name (MlViewEditor *a_editor, 
                                             gchar * a_name) ;

        void
        mlview_editor_set_current_view_name_interactive (MlViewEditor *a_editor) ;

        void
        mlview_editor_add_child_node_interactive (MlViewEditor *a_editor) ;

        void 
        mlview_editor_insert_sibling_node_interactive (MlViewEditor *a_editor) ;

        void 
        mlview_editor_insert_prev_sibling_node_interactive (MlViewEditor *a_editor) ;

        void
        mlview_editor_insert_next_sibling_node_interactive (MlViewEditor *a_editor) ;

        void 
        mlview_editor_cut_node (MlViewEditor *a_editor) ;

        void 
        mlview_editor_copy_node (MlViewEditor *a_editor) ;

        xmlDocPtr 
        mlview_editor_get_current_xml_doc (MlViewEditor *a_editor) ;

        void 
        mlview_editor_edit_xml_document (MlViewEditor *a_editor, 
                                         xmlDocPtr a_doc, gchar * a_doc_name) ;

        void
        mlview_editor_save_xml_document (MlViewEditor *a_editor) ;      

        void 
        mlview_editor_save_xml_document_as (MlViewEditor *a_editor, 
                                            gchar *a_file_path) ;

        void 
        mlview_editor_save_xml_document_as_interactive (MlViewEditor *a_editor) ;

        gchar *
        mlview_editor_get_current_xml_doc_file_path (MlViewEditor *a_editor) ;

        void 
        mlview_editor_close_xml_document_without_saving (MlViewEditor * a_editor) ;

        void 
        mlview_editor_save_and_close_xml_document (MlViewEditor *a_editor) ;

        void 
        mlview_editor_create_new_xml_document (MlViewEditor *a_editor) ;

        void 
        mlview_editor_close_xml_document_interactive (MlViewEditor * a_editor) ;

        void
        mlview_editor_close_all_xml_documents_interactive (MlViewEditor *a_editor) ;

        void 
        mlview_editor_paste_node_as_prev_sibling (MlViewEditor *a_editor) ;

        void 
        mlview_editor_paste_node_as_child (MlViewEditor *a_editor) ;

        void 
        mlview_editor_paste_node_as_next_sibling (MlViewEditor *a_editor) ;

        void 
        mlview_editor_expand_tree_to_depth_interactive (MlViewEditor *a_editor) ;

        GtkCTreeNode * 
        mlview_editor_find_xml_node_that_contains_str_interactive (MlViewEditor *a_editor) ;

        void 
        mlview_editor_edit_settings_interactive (MlViewEditor *a_editor) ;

        MlViewFileSelection *
        mlview_editor_get_file_selector (MlViewEditor * a_editor,
                                         gchar * a_title) ;
        gint 
        mlview_editor_associate_dtd_interactive (MlViewEditor * a_editor) ;

        gint 
        mlview_editor_validate (MlViewEditor * a_editor) ;
        
        void 
        mlview_editor_set_app_context (MlViewEditor * a_editor, 
                                       MlViewAppContext *a_context) ;

        MlViewAppContext * 
        mlview_editor_get_app_context (MlViewEditor *a_editor) ;

#ifdef __cplusplus
}

#endif /*__cplusplus*/
#endif /*__MLVIEW_EDITOR_H__*/

---