ebElement Class Reference

#include <epubutils/epub_utils.h>

List of all members.

Public Member Functions

 ebElement (const wxString &name=wxEmptyString)
 ebElement (const ebElement &element)
void Init ()
void InitializeInstances ()
 Create at least one instance.
wxString GetDefaultValue () const
 Get default value (Value of first instance).
wxArrayString GetValues () const
 Get all non-empty values.
wxString GetCombinedValue (const wxString &separator=wxT(","), bool useAnd=true) const
 Get combined string value from all instances.
wxVariant * GetDefaultValueVariant ()
 Get the variant corresponding to the default value.
void SetDefaultValue (const wxString &value)
 Set default value (Value of first instance).
wxString GetAttributeValue (const wxString &name) const
 Get the first attribute matching this name.
void SetAttributeValue (const wxString &name, const wxString &value)
 Set the first instance's attribute.
void Clear ()
void Copy (const ebElement &element)
void operator= (const ebElement &element)
bool operator== (const ebElement &element) const
size_t GetCount () const
const ebElementInstanceGetInstance (size_t i) const
ebElementInstanceGetInstance (size_t i)
void AddInstance (const ebElementInstance &instance)
bool RemoveInstance (size_t i)
void SetName (const wxString &name)
 Actual element name.
const wxString & GetName () const
void SetDisplayName (const wxString &name)
 Display name.
const wxString & GetDisplayName () const
wxString GenerateXML (const wxString &indent, const wxString &defaultValue=wxEmptyString) const
 Generate XML for this element.

Protected Attributes

ebElementInstanceArray m_instances
wxString m_name
wxString m_displayName


Detailed Description

ebElement A named element, with one or more instances

Constructor & Destructor Documentation

ebElement::ebElement ( const wxString &  name = wxEmptyString  )  [inline]

ebElement::ebElement ( const ebElement element  )  [inline]


Member Function Documentation

void ebElement::AddInstance ( const ebElementInstance instance  ) 

void ebElement::Clear (  )  [inline]

void ebElement::Copy ( const ebElement element  ) 

wxString ebElement::GenerateXML ( const wxString &  indent,
const wxString &  defaultValue = wxEmptyString 
) const

Generate XML for this element.

wxString ebElement::GetAttributeValue ( const wxString &  name  )  const

Get the first attribute matching this name.

wxString ebElement::GetCombinedValue ( const wxString &  separator = wxT(","),
bool  useAnd = true 
) const

Get combined string value from all instances.

size_t ebElement::GetCount (  )  const [inline]

wxString ebElement::GetDefaultValue (  )  const

Get default value (Value of first instance).

wxVariant* ebElement::GetDefaultValueVariant (  ) 

Get the variant corresponding to the default value.

const wxString& ebElement::GetDisplayName (  )  const [inline]

ebElementInstance& ebElement::GetInstance ( size_t  i  )  [inline]

const ebElementInstance& ebElement::GetInstance ( size_t  i  )  const [inline]

const wxString& ebElement::GetName (  )  const [inline]

wxArrayString ebElement::GetValues (  )  const

Get all non-empty values.

void ebElement::Init (  ) 

void ebElement::InitializeInstances (  ) 

Create at least one instance.

void ebElement::operator= ( const ebElement element  )  [inline]

bool ebElement::operator== ( const ebElement element  )  const

bool ebElement::RemoveInstance ( size_t  i  ) 

void ebElement::SetAttributeValue ( const wxString &  name,
const wxString &  value 
)

Set the first instance's attribute.

void ebElement::SetDefaultValue ( const wxString &  value  ) 

Set default value (Value of first instance).

void ebElement::SetDisplayName ( const wxString &  name  )  [inline]

Display name.

void ebElement::SetName ( const wxString &  name  )  [inline]

Actual element name.


Member Data Documentation

wxString ebElement::m_displayName [protected]

ebElementInstanceArray ebElement::m_instances [protected]

wxString ebElement::m_name [protected]


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

Generated on Wed May 6 19:22:08 2009 for AxTk by  doxygen 1.5.8