---

mlview-attribute-picker.h File Reference

The declaration of the class MlViewAttributePicker. More...

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

Go to the source code of this file.

Data Structures
struct	_MlViewAttributePicker
	The attribute picker of mlview. More...
struct	_MlViewAttributePickerClass
Defines
#define	MLVIEW_TYPE_ATTRIBUTE_PICKER   (mlview_attribute_picker_get_type ())
#define	MLVIEW_ATTRIBUTE_PICKER(object)   (GTK_CHECK_CAST ((object), MLVIEW_TYPE_ATTRIBUTE_PICKER, MlViewAttributePicker))
#define	MLVIEW_ATTRIBUTE_PICKER_CLASS(klass)   (GTK_CHECK_CLASS_CAST ((klass), MLVIEW_TYPE_ATTRIBUTE_PICKER, MlViewAttributePickerClass))
#define	MLVIEW_IS_ATTRIBUTE_PICKER(object)   (GTK_CHECK_TYPE ((object), MLVIEW_TYPE_ATTRIBUTE_PICKER))
#define	MLVIEW_IS_ATTRIBUTE_PICKER_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), MLVIEW_TYPE_ATTRIBUTE_PICKER))
Typedefs
typedef _MlViewAttributePicker	MlViewAttributePicker
typedef _MlViewAttributePickerClass	MlViewAttributePickerClass
typedef _MlViewAttributePickerPrivate	MlViewAttributePickerPrivate
Functions
gint	mlview_attribute_picker_get_type (void)
	Type builder.
GtkWidget *	mlview_attribute_picker_new (gchar *a_title, MlViewAppContext *a_app_context)
	Builds a brand new attribute picker.
void	mlview_attribute_picker_set_attribute_completion (gboolean a_completion_on)
	Sets the attribute completion on/off.
void	mlview_attribute_picker_grab_focus_to_name_entry (MlViewAttributePicker *a_picker)
	Sets the focus to the name entry of MlViewAttributePicker widget.
void	mlview_attribute_picker_grab_focus_to_value_entry (MlViewAttributePicker *a_picker)
	Sets the focus to the value entry of MlViewAttributePicker widget.
void	mlview_attribute_picker_select_attribute_value (MlViewAttributePicker *a_picker)
	Graphically selects all the content of the value entry of the MlViewAttributePicker widget.
void	mlview_attribute_picker_select_attribute_name (MlViewAttributePicker *a_picker)
	Graphically selects all the content of the name entry of the MlViewAttributePicker widget.
gchar *	mlview_attribute_picker_get_attribute_name (MlViewAttributePicker *a_picker)
	Gets the content of the name entry of attribute picker.
gchar *	mlview_attribute_picker_get_attribute_value (MlViewAttributePicker *a_picker)
	Gets the content of the value entry of the attribute picker.
xmlAttributeType	mlview_attribute_picker_get_attribute_type (MlViewAttributePicker *a_picker)
	Gets the type of the last attribute the user has entered in the picker.
void	mlview_attribute_picker_build_attribute_name_choice_list (MlViewAttributePicker *a_picker, xmlNode *a_xml_node)
	Builds the attribute name completion list.
void	mlview_attribute_picker_set_current_xml_node (MlViewAttributePicker *a_picker, xmlNode *a_xml_node)
	Associates an xml node to this picker.
void	mlview_attribute_picker_set_app_context (MlViewAttributePicker *a_picker, MlViewAppContext *a_app_context)
	Sets a new app context.

---

Detailed Description

The declaration of the class MlViewAttributePicker.

Definition in file mlview-attribute-picker.h.

---

Define Documentation

#define MLVIEW_ATTRIBUTE_PICKER (  object    )     (GTK_CHECK_CAST ((object), MLVIEW_TYPE_ATTRIBUTE_PICKER, MlViewAttributePicker))

Definition at line 35 of file mlview-attribute-picker.h.

#define MLVIEW_ATTRIBUTE_PICKER_CLASS (  klass    )     (GTK_CHECK_CLASS_CAST ((klass), MLVIEW_TYPE_ATTRIBUTE_PICKER, MlViewAttributePickerClass))

Definition at line 36 of file mlview-attribute-picker.h.

#define MLVIEW_IS_ATTRIBUTE_PICKER (  object    )     (GTK_CHECK_TYPE ((object), MLVIEW_TYPE_ATTRIBUTE_PICKER))

Definition at line 37 of file mlview-attribute-picker.h. Referenced by mlview_attribute_picker_build_attribute_name_choice_list(), mlview_attribute_picker_get_attribute_name(), mlview_attribute_picker_get_attribute_type(), mlview_attribute_picker_get_attribute_value(), mlview_attribute_picker_grab_focus_to_name_entry(), mlview_attribute_picker_grab_focus_to_value_entry(), mlview_attribute_picker_select_attribute_name(), mlview_attribute_picker_select_attribute_value(), mlview_attribute_picker_set_app_context(), and mlview_attribute_picker_set_current_xml_node().

#define MLVIEW_IS_ATTRIBUTE_PICKER_CLASS (  klass    )     (GTK_CHECK_CLASS_TYPE ((klass), MLVIEW_TYPE_ATTRIBUTE_PICKER))

Definition at line 38 of file mlview-attribute-picker.h.

