---

mlview-node-type-picker.h File Reference

#include <gnome.h>
#include <libxml/tree.h>
#include "mlview-app-context.h"
#include "mlview-parsing-utils.h"

Go to the source code of this file.

Data Structures
struct	_MlViewNodeTypePicker
struct	_MlViewNodeTypePickerClass
Defines
#define	MLVIEW_TYPE_NODE_TYPE_PICKER   (mlview_node_type_picker_get_type())
	This object is a node type picker.
#define	MLVIEW_NODE_TYPE_PICKER(object)   (GTK_CHECK_CAST((object),MLVIEW_TYPE_NODE_TYPE_PICKER,MlViewNodeTypePicker))
#define	MLVIEW_NODE_TYPE_PICKER_CLASS(klass)   (GTK_CHECK_CLASS_CAST((klass),MLVIEW_TYPE_NODE_TYPE_PICKER,MlViewNodeTypePickerClass))
#define	MLVIEW_IS_NODE_TYPE_PICKER(object)   (GTK_CHECK_TYPE((object),MLVIEW_TYPE_NODE_TYPE_PICKER))
#define	MLVIEW_IS_NODE_TYPE_PICKER_CLASS(klass)   (GTK_CHECK_CLASS_TYPE((klass),MLVIEW_TYPE_NODE_TYPE_PICKER))
Typedefs
typedef _MlViewNodeTypePicker	MlViewNodeTypePicker
typedef _MlViewNodeTypePickerClass	MlViewNodeTypePickerClass
typedef _MlViewNodeTypePickerPrivate	MlViewNodeTypePickerPrivate
Functions
guint	mlview_node_type_picker_get_type (void)
	The type identifier builder of this object.
guint	mlview_node_type_picker_get_selected_node_type (MlViewNodeTypePicker *a_nt_picker)
	Getter of the "selected node type" attribute.
gchar *	mlview_node_type_picker_get_selected_node_type_name (MlViewNodeTypePicker *a_nt_picker)
gchar *	mlview_node_type_picker_get_node_name_or_content (MlViewNodeTypePicker *a_nt_picker)
	If the element type selected is either XML_ELEMENT_NODE or XML_PI_NODE, this method returns the name of the node that the user entered.
void	mlview_node_type_picker_set_selected_node_type (MlViewNodeTypePicker *a_nt_picker, guint a_node_type)
void	mlview_node_type_picker_set_focus_to_node_name_or_content_entry (MlViewNodeTypePicker *a_nt_picker)
void	mlview_node_type_picker_select_node_name_or_content_entry_text (MlViewNodeTypePicker *a_nt_picker)
GtkWidget *	mlview_node_type_picker_new (MlViewAppContext *a_app_context)
	The instance builder of the MlViewNodeTypePicker class.
GtkWidget *	mlview_node_type_picker_new_with_title (gchar *a_title, MlViewAppContext *a_app_context)
	The instance builder of the MlViewNodeTypePicker class.
void	mlview_node_type_picker_set_on_going_validation (gboolean a_on)
	Turns on/off the on going validation.
gboolean	mlview_node_type_picker_on_going_validation_is_on (void)
void	mlview_node_type_picker_set_title (MlViewNodeTypePicker *a_nt_picker, gchar *a_title)
void	mvliew_node_type_picker_build_element_name_choice_list (MlViewNodeTypePicker *a_picker, enum NODE_INSERTION_SCHEME a_insertion_scheme, xmlNode *a_current_xml_node)
	Builds the element name choice list to initialyze the element name combo list.
void	mlview_node_type_picker_destroy (GtkObject *a_object)

---

Define Documentation

#define MLVIEW_IS_NODE_TYPE_PICKER (  object    )     (GTK_CHECK_TYPE((object),MLVIEW_TYPE_NODE_TYPE_PICKER))

Definition at line 43 of file mlview-node-type-picker.h. Referenced by mlview_node_type_picker_destroy(), mlview_node_type_picker_new(), mlview_node_type_picker_new_with_title(), and mvliew_node_type_picker_build_element_name_choice_list().

#define MLVIEW_IS_NODE_TYPE_PICKER_CLASS (  klass    )     (GTK_CHECK_CLASS_TYPE((klass),MLVIEW_TYPE_NODE_TYPE_PICKER))

Definition at line 44 of file mlview-node-type-picker.h.

#define MLVIEW_NODE_TYPE_PICKER (  object    )     (GTK_CHECK_CAST((object),MLVIEW_TYPE_NODE_TYPE_PICKER,MlViewNodeTypePicker))

Definition at line 41 of file mlview-node-type-picker.h. Referenced by mlview_node_type_picker_destroy(), mlview_node_type_picker_new(), mlview_node_type_picker_new_with_title(), mlview_tree_editor_add_child_node_interactive(), mlview_tree_editor_insert_next_sibling_node_interactive(), and mlview_tree_editor_insert_prev_sibling_node_interactive().

#define MLVIEW_NODE_TYPE_PICKER_CLASS (  klass    )     (GTK_CHECK_CLASS_CAST((klass),MLVIEW_TYPE_NODE_TYPE_PICKER,MlViewNodeTypePickerClass))

Definition at line 42 of file mlview-node-type-picker.h.

#define MLVIEW_TYPE_NODE_TYPE_PICKER   (mlview_node_type_picker_get_type())

This object is a node type picker. It contains methods to allow the user to choose among a list of xml node types. In a near future, object should be a key component in the on going validation process. It should be able to let the user willing to create a new xml node to choose among a set of allowed nodes depending on the position the newly created xml node an depending on the current document dtd... but this is the speculation Definition at line 40 of file mlview-node-type-picker.h. Referenced by mlview_node_type_picker_new(), and mlview_node_type_picker_new_with_title().

