---

mlview-xml-document-view.h File Reference

#include <gnome.h>
#include "mlview-app-context.h"
#include "mlview-xml-document.h"

Go to the source code of this file.

Data Structures
struct	_MlViewXMLDocumentView
struct	_MlViewXMLDocumentViewClass
struct	_SignalCallbackDescriptor
Defines
#define	MLVIEW_TYPE_XML_DOCUMENT_VIEW   (mlview_xml_document_view_get_type ())
#define	MLVIEW_XML_DOCUMENT_VIEW(object)   (GTK_CHECK_CAST ((object), MLVIEW_TYPE_XML_DOCUMENT_VIEW, MlViewXMLDocumentView))
#define	MLVIEW_XML_DOCUMENT_VIEW_CLASS(object)   (GTK_CHECK_CLASS_CAST ((klass), MVLIEW_TYPE_XML_DOCUMENT_VIEW, MlViewXMLDocumentViewClass))
#define	MLVIEW_IS_XML_DOCUMENT_VIEW(object)   (GTK_CHECK_TYPE ((object), MLVIEW_TYPE_XML_DOCUMENT_VIEW))
#define	MLVIEW_IS_XML_DOCUMENT_VIEW_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), MLVIEW_TYPE_XML_DOCUMENT_VIEW))
Typedefs
typedef _MlViewXMLDocumentView	MlViewXMLDocumentView
typedef _MlViewXMLDocumentViewClass	MlViewXMLDocumentViewClass
typedef _MlViewXMLDocumentViewPrivate	MlViewXMLDocumentViewPrivate
typedef _SignalCallbackDescriptor	SignalCallbackDescriptor
Enumerations
enum	MLVIEW_XML_DOCUMENT_VIEW_STATUS { MLVIEW_XML_DOCUMENT_VIEW_OK, MLVIEW_XML_DOCUMENT_VIEW_NOK, MLVIEW_XML_DOCUMENT_VIEW_DOC_SIGNAL_HANDLERS_NOT_SET, MLVIEW_XML_DOCUMENT_VIEW_BAD_PARAMETER }
Functions
gint	mlview_xml_document_view_get_type (void)
	The type builder of this class.
enum MLVIEW_XML_DOCUMENT_VIEW_STATUS	mlview_xml_document_view_construct (MlViewXMLDocumentView *a_doc_view, MlViewXMLDocument *a_mlview_xml_doc)
MlViewXMLDocumentView *	mlview_xml_document_view_new (MlViewXMLDocument *a_mlview_doc)
void	mlview_xml_document_view_set_document_signal_handlers (SignalCallbackDescriptor *a_signals)
	This functions is a startup init function.
void	mlview_xml_document_view_set_name (MlViewXMLDocumentView *a_view, gchar *a_name)
	Sets the document name to the new one.
void	mlview_xml_document_view_set_name_interactive (MlViewXMLDocumentView *a_view)
gchar *	mlview_xml_document_view_get_name (MlViewXMLDocumentView *a_view)
MlViewXMLDocument *	mlview_xml_document_view_get_document (MlViewXMLDocumentView *a_doc_view)
void	mlview_xml_document_view_set_document (MlViewXMLDocumentView *a_doc_view, MlViewXMLDocument *a_mlview_doc)
	Associates an mlview xml document to the current instance of MlViewXMLDocumentView.
MlViewFileDescriptor *	mlview_xml_document_view_get_file_descriptor (MlViewXMLDocumentView *a_doc_view)
void	mlview_xml_document_view_destroy (GtkObject *a_mlview_xml_doc_view)

---

Define Documentation

#define MLVIEW_IS_XML_DOCUMENT_VIEW (  object    )     (GTK_CHECK_TYPE ((object), MLVIEW_TYPE_XML_DOCUMENT_VIEW))

Definition at line 19 of file mlview-xml-document-view.h. Referenced by mlview_editor_add_xml_document_view(), mlview_editor_remove_xml_document_view(), mlview_xml_document_view_construct(), mlview_xml_document_view_destroy(), mlview_xml_document_view_get_document(), mlview_xml_document_view_get_file_descriptor(), mlview_xml_document_view_get_name(), mlview_xml_document_view_set_document(), mlview_xml_document_view_set_name(), and mlview_xml_document_view_set_name_interactive().

