LibreOffice Module xmloff (master)  1
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
xmloff::OFormExport Class Reference

Helper class for handling xml elements representing a form. More...

#include <elementexport.hxx>

Inheritance diagram for xmloff::OFormExport:
[legend]
Collaboration diagram for xmloff::OFormExport:
[legend]

Public Member Functions

 OFormExport (IFormsExportContext &_rContext, const css::uno::Reference< css::beans::XPropertySet > &_rxForm, const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rxEvents)
 constructs an object capable of exporting controls More...
 
- Public Member Functions inherited from xmloff::OElementExport
 OElementExport (IFormsExportContext &_rContext, const css::uno::Reference< css::beans::XPropertySet > &_rxProps, const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rEvents)
 
virtual ~OElementExport ()
 
void doExport ()
 
- Public Member Functions inherited from xmloff::OPropertyExport
 OPropertyExport (IFormsExportContext &_rContext, const css::uno::Reference< css::beans::XPropertySet > &_rxProps)
 constructs an object capable of handling attributes for export More...
 
template<typename T >
void exportRemainingPropertiesSequence (Any const &value, token::XMLTokenEnum eValueAttName)
 

Protected Member Functions

virtual const char * getXMLElementName () const override
 get the name of the XML element More...
 
virtual void exportSubTags () override
 export any sub tags More...
 
virtual void exportAttributes () override
 export the attributes More...
 
- Protected Member Functions inherited from xmloff::OControlElement
 OControlElement ()
 ctor. More...
 
- Protected Member Functions inherited from xmloff::OElementExport
virtual void examine ()
 examine the element we're exporting More...
 
void exportEvents ()
 exports the events (as script:events tag) More...
 
virtual void exportServiceNameAttribute ()
 add the service-name attribute to the export context More...
 
virtual void implStartElement (const char *_pName)
 start the XML element More...
 
virtual void implEndElement ()
 ends the XML element More...
 
- Protected Member Functions inherited from xmloff::OPropertyExport
void examinePersistence ()
 examines a property set given for all properties which's value are to made persistent More...
 
template<typename T >
void exportRemainingPropertiesSequence (css::uno::Any const &value, token::XMLTokenEnum eValueAttName)
 
void exportRemainingProperties ()
 
void exportedProperty (const OUString &_rPropertyName)
 indicates that a property has been handled by a derived class, without using the helper methods of this class. More...
 
void exportStringPropertyAttribute (const sal_uInt16 _nNamespaceKey, const char *_pAttributeName, const OUString &_rPropertyName)
 add an attribute which is represented by a string property to the export context More...
 
void exportBooleanPropertyAttribute (const sal_uInt16 _nNamespaceKey, const char *_pAttributeName, const OUString &_rPropertyName, const BoolAttrFlags _nBooleanAttributeFlags)
 add an attribute which is represented by a boolean property to the export context More...
 
void exportInt16PropertyAttribute (const sal_uInt16 _nNamespaceKey, const char *_pAttributeName, const OUString &_rPropertyName, const sal_Int16 _nDefault, const bool force=false)
 add an attribute which is represented by a sal_Int16 property to the export context More...
 
void exportInt32PropertyAttribute (const sal_uInt16 _nNamespaceKey, const char *_pAttributeName, const OUString &_rPropertyName, const sal_Int32 _nDefault)
 add an attribute which is represented by a sal_Int32 property to the export context More...
 
template<typename EnumT >
void exportEnumPropertyAttribute (const sal_uInt16 _nNamespaceKey, const char *_pAttributeName, const OUString &_rPropertyName, const SvXMLEnumMapEntry< EnumT > *_pValueMap, const EnumT _nDefault, const bool _bVoidDefault=false)
 add an attribute which is represented by an enum property to the export context More...
 
void exportEnumPropertyAttributeImpl (const sal_uInt16 _nNamespaceKey, const char *_pAttributeName, const OUString &_rPropertyName, const SvXMLEnumMapEntry< sal_uInt16 > *_pValueMap, const sal_uInt16 _nDefault, const bool _bVoidDefault)
 
void exportTargetFrameAttribute ()
 add the hlink:target-frame attribute to the export context. More...
 
void exportTargetLocationAttribute (bool _bAddType)
 add the form:href attribute to the export context. More...
 
void exportImageDataAttribute ()
 add the form:image attribute to the export context. More...
 
void flagStyleProperties ()
 flag the style properties as 'already exported' More...
 
void exportGenericPropertyAttribute (const sal_uInt16 _nAttributeNamespaceKey, const char *_pAttributeName, const char *_pPropertyName)
 add an arbitrary attribute extracted from an arbitrary property to the export context More...
 
void exportStringSequenceAttribute (const sal_uInt16 _nAttributeNamespaceKey, const char *_pAttributeName, const OUString &_rPropertyName)
 exports a property value, which is a string sequence, as attribute More...
 
bool shouldExportProperty (const OUString &i_propertyName) const
 determines whether the given property is to be exported More...
 
OUString implConvertAny (const css::uno::Any &_rValue)
 tries to convert an arbitrary <type scope="com.sun:star.uno">Any</type> into an string More...
 
void AddAttribute (sal_uInt16 _nPrefix, const char *_pName, const OUString &_rValue)
 
void AddAttribute (sal_uInt16 _nPrefix, const OUString &_rName, const OUString &_rValue)
 
void AddAttribute (sal_uInt16 _nPrefix,::xmloff::token::XMLTokenEnum _eName, const OUString &_rValue)
 
void AddAttribute (sal_uInt16 _nPrefix,::xmloff::token::XMLTokenEnum _eName,::xmloff::token::XMLTokenEnum _eValue)
 
