LibreOffice Module xmloff (master)  1
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
xmloff::OFormLayerXMLImport Class Referencefinal

allows you to import a <form:form> element More...

#include <formlayerimport.hxx>

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

Public Member Functions

 OFormLayerXMLImport (SvXMLImport &_rImporter)
 
virtual ~OFormLayerXMLImport () override
 
void startPage (const css::uno::Reference< css::drawing::XDrawPage > &_rxDrawPage)
 start importing the forms of the given page More...
 
SvXMLImportContextcreateContext (const sal_Int32 _nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &_rxAttribs)
 create an SvXMLImportContext instance which is able to import the <form:form> element. More...
 
css::uno::Reference< css::beans::XPropertySetlookupControl (const OUString &_rId)
 lookup a control given by id. More...
 
void endPage ()
 end importing the forms of the current page More...
 
void setAutoStyleContext (SvXMLStylesContext *_pNewContext)
 announces the auto-style context to the form importer More...
 
void applyControlNumberStyle (const css::uno::Reference< css::beans::XPropertySet > &_rxControlModel, const OUString &_rControlNumberStyleName)
 sets the given number style on the given control More...
 
void documentDone ()
 to be called when the document has been completely imported More...
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Static Public Member Functions

static SvXMLImportContextcreateOfficeFormsContext (SvXMLImport &_rImport)
 creates an import context for the office:forms element More...
 
- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static voidoperator new (std::size_t nSize)
 
static voidoperator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 

Private Attributes

std::unique_ptr< OFormLayerXMLImport_Implm_pImpl
 

Additional Inherited Members

- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

allows you to import a <form:form> element

Definition at line 48 of file formlayerimport.hxx.

Constructor & Destructor Documentation

xmloff::OFormLayerXMLImport::OFormLayerXMLImport ( SvXMLImport _rImporter)

Definition at line 37 of file formlayerimport.cxx.

References m_pImpl.

xmloff::OFormLayerXMLImport::~OFormLayerXMLImport ( )
overridevirtual

Definition at line 42 of file formlayerimport.cxx.

Member Function Documentation

void xmloff::OFormLayerXMLImport::applyControlNumberStyle ( const css::uno::Reference< css::beans::XPropertySet > &  _rxControlModel,
const OUString &  _rControlNumberStyleName 
)

sets the given number style on the given control

Parameters
_rxControlModelthe control model which's style is to be set
_rControlNumberStyleNamethe style name for the control's number style

Definition at line 78 of file formlayerimport.cxx.

References m_pImpl.

SvXMLImportContext * xmloff::OFormLayerXMLImport::createContext ( const sal_Int32  _nElement,
const css::uno::Reference< css::xml::sax::XFastAttributeList > &  _rxAttribs 
)

create an SvXMLImportContext instance which is able to import the <form:form> element.

You must have called <method>startPage</method> before you can create such an import context.

See also
startPage
endPage

Definition at line 72 of file formlayerimport.cxx.

References m_pImpl.

SvXMLImportContext * xmloff::OFormLayerXMLImport::createOfficeFormsContext ( SvXMLImport _rImport)
static

creates an import context for the office:forms element

Definition at line 66 of file formlayerimport.cxx.

References xmloff::OFormLayerXMLImport_Impl::createOfficeFormsContext().

Referenced by SdXMLGenericPageContext::createFastChildContext(), and XMLTextImportHelper::CreateTextChildContext().

void xmloff::OFormLayerXMLImport::documentDone ( )

to be called when the document has been completely imported

For some documents (currently: only some spreadsheet documents) it's necessary do to a post processing, since not all information from the file can be processed if the document is not completed, yet.

Definition at line 83 of file formlayerimport.cxx.

References m_pImpl.

void xmloff::OFormLayerXMLImport::endPage ( )

end importing the forms of the current page

You must call this method if you want the import to be finished correctly. Without calling it, you will lose information.

See also
startPage

Definition at line 56 of file formlayerimport.cxx.

References m_pImpl.

Reference< XPropertySet > xmloff::OFormLayerXMLImport::lookupControl ( const OUString &  _rId)

lookup a control given by id.

The control must be part of the page which is currently being imported.

(And, of course, the control must have been imported already at the moment you call this.)

See also
startPage

Definition at line 61 of file formlayerimport.cxx.

References m_pImpl.

void xmloff::OFormLayerXMLImport::setAutoStyleContext ( SvXMLStylesContext _pNewContext)

announces the auto-style context to the form importer

Definition at line 46 of file formlayerimport.cxx.

References m_pImpl.

void xmloff::OFormLayerXMLImport::startPage ( const css::uno::Reference< css::drawing::XDrawPage > &  _rxDrawPage)

start importing the forms of the given page

starting the import of a new page (by using this method) invalidates the current page position.

See also
endPage

Definition at line 51 of file formlayerimport.cxx.

References m_pImpl.

Member Data Documentation

std::unique_ptr<OFormLayerXMLImport_Impl> xmloff::OFormLayerXMLImport::m_pImpl
private

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