omXMLParser Class Reference
[GENERIC LIBRARY classes]

#include <omXMLParser.h>

Inheritance diagram for omXMLParser:

Public Member Functions
	omXMLParser ()
bool	Parse (wxString)
virtual void	AtStartDocument ()
virtual void	AtEndDocument ()
virtual void	AtStartTag (wxString n, omXMLParameters p)
virtual void	AtEndTag (wxString n)
Static Public Member Functions
wxString	GetXMLOptionsHeader ()
Private Attributes
xmlSAXHandler *	omSAXHandler

---

Detailed Description

This class rapresent a generic Maia keyboard structure with the XML parser using the gnome libxml2 library. There are some virtual functions called by the parser. These functions must be overridden to handle application specific keyboard. See MaiaKeyboard as an example.

---

Constructor & Destructor Documentation

omXMLParser::omXMLParser (   )

Construct the class by inizializating the XML parser. This class need gnome libxml2 library and headers.

---

Member Function Documentation

void omXMLParser::AtEndDocument (   )  [virtual]

This method is called by the parser when an end of document is found. This is a virtual method and must be overridden to implement specific functions. This function is public because is called externally by the C functions of the parser. The user must not call this function by hand. Reimplemented in openmaiaOptions, maiaKeyboard, and maiaOptions.

void omXMLParser::AtEndTag (  wxString  n  )  [virtual]

This method is called by the parser when a tag close event is found. This is a virtual method and must be overridden to implement specific functions. This function is public because is called externally by the C functions of the parser. The user must not call this function by hand. Parameters: n  name of the tag Reimplemented in openmaiaOptions, maiaKeyboard, and maiaOptions.

void omXMLParser::AtStartDocument (   )  [virtual]

This method is called by the parser when a start of document is found. This is a virtual method and must be overridden to implement specific functions. The rootNode private variable must be initialized here. This function is public because is called externally by the C functions of the parser. The user must not call this function by hand. Reimplemented in openmaiaOptions, maiaKeyboard, and maiaOptions.

void omXMLParser::AtStartTag (  wxString  n, omXMLParameters  p )  [virtual]

This method is called by the parser when a tag open event is found. This is a virtual method and must be overridden to implement specific functions. This function is public because is called externally by the C functions of the parser. The user must not call this function by hand. Parameters: n  name of the tag p  pars of the tag. Reimplemented in openmaiaOptions, maiaKeyboard, and maiaOptions.

wxString omXMLParser::GetXMLOptionsHeader (   )  [static]

Get a standard header to insert in the configuration files automatically generated by the system.

bool omXMLParser::Parse (  wxString  f  )

Parse XML File. The function starts the XML parser and call internal functions to handle parsing operations. Parameters: f  name of the xml file to load Returns: true if keyboard is correcly loaded, false if not

---

Field Documentation

xmlSAXHandler* omXMLParser::omSAXHandler [private]

---

The documentation for this class was generated from the following files:

• omXMLParser.h
• omXMLParser.cpp

 

Created with doxygen on: Tue Jun 8 13:59:50 2004 Copyright © by Luca Clivio