<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Orcus: orcus::spreadsheet::iface::import_factory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Orcus
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>orcus</b></li><li class="navelem"><b>spreadsheet</b></li><li class="navelem"><b>iface</b></li><li class="navelem"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html">import_factory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">orcus::spreadsheet::iface::import_factory Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="import__interface_8hpp_source.html">import_interface.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for orcus::spreadsheet::iface::import_factory:</div>
<div class="dyncontent">
<div class="center">
<img src="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.png" usemap="#orcus::spreadsheet::iface::import_5Ffactory_map" alt=""/>
<map id="orcus::spreadsheet::iface::import_5Ffactory_map" name="orcus::spreadsheet::iface::import_5Ffactory_map">
<area href="classorcus_1_1spreadsheet_1_1import__factory.html" alt="orcus::spreadsheet::import_factory" shape="rect" coords="0,56,240,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a45737cb97291fddaee912681138fca2a"><td class="memItemLeft" align="right" valign="top"><a id="a45737cb97291fddaee912681138fca2a"></a>
virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__global__settings.html">import_global_settings</a> * </td><td class="memItemRight" valign="bottom"><b>get_global_settings</b> ()</td></tr>
<tr class="separator:a45737cb97291fddaee912681138fca2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f9a5034141d70ce92822094ed06fb34"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__shared__strings.html">import_shared_strings</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html#a4f9a5034141d70ce92822094ed06fb34">get_shared_strings</a> ()</td></tr>
<tr class="separator:a4f9a5034141d70ce92822094ed06fb34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4ce52416742918eb392b447618e4c68"><td class="memItemLeft" align="right" valign="top"><a id="af4ce52416742918eb392b447618e4c68"></a>
virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__named__expression.html">import_named_expression</a> * </td><td class="memItemRight" valign="bottom"><b>get_named_expression</b> ()</td></tr>
<tr class="separator:af4ce52416742918eb392b447618e4c68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabf92929d3a512f50cdce328c3001803"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__styles.html">import_styles</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html#aabf92929d3a512f50cdce328c3001803">get_styles</a> ()</td></tr>
<tr class="separator:aabf92929d3a512f50cdce328c3001803"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b1529c29e701db785d15c07980ca47a"><td class="memItemLeft" align="right" valign="top"><a id="a1b1529c29e701db785d15c07980ca47a"></a>
virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__reference__resolver.html">import_reference_resolver</a> * </td><td class="memItemRight" valign="bottom"><b>get_reference_resolver</b> ()</td></tr>
<tr class="separator:a1b1529c29e701db785d15c07980ca47a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac24da7dfd8d6aabf037da4d5b527b84a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__pivot__cache__definition.html">import_pivot_cache_definition</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html#ac24da7dfd8d6aabf037da4d5b527b84a">create_pivot_cache_definition</a> (pivot_cache_id_t cache_id)</td></tr>
<tr class="separator:ac24da7dfd8d6aabf037da4d5b527b84a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a208ed2c9d80954e9684bfb2520d6e5ad"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__pivot__cache__records.html">import_pivot_cache_records</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html#a208ed2c9d80954e9684bfb2520d6e5ad">create_pivot_cache_records</a> (pivot_cache_id_t cache_id)</td></tr>
<tr class="separator:a208ed2c9d80954e9684bfb2520d6e5ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3da179c1d0ef570c1134957c197ef6d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__sheet.html">import_sheet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html#aa3da179c1d0ef570c1134957c197ef6d">append_sheet</a> (sheet_t sheet_index, const char *sheet_name, size_t sheet_name_length)=0</td></tr>
<tr class="separator:aa3da179c1d0ef570c1134957c197ef6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a525b6fb7306a4b844776e3a646502b2a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__sheet.html">import_sheet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html#a525b6fb7306a4b844776e3a646502b2a">get_sheet</a> (const char *sheet_name, size_t sheet_name_length)=0</td></tr>
<tr class="separator:a525b6fb7306a4b844776e3a646502b2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae300a4485d777e93ae7eeb0f888a8e57"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__sheet.html">import_sheet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html#ae300a4485d777e93ae7eeb0f888a8e57">get_sheet</a> (sheet_t sheet_index)=0</td></tr>
<tr class="separator:ae300a4485d777e93ae7eeb0f888a8e57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed296d139b870bd91c4fe1bc815b4c01"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__factory.html#aed296d139b870bd91c4fe1bc815b4c01">finalize</a> ()=0</td></tr>
<tr class="separator:aed296d139b870bd91c4fe1bc815b4c01"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>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.</p>
<p>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. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa3da179c1d0ef570c1134957c197ef6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3da179c1d0ef570c1134957c197ef6d">◆ </a></span>append_sheet()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__sheet.html">import_sheet</a>* orcus::spreadsheet::iface::import_factory::append_sheet </td>
<td>(</td>
<td class="paramtype">sheet_t </td>
<td class="paramname"><em>sheet_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sheet_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>sheet_name_length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Append a sheet with specified sheet position index and name.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sheet_index</td><td>position index of the sheet to be appended. It is 0-based i.e. the first sheet to be appended will have an index value of 0. </td></tr>
<tr><td class="paramname">sheet_name</td><td>pointer to the first character in the buffer where the sheet name is stored. </td></tr>
<tr><td class="paramname">sheet_name_length</td><td>length of the sheet name.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the sheet instance. It may return nullptr if the client app fails to append a new sheet. </dd></dl>
<p>Implemented in <a class="el" href="classorcus_1_1spreadsheet_1_1import__factory.html#ac9140933742b0cd41541c8bcb27ccc18">orcus::spreadsheet::import_factory</a>.</p>
</div>
</div>
<a id="ac24da7dfd8d6aabf037da4d5b527b84a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac24da7dfd8d6aabf037da4d5b527b84a">◆ </a></span>create_pivot_cache_definition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__pivot__cache__definition.html">import_pivot_cache_definition</a>* orcus::spreadsheet::iface::import_factory::create_pivot_cache_definition </td>
<td>(</td>
<td class="paramtype">pivot_cache_id_t </td>
<td class="paramname"><em>cache_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an interface for pivot cache definition import for a specified cache ID. In case a pivot cache alrady exists for the passed ID, the client app should overwrite the existing cache with a brand-new cache instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_id</td><td>numeric ID associated with the pivot cache.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the pivot cache interface instance. If may return NULL if the client app doesn't support pivot tables. </dd></dl>
<p>Reimplemented in <a class="el" href="classorcus_1_1spreadsheet_1_1import__factory.html#a12bfe54038c12cae8b1d9a1a4fe5d26a">orcus::spreadsheet::import_factory</a>.</p>
</div>
</div>
<a id="a208ed2c9d80954e9684bfb2520d6e5ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a208ed2c9d80954e9684bfb2520d6e5ad">◆ </a></span>create_pivot_cache_records()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__pivot__cache__records.html">import_pivot_cache_records</a>* orcus::spreadsheet::iface::import_factory::create_pivot_cache_records </td>
<td>(</td>
<td class="paramtype">pivot_cache_id_t </td>
<td class="paramname"><em>cache_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an interface for pivot cache records import for a specified cache ID.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_id</td><td>numeric ID associated with the pivot cache.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the pivot cache records interface instance. If may return nullptr if the client app doesn't support pivot tables. </dd></dl>
<p>Reimplemented in <a class="el" href="classorcus_1_1spreadsheet_1_1import__factory.html#a61b51731e3d1e3d3cbe4faf2fc9b2a9f">orcus::spreadsheet::import_factory</a>.</p>
</div>
</div>
<a id="aed296d139b870bd91c4fe1bc815b4c01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed296d139b870bd91c4fe1bc815b4c01">◆ </a></span>finalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void orcus::spreadsheet::iface::import_factory::finalize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called at the end of import, to give the implementor a chance to perform post-processing if necessary. </p>
<p>Implemented in <a class="el" href="classorcus_1_1spreadsheet_1_1import__factory.html#a496f4935a2d665873cae756e881b53bd">orcus::spreadsheet::import_factory</a>.</p>
</div>
</div>
<a id="a4f9a5034141d70ce92822094ed06fb34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f9a5034141d70ce92822094ed06fb34">◆ </a></span>get_shared_strings()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__shared__strings.html">import_shared_strings</a>* orcus::spreadsheet::iface::import_factory::get_shared_strings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>pointer to the shared strings instance. It may return NULL if the client app doesn't support shared strings. </dd></dl>
<p>Reimplemented in <a class="el" href="classorcus_1_1spreadsheet_1_1import__factory.html#a0bc32fb6037ae22c804982f8c4cbc118">orcus::spreadsheet::import_factory</a>.</p>
</div>
</div>
<a id="a525b6fb7306a4b844776e3a646502b2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a525b6fb7306a4b844776e3a646502b2a">◆ </a></span>get_sheet() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__sheet.html">import_sheet</a>* orcus::spreadsheet::iface::import_factory::get_sheet </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sheet_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>sheet_name_length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>pointer to the sheet instance whose name matches the name passed to this method. It returns nullptr if no sheet instance exists by the specified name. </dd></dl>
<p>Implemented in <a class="el" href="classorcus_1_1spreadsheet_1_1import__factory.html#a3d821ef0fadd406d8fe9f4dff3c3752c">orcus::spreadsheet::import_factory</a>.</p>
</div>
</div>
<a id="ae300a4485d777e93ae7eeb0f888a8e57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae300a4485d777e93ae7eeb0f888a8e57">◆ </a></span>get_sheet() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__sheet.html">import_sheet</a>* orcus::spreadsheet::iface::import_factory::get_sheet </td>
<td>(</td>
<td class="paramtype">sheet_t </td>
<td class="paramname"><em>sheet_index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve sheet instance by specified numerical sheet index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sheet_index</td><td>sheet index</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the sheet instance, or nullptr if no sheet instance exists at specified sheet index position. </dd></dl>
<p>Implemented in <a class="el" href="classorcus_1_1spreadsheet_1_1import__factory.html#a49965b768611154796c39b799ee785a5">orcus::spreadsheet::import_factory</a>.</p>
</div>
</div>
<a id="aabf92929d3a512f50cdce328c3001803"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabf92929d3a512f50cdce328c3001803">◆ </a></span>get_styles()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classorcus_1_1spreadsheet_1_1iface_1_1import__styles.html">import_styles</a>* orcus::spreadsheet::iface::import_factory::get_styles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>pointer to the styles instance. It may return NULL if the client app doesn't support styles. </dd></dl>
<p>Reimplemented in <a class="el" href="classorcus_1_1spreadsheet_1_1import__factory.html#a4b93de5a9bcb34a1602709dbd922d671">orcus::spreadsheet::import_factory</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 11 2019 05:05:19 for Orcus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
c5c5994443fc6b38a2708a666b93a6de
>
files
>
161