#define MLVIEW_TYPE_ATTRIBUTE_PICKER   (mlview_attribute_picker_get_type ())

Definition at line 34 of file mlview-attribute-picker.h. Referenced by mlview_attribute_picker_new().

---

Typedef Documentation

typedef struct _MlViewAttributePicker MlViewAttributePicker

Definition at line 40 of file mlview-attribute-picker.h.

typedef struct _MlViewAttributePickerClass MlViewAttributePickerClass

Definition at line 41 of file mlview-attribute-picker.h.

typedef struct _MlViewAttributePickerPrivate MlViewAttributePickerPrivate

Definition at line 42 of file mlview-attribute-picker.h.

---

Function Documentation

void mlview_attribute_picker_build_attribute_name_choice_list (  MlViewAttributePicker *    a_picker, xmlNode *    a_xml_node )

Builds the attribute name completion list. The list is built, cached in the current instance of MlViewAttributePicker, and displayed to the user whenever she clicks in the attribute names completion list. This function uses mlview_parsing_utils_build_attribute_name_completion_list() to actually build the completion list. Parameters: a_picker  the current instance of MlViewAttributePicker. a_xml_node  the xmlNode used to build the attribute name completion list. Definition at line 872 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, mlview_parsing_utils_build_attribute_name_completion_list(), and PRIVATE.

gchar* mlview_attribute_picker_get_attribute_name (  MlViewAttributePicker *    a_picker )

Gets the content of the name entry of attribute picker. Parameters: a_picker  the current instance of MlViewAttributePicker. Returns: a pointer to the name entry of attribute picker. DO NOT FREE THIS POINTER or you will hang the process. Definition at line 736 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, and PRIVATE.

xmlAttributeType mlview_attribute_picker_get_attribute_type (  MlViewAttributePicker *    a_picker )

Gets the type of the last attribute the user has entered in the picker. Parameters: a_picker  the current instance of MlViewAttributePicker. Returns: the type of the last attribute entered by the user in the picker a_picker. Definition at line 773 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, PRIVATE, and utils_is_white_string().

gchar* mlview_attribute_picker_get_attribute_value (  MlViewAttributePicker *    a_picker )

Gets the content of the value entry of the attribute picker. Parameters: a_picker  the current instance of MlViewAttributePicker. Returns: a pointer to the content of the value entry of the MlViewAttributePicker widget. Definition at line 755 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, and PRIVATE.

gint mlview_attribute_picker_get_type (  void    )

Type builder. Returns: the id of the type MlViewAttribute. Definition at line 642 of file mlview-attribute-picker.c.

void mlview_attribute_picker_grab_focus_to_name_entry (  MlViewAttributePicker *    a_picker )

Sets the focus to the name entry of MlViewAttributePicker widget. Parameters: a_picker  the current instance of MlViewAttributePicker. Definition at line 703 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, and PRIVATE.

void mlview_attribute_picker_grab_focus_to_value_entry (  MlViewAttributePicker *    a_picker )

Sets the focus to the value entry of MlViewAttributePicker widget. Parameters: a_picker  the current instance of MlViewAttributePicker. Definition at line 719 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, and PRIVATE.

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

Builds a brand new attribute picker. Parameters: a_title  the title the window of the attribute picker. a_app_context  the current application context. Returns: the widget of the attribute picker. Definition at line 667 of file mlview-attribute-picker.c. References mlview_app_context_set_window_icon(), mlview_attribute_picker_set_app_context(), and MLVIEW_TYPE_ATTRIBUTE_PICKER.

void mlview_attribute_picker_select_attribute_name (  MlViewAttributePicker *    a_picker )

Graphically selects all the content of the name entry of the MlViewAttributePicker widget. Parameters: a_picker  the current instance of MlViewAttributePicker. Definition at line 798 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, and PRIVATE.

void mlview_attribute_picker_select_attribute_value (  MlViewAttributePicker *    a_picker )

Graphically selects all the content of the value entry of the MlViewAttributePicker widget. Parameters: a_picker  the current instance of MlViewAttributePicker. Definition at line 816 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, and PRIVATE.

void mlview_attribute_picker_set_app_context (  MlViewAttributePicker *    a_picker, MlViewAppContext *    a_app_context )

Sets a new app context. Parameters: a_picker  the current instance of MlViewAttributePicker. a_app_context  the new application context. Definition at line 687 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, and PRIVATE. Referenced by mlview_attribute_picker_new().

void mlview_attribute_picker_set_attribute_completion (  gboolean    a_completion_on )

Sets the attribute completion on/off. All the instances of MlViewAttributePicker of the current process will be affected by this method. Parameters: a_completion_on  wether to set the completion on or not. Definition at line 855 of file mlview-attribute-picker.c.

void mlview_attribute_picker_set_current_xml_node (  MlViewAttributePicker *    a_picker, xmlNode *    a_xml_node )

Associates an xml node to this picker. That xml node is used for example to build the attribute name completion list if needed. Parameters: a_picker  the current instance of MlViewAttributePicker. a_xml_node  the xmlNode to associate to the current node. Definition at line 836 of file mlview-attribute-picker.c. References MLVIEW_IS_ATTRIBUTE_PICKER, and PRIVATE.

---