#define MLVIEW_IS_XML_DOCUMENT_VIEW_CLASS (  klass    )     (GTK_CHECK_CLASS_TYPE ((klass), MLVIEW_TYPE_XML_DOCUMENT_VIEW))

Definition at line 20 of file mlview-xml-document-view.h.

#define MLVIEW_TYPE_XML_DOCUMENT_VIEW   (mlview_xml_document_view_get_type ())

Definition at line 16 of file mlview-xml-document-view.h. Referenced by mlview_xml_document_view_new().

#define MLVIEW_XML_DOCUMENT_VIEW (  object    )     (GTK_CHECK_CAST ((object), MLVIEW_TYPE_XML_DOCUMENT_VIEW, MlViewXMLDocumentView))

Definition at line 17 of file mlview-xml-document-view.h. Referenced by mlview_editor_create_new_view_on_document(), mlview_editor_create_new_xml_document(), mlview_editor_edit_xml_document(), mlview_editor_load_xml_file(), mlview_xml_doc_tree_view_construct(), and mlview_xml_document_view_destroy().

#define MLVIEW_XML_DOCUMENT_VIEW_CLASS (  object    )     (GTK_CHECK_CLASS_CAST ((klass), MVLIEW_TYPE_XML_DOCUMENT_VIEW, MlViewXMLDocumentViewClass))

Definition at line 18 of file mlview-xml-document-view.h.

---

Typedef Documentation

typedef struct _MlViewXMLDocumentView MlViewXMLDocumentView

Definition at line 22 of file mlview-xml-document-view.h.

typedef struct _MlViewXMLDocumentViewClass MlViewXMLDocumentViewClass

Definition at line 23 of file mlview-xml-document-view.h.

typedef struct _MlViewXMLDocumentViewPrivate MlViewXMLDocumentViewPrivate

Definition at line 24 of file mlview-xml-document-view.h.

typedef struct _SignalCallbackDescriptor SignalCallbackDescriptor

Definition at line 30 of file mlview-xml-document-view.h.

---

Enumeration Type Documentation

enum MLVIEW_XML_DOCUMENT_VIEW_STATUS

Enumeration values: MLVIEW_XML_DOCUMENT_VIEW_OK  MLVIEW_XML_DOCUMENT_VIEW_NOK  MLVIEW_XML_DOCUMENT_VIEW_DOC_SIGNAL_HANDLERS_NOT_SET  MLVIEW_XML_DOCUMENT_VIEW_BAD_PARAMETER  Definition at line 32 of file mlview-xml-document-view.h. Referenced by mlview_xml_doc_tree_view_construct().

---

Function Documentation

enum MLVIEW_XML_DOCUMENT_VIEW_STATUS mlview_xml_document_view_construct (  MlViewXMLDocumentView *    a_doc_view, MlViewXMLDocument *    a_mlview_xml_doc )

Definition at line 283 of file mlview-xml-document-view.c. References MLVIEW_IS_XML_DOCUMENT, MLVIEW_IS_XML_DOCUMENT_VIEW, MLVIEW_XML_DOCUMENT_VIEW_BAD_PARAMETER, and PRIVATE. Referenced by mlview_xml_doc_tree_view_construct(), and mlview_xml_document_view_new().

void mlview_xml_document_view_destroy (  GtkObject *    a_mlview_xml_doc_view )

Definition at line 516 of file mlview-xml-document-view.c. References MLVIEW_IS_XML_DOCUMENT_VIEW, MLVIEW_XML_DOCUMENT_VIEW, mlview_xml_document_view_get_document(), and PRIVATE.

MlViewXMLDocument* mlview_xml_document_view_get_document (  MlViewXMLDocumentView *    a_xml_doc_view )