---

Typedef Documentation

typedef struct _MlViewNodeTypePicker MlViewNodeTypePicker

Definition at line 46 of file mlview-node-type-picker.h.

typedef struct _MlViewNodeTypePickerClass MlViewNodeTypePickerClass

Definition at line 47 of file mlview-node-type-picker.h.

typedef struct _MlViewNodeTypePickerPrivate MlViewNodeTypePickerPrivate

Definition at line 48 of file mlview-node-type-picker.h.

---

Function Documentation

void mlview_node_type_picker_destroy (  GtkObject *    a_object )

Definition at line 633 of file mlview-node-type-picker.c. References MLVIEW_IS_NODE_TYPE_PICKER, MLVIEW_NODE_TYPE_PICKER, and PRIVATE.

gchar* mlview_node_type_picker_get_node_name_or_content (  MlViewNodeTypePicker *    a_nt_picker )

If the element type selected is either XML_ELEMENT_NODE or XML_PI_NODE, this method returns the name of the node that the user entered. For other types of nodes, this method returns the content of the node. Note that if node names completion is on, this function frees the element names list build during the call of mvliew_node_type_picker_build_element_name_choice_list (). Returns: NULL if the argument given if NULL or if the instance has not been correctly built. Definition at line 526 of file mlview-node-type-picker.c. References PRIVATE.

guint mlview_node_type_picker_get_selected_node_type (  MlViewNodeTypePicker *    a_nt_picker )

Getter of the "selected node type" attribute. Definition at line 508 of file mlview-node-type-picker.c. References PRIVATE.

gchar* mlview_node_type_picker_get_selected_node_type_name (  MlViewNodeTypePicker *    a_nt_picker )

guint mlview_node_type_picker_get_type (  void    )

The type identifier builder of this object. Definition at line 667 of file mlview-node-type-picker.c.

GtkWidget* mlview_node_type_picker_new (  MlViewAppContext *    a_app_context )

The instance builder of the MlViewNodeTypePicker class. Definition at line 393 of file mlview-node-type-picker.c. References MLVIEW_IS_NODE_TYPE_PICKER, MLVIEW_NODE_TYPE_PICKER, MLVIEW_TYPE_NODE_TYPE_PICKER, and PRIVATE. Referenced by mlview_tree_editor_insert_next_sibling_node_interactive(), and mlview_tree_editor_insert_prev_sibling_node_interactive().

GtkWidget* mlview_node_type_picker_new_with_title (  gchar *    a_title, MlViewAppContext *    a_app_context )

The instance builder of the MlViewNodeTypePicker class. Definition at line 468 of file mlview-node-type-picker.c. References mlview_app_context_set_window_icon(), MLVIEW_IS_NODE_TYPE_PICKER, MLVIEW_NODE_TYPE_PICKER, MLVIEW_TYPE_NODE_TYPE_PICKER, and PRIVATE.

gboolean mlview_node_type_picker_on_going_validation_is_on (  void    )

Returns: TRUE if on going validation is turned on and false if not. Definition at line 624 of file mlview-node-type-picker.c.

void mlview_node_type_picker_select_node_name_or_content_entry_text (  MlViewNodeTypePicker *    a_nt_picker )

Definition at line 704 of file mlview-node-type-picker.c. References mlview_node_type_picker_set_focus_to_node_name_or_content_entry(), and PRIVATE. Referenced by mlview_tree_editor_add_child_node_interactive(), mlview_tree_editor_insert_next_sibling_node_interactive(), and mlview_tree_editor_insert_prev_sibling_node_interactive().

void mlview_node_type_picker_set_focus_to_node_name_or_content_entry (  MlViewNodeTypePicker *    a_nt_picker )

Definition at line 690 of file mlview-node-type-picker.c. References PRIVATE. Referenced by mlview_node_type_picker_select_node_name_or_content_entry_text().

void mlview_node_type_picker_set_on_going_validation (  gboolean    a_on )

Turns on/off the on going validation. Definition at line 613 of file mlview-node-type-picker.c.

void mlview_node_type_picker_set_selected_node_type (  MlViewNodeTypePicker *    a_nt_picker, guint    a_node_type )

Definition at line 545 of file mlview-node-type-picker.c. References PRIVATE.

void mlview_node_type_picker_set_title (  MlViewNodeTypePicker *    a_nt_picker, gchar *    a_title )

Definition at line 493 of file mlview-node-type-picker.c. Referenced by mlview_tree_editor_add_child_node_interactive(), mlview_tree_editor_insert_next_sibling_node_interactive(), and mlview_tree_editor_insert_prev_sibling_node_interactive().

void mvliew_node_type_picker_build_element_name_choice_list (  MlViewNodeTypePicker *    a_picker, enum NODE_INSERTION_SCHEME    a_insertion_scheme, xmlNode *    a_current_xml_node )

Builds the element name choice list to initialyze the element name combo list. This function first re-initialyzes the picker as if there were no validation. Then, if validation is switched on, it builds the element names list. Definition at line 421 of file mlview-node-type-picker.c. References mlview_app_context_get_settings_value(), mlview_app_context_settings_exist(), MLVIEW_IS_NODE_TYPE_PICKER, mlview_parsing_utils_build_element_name_completion_list(), NODE_INSERTION_SCHEME, and PRIVATE. Referenced by mlview_tree_editor_add_child_node_interactive(), mlview_tree_editor_insert_next_sibling_node_interactive(), and mlview_tree_editor_insert_prev_sibling_node_interactive().

---