Orcus
Public Member Functions | List of all members
orcus::spreadsheet::iface::import_factory Class Referenceabstract

#include <import_interface.hpp>

Inheritance diagram for orcus::spreadsheet::iface::import_factory:
orcus::spreadsheet::import_factory

Public Member Functions

virtual import_global_settingsget_global_settings ()
 
virtual import_shared_stringsget_shared_strings ()
 
virtual import_stylesget_styles ()
 
virtual import_sheetappend_sheet (const char *sheet_name, size_t sheet_name_length)=0
 
virtual import_sheetget_sheet (const char *sheet_name, size_t sheet_name_length)=0
 
virtual import_sheetget_sheet (orcus::spreadsheet::sheet_t sheet_index)=0
 
virtual void finalize ()=0
 

Detailed Description

This interface provides the filters a means to instantiate concrete classes that implement the above interfaces. The client code never has to manually delete objects returned by its methods; the implementor of this interface must manage the life cycles of objects it returns.

The implementor of this interface normally wraps the document instance inside it and have the document instance manage the life cycles of various objects it creates.

Member Function Documentation

virtual import_sheet* orcus::spreadsheet::iface::import_factory::append_sheet ( const char *  sheet_name,
size_t  sheet_name_length 
)
pure virtual
Returns
pointer to the sheet instance. It may return NULL if the client app fails to append new sheet.

Implemented in orcus::spreadsheet::import_factory.

virtual void orcus::spreadsheet::iface::import_factory::finalize ( )
pure virtual

This method is called at the end of import, to give the implementor a chance to perform post-processing if necessary.

Implemented in orcus::spreadsheet::import_factory.

virtual import_shared_strings* orcus::spreadsheet::iface::import_factory::get_shared_strings ( )
virtual
Returns
pointer to the shared strings instance. It may return NULL if the client app doesn't support shared strings.

Reimplemented in orcus::spreadsheet::import_factory.

virtual import_sheet* orcus::spreadsheet::iface::import_factory::get_sheet ( const char *  sheet_name,
size_t  sheet_name_length 
)
pure virtual
Returns
pointer to the sheet instance whose name matches the name passed to this method. It returns NULL if no sheet instance exists by the specified name.

Implemented in orcus::spreadsheet::import_factory.

virtual import_sheet* orcus::spreadsheet::iface::import_factory::get_sheet ( orcus::spreadsheet::sheet_t  sheet_index)
pure virtual

Retrieve sheet instance by specified numerical sheet index.

Parameters
sheet_indexsheet index
Returns
pointer to the sheet instance, or NULL if no sheet instance exists at specified sheet index position.

Implemented in orcus::spreadsheet::import_factory.

virtual import_styles* orcus::spreadsheet::iface::import_factory::get_styles ( )
virtual
Returns
pointer to the styles instance. It may return NULL if the client app doesn't support styles.

Reimplemented in orcus::spreadsheet::import_factory.