Parameters: a_xml_doc_view  the current instance of MlViewXMLDocumentView. Definition at line 344 of file mlview-xml-document-view.c. References MLVIEW_IS_XML_DOCUMENT_VIEW, and PRIVATE. Referenced by mlview_editor_add_xml_document_view(), mlview_editor_associate_dtd_interactive(), mlview_editor_close_xml_document_interactive(), mlview_editor_create_new_view_on_current_document_interactive(), mlview_editor_get_current_xml_doc_file_path(), mlview_editor_remove_xml_document_view(), mlview_editor_save_and_close_xml_document(), mlview_editor_save_xml_document(), mlview_editor_save_xml_document_as(), mlview_editor_validate(), and mlview_xml_document_view_destroy().

MlViewFileDescriptor* mlview_xml_document_view_get_file_descriptor (  MlViewXMLDocumentView *    a_doc_view )

Parameters: a_doc_view  the current instance of MlViewXMLDocumentView. Definition at line 500 of file mlview-xml-document-view.c. References MLVIEW_IS_XML_DOCUMENT_VIEW, mlview_xml_document_get_file_descriptor(), and PRIVATE. Referenced by mlview_editor_add_xml_document_view(), mlview_editor_remove_xml_document_view(), and mlview_editor_save_xml_document_as().

gchar* mlview_xml_document_view_get_name (  MlViewXMLDocumentView *    a_doc_view )

Parameters: a_doc_view  the current instance of MlViewXMLDocumentView. Returns: a pointer to the name of the current xml document. Note the caller should neither Definition at line 468 of file mlview-xml-document-view.c. References MLVIEW_IS_XML_DOCUMENT_VIEW, and PRIVATE. Referenced by mlview_xml_document_view_set_name_interactive().

gint mlview_xml_document_view_get_type (  void    )

The type builder of this class. This method is part of the Gtk typing system framework. Definition at line 360 of file mlview-xml-document-view.c.

MlViewXMLDocumentView* mlview_xml_document_view_new (  MlViewXMLDocument *    a_mlview_doc )

Definition at line 303 of file mlview-xml-document-view.c. References MLVIEW_TYPE_XML_DOCUMENT_VIEW, mlview_xml_document_view_construct(), and MLVIEW_XML_DOCUMENT_VIEW_OK.

void mlview_xml_document_view_set_document (  MlViewXMLDocumentView *    a_xml_doc_view, MlViewXMLDocument *    a_mlview_xml_doc )

Associates an mlview xml document to the current instance of MlViewXMLDocumentView. Parameters: a_mlview_xml_doc  the new mlview xml document to associate to the current instanceof MlViewXMLDocumentView. a_xml_doc_view  the current instance of MlViewXMLDocumentView. Definition at line 326 of file mlview-xml-document-view.c. References MLVIEW_IS_XML_DOCUMENT_VIEW, and PRIVATE.

void mlview_xml_document_view_set_document_signal_handlers (  SignalCallbackDescriptor *    a_signals )

This functions is a startup init function. The does something only when it is called for the first time. It sets the signal handlers of the current view vis a vis the underlying document. Subsequent calls just do nothing. Parameters: a_signals  the signal handlers Definition at line 487 of file mlview-xml-document-view.c. Referenced by mlview_xml_doc_tree_view_construct().

void mlview_xml_document_view_set_name (  MlViewXMLDocumentView *    a_doc_view, gchar *    a_name )

Sets the document name to the new one. The new name is copied so that the caller can free a_name if she wish. This function makes a_doc_view emit the "name-changed" signal. Parameters: a_doc_view  the document view. a_name  the new document name. Definition at line 389 of file mlview-xml-document-view.c. References MLVIEW_IS_XML_DOCUMENT_VIEW, NAME_CHANGED, and PRIVATE. Referenced by mlview_editor_add_xml_document_view(), mlview_editor_save_xml_document_as(), mlview_editor_set_current_view_name(), and mlview_xml_document_view_set_name_interactive().

void mlview_xml_document_view_set_name_interactive (  MlViewXMLDocumentView *    a_view )

Parameters: a_view  the current xml document view. Definition at line 415 of file mlview-xml-document-view.c. References MLVIEW_IS_XML_DOCUMENT_VIEW, mlview_xml_document_get_app_context(), mlview_xml_document_view_get_name(), mlview_xml_document_view_set_name(), and PRIVATE. Referenced by mlview_editor_set_current_view_name_interactive().

---