void dbg_implCheckProperty (const OUString &_rPropertyName, const css::uno::Type *_pType)
 check a given property set for the existence and type correctness of a given property More...
 

Private Attributes

bool m_bCreateConnectionResourceElement
 

Additional Inherited Members

- Public Types inherited from xmloff::OControlElement
enum  ElementType {
  TEXT = 0,
  TEXT_AREA,
  PASSWORD,
  FILE,
  FORMATTED_TEXT,
  FIXED_TEXT,
  COMBOBOX,
  LISTBOX,
  BUTTON,
  IMAGE,
  CHECKBOX,
  RADIO,
  FRAME,
  IMAGE_FRAME,
  HIDDEN,
  GRID,
  VALUERANGE,
  GENERIC_CONTROL,
  TIME,
  DATE,
  UNKNOWN
}
 
- Static Public Member Functions inherited from xmloff::OControlElement
static const char * getElementName (ElementType _eType)
 retrieves the tag name to be used to describe a control of the given type More...
 
- Static Protected Member Functions inherited from xmloff::OPropertyExport
::xmloff::token::XMLTokenEnum implGetPropertyXMLType (const css::uno::Type &_rType)
 
- Protected Attributes inherited from xmloff::OElementExport
css::uno::Sequence< css::script::ScriptEventDescriptor > m_aEvents
 
std::unique_ptr< SvXMLElementExportm_pXMLElement
 
- Protected Attributes inherited from xmloff::OPropertyExport
IFormsExportContextm_rContext
 
const css::uno::Reference< css::beans::XPropertySetm_xProps
 
const css::uno::Reference< css::beans::XPropertySetInfo > m_xPropertyInfo
 
const css::uno::Reference< css::beans::XPropertyState > m_xPropertyState
 
OUString m_sValueTrue
 
OUString m_sValueFalse
 

Detailed Description

Helper class for handling xml elements representing a form.

In opposite to the class <type>OControlExport</type>, OFormExport is unable to export a complete form. Instead the client has to care for sub elements of the form itself.

Definition at line 292 of file elementexport.hxx.

Constructor & Destructor Documentation

xmloff::OFormExport::OFormExport ( IFormsExportContext _rContext,
const css::uno::Reference< css::beans::XPropertySet > &  _rxForm,
const css::uno::Sequence< css::script::ScriptEventDescriptor > &  _rxEvents 
)

constructs an object capable of exporting controls

Definition at line 1995 of file elementexport.cxx.

References xmloff::OPropertyExport::m_xProps.

Member Function Documentation

void xmloff::OFormExport::exportAttributes ( )
overrideprotectedvirtual

export the attributes

Reimplemented from xmloff::OElementExport.

Definition at line 2038 of file elementexport.cxx.

References xmloff::aCommandTypeMap, xmloff::aNavigationTypeMap, xmloff::aSubmitEncodingMap, xmloff::aSubmitMethodMap, xmloff::aTabulatorCycleMap, aURL, DefaultFalse, DefaultTrue, xmloff::OPropertyExport::exportBooleanPropertyAttribute(), xmloff::OPropertyExport::exportedProperty(), xmloff::OPropertyExport::exportEnumPropertyAttribute(), xmloff::OElementExport::exportServiceNameAttribute(), xmloff::OPropertyExport::exportStringPropertyAttribute(), xmloff::OPropertyExport::exportStringSequenceAttribute(), xmloff::OPropertyExport::exportTargetFrameAttribute(), xmloff::OPropertyExport::exportTargetLocationAttribute(), xmloff::faAllowDeletes, xmloff::faAllowInserts, xmloff::faAllowUpdates, xmloff::faApplyFilter, xmloff::faCommand, xmloff::faCommandType, xmloff::faDatasource, xmloff::faDetailFields, xmloff::faEnctype, xmloff::faEscapeProcessing, xmloff::faFilter, xmloff::faIgnoreResult, xmloff::faMasterFields, xmloff::faMethod, xmloff::faName, xmloff::faNavigationMode, xmloff::faOrder, xmloff::faTabbingCycle, xmloff::OAttributeMetaData::getFormAttributeName(), xmloff::OAttributeMetaData::getFormAttributeNamespace(), INetURLObject::GetProtocol(), i, m_bCreateConnectionResourceElement, xmloff::OPropertyExport::m_xProps, PROPERTY_ALLOWDELETES, PROPERTY_ALLOWINSERTS, PROPERTY_ALLOWUPDATES, PROPERTY_APPLYFILTER, PROPERTY_COMMAND, PROPERTY_COMMAND_TYPE, PROPERTY_CYCLE, PROPERTY_DATASOURCENAME, PROPERTY_DETAILFIELDS, PROPERTY_ESCAPEPROCESSING, PROPERTY_FILTER, PROPERTY_IGNORERESULT, PROPERTY_MASTERFIELDS, PROPERTY_NAME, PROPERTY_NAVIGATION, PROPERTY_ORDER, PROPERTY_SUBMIT_ENCODING, PROPERTY_SUBMIT_METHOD, PROPERTY_URL, and SAL_N_ELEMENTS.

void xmloff::OFormExport::exportSubTags ( )
overrideprotectedvirtual
const char * xmloff::OFormExport::getXMLElementName ( ) const
overrideprotectedvirtual

get the name of the XML element

Implements xmloff::OElementExport.

Definition at line 2003 of file elementexport.cxx.

Member Data Documentation

bool xmloff::OFormExport::m_bCreateConnectionResourceElement
private

Definition at line 296 of file elementexport.hxx.

Referenced by exportAttributes(), and exportSubTags().


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