<!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: /home/iurt/rpmbuild/BUILD/liborcus-0.14.1/include/orcus/spreadsheet/sheet.hpp Source File</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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8a492e9ce3a64cbb6bdd89913aef68bf.html">orcus</a></li><li class="navelem"><a class="el" href="dir_0666399bcd0e397e91c7990296f1146a.html">spreadsheet</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">sheet.hpp</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * This Source Code Form is subject to the terms of the Mozilla Public</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * License, v. 2.0. If a copy of the MPL was not distributed with this</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> */</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef INCLUDED_ORCUS_SPREADSHEET_ODSTABLE_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define INCLUDED_ORCUS_SPREADSHEET_ODSTABLE_HPP</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "orcus/env.hpp"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "orcus/spreadsheet/types.hpp"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <ostream></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <ixion/address.hpp></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <ixion/formula_tokens.hpp></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>orcus {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">class </span>pstring;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">struct </span>date_time_t;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>spreadsheet {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span>document;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span>sheet_range;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">struct </span>sheet_impl;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">struct </span>auto_filter_t;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classorcus_1_1spreadsheet_1_1sheet.html"> 34</a></span> <span class="keyword">class </span>ORCUS_SPM_DLLPUBLIC <a class="code" href="classorcus_1_1spreadsheet_1_1sheet.html">sheet</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">friend</span> <span class="keyword">struct </span>sheet_impl;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">static</span> <span class="keyword">const</span> row_t max_row_limit;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">static</span> <span class="keyword">const</span> col_t max_col_limit;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classorcus_1_1spreadsheet_1_1sheet.html">sheet</a>(<a class="code" href="classorcus_1_1spreadsheet_1_1document.html">document</a>& doc, sheet_t sheet_index, row_t row_size, col_t col_size);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">virtual</span> ~<a class="code" href="classorcus_1_1spreadsheet_1_1sheet.html">sheet</a>();</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> set_auto(row_t row, col_t col, <span class="keyword">const</span> <span class="keywordtype">char</span>* p, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> set_string(row_t row, col_t col, <span class="keywordtype">size_t</span> sindex);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> set_value(row_t row, col_t col, <span class="keywordtype">double</span> value);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> set_bool(row_t row, col_t col, <span class="keywordtype">bool</span> value);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> set_date_time(row_t row, col_t col, <span class="keywordtype">int</span> year, <span class="keywordtype">int</span> month, <span class="keywordtype">int</span> day, <span class="keywordtype">int</span> hour, <span class="keywordtype">int</span> minute, <span class="keywordtype">double</span> second);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> set_format(row_t row, col_t col, <span class="keywordtype">size_t</span> index);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span> set_format(row_t row_start, col_t col_start, row_t row_end, col_t col_end, <span class="keywordtype">size_t</span> index);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> set_formula(row_t row, col_t col, <span class="keyword">const</span> ixion::formula_tokens_store_ptr_t& <a class="code" href="classorcus_1_1tokens.html">tokens</a>);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> set_grouped_formula(<span class="keyword">const</span> <a class="code" href="structorcus_1_1spreadsheet_1_1range__t.html">range_t</a> range, ixion::formula_tokens_t <a class="code" href="classorcus_1_1tokens.html">tokens</a>);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">void</span> set_formula_result(row_t row, col_t col, <span class="keywordtype">double</span> value);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span> set_formula_result(row_t row, col_t col, <span class="keyword">const</span> <span class="keywordtype">char</span>* p, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> set_col_width(col_t col, col_width_t width);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  col_width_t get_col_width(col_t col, col_t* col_start, col_t* col_end) <span class="keyword">const</span>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> set_col_hidden(col_t col, <span class="keywordtype">bool</span> hidden);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> is_col_hidden(col_t col, col_t* col_start, col_t* col_end) <span class="keyword">const</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> set_row_height(row_t row, row_height_t height);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  row_height_t get_row_height(row_t row, row_t* row_start, row_t* row_end) <span class="keyword">const</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> set_row_hidden(row_t row, <span class="keywordtype">bool</span> hidden);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">bool</span> is_row_hidden(row_t row, row_t* row_start, row_t* row_end) <span class="keyword">const</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">void</span> set_merge_cell_range(<span class="keyword">const</span> <a class="code" href="structorcus_1_1spreadsheet_1_1range__t.html">range_t</a>& range);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="structorcus_1_1spreadsheet_1_1range__t.html">range_t</a> get_merge_cell_range(row_t row, col_t col) <span class="keyword">const</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">size_t</span> get_string_identifier(row_t row, col_t col) <span class="keyword">const</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="structorcus_1_1spreadsheet_1_1auto__filter__t.html">auto_filter_t</a>* get_auto_filter_data();</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">const</span> <a class="code" href="structorcus_1_1spreadsheet_1_1auto__filter__t.html">auto_filter_t</a>* get_auto_filter_data() <span class="keyword">const</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> set_auto_filter_data(<a class="code" href="structorcus_1_1spreadsheet_1_1auto__filter__t.html">auto_filter_t</a>* p);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">// Sheet dimension methods</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  ixion::abs_range_t get_data_range() <span class="keyword">const</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classorcus_1_1spreadsheet_1_1sheet__range.html">sheet_range</a> get_sheet_range(</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  row_t row_start, col_t col_start, row_t row_end, col_t col_end) <span class="keyword">const</span>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  row_t row_size() <span class="keyword">const</span>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  col_t col_size() <span class="keyword">const</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  sheet_t get_index() <span class="keyword">const</span>;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="structorcus_1_1date__time__t.html">date_time_t</a> get_date_time(row_t row, col_t col) <span class="keyword">const</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span> finalize();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> dump_flat(std::ostream& os) <span class="keyword">const</span>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">void</span> dump_check(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classorcus_1_1pstring.html">pstring</a>& sheet_name) <span class="keyword">const</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">void</span> dump_html(std::ostream& os) <span class="keyword">const</span>;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> dump_json(std::ostream& os) <span class="keyword">const</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">void</span> dump_csv(std::ostream& os) <span class="keyword">const</span>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">size_t</span> get_cell_format(row_t row, col_t col) <span class="keyword">const</span>;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  sheet_impl* mp_impl;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> };</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> }}</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">/* vim:set shiftwidth=4 softtabstop=4 expandtab: */</span></div><div class="ttc" id="classorcus_1_1pstring_html"><div class="ttname"><a href="classorcus_1_1pstring.html">orcus::pstring</a></div><div class="ttdef"><b>Definition:</b> pstring.hpp:24</div></div> <div class="ttc" id="structorcus_1_1date__time__t_html"><div class="ttname"><a href="structorcus_1_1date__time__t.html">orcus::date_time_t</a></div><div class="ttdef"><b>Definition:</b> types.hpp:403</div></div> <div class="ttc" id="classorcus_1_1spreadsheet_1_1document_html"><div class="ttname"><a href="classorcus_1_1spreadsheet_1_1document.html">orcus::spreadsheet::document</a></div><div class="ttdef"><b>Definition:</b> document.hpp:47</div></div> <div class="ttc" id="classorcus_1_1spreadsheet_1_1sheet_html"><div class="ttname"><a href="classorcus_1_1spreadsheet_1_1sheet.html">orcus::spreadsheet::sheet</a></div><div class="ttdef"><b>Definition:</b> sheet.hpp:34</div></div> <div class="ttc" id="structorcus_1_1spreadsheet_1_1range__t_html"><div class="ttname"><a href="structorcus_1_1spreadsheet_1_1range__t.html">orcus::spreadsheet::range_t</a></div><div class="ttdef"><b>Definition:</b> types.hpp:358</div></div> <div class="ttc" id="classorcus_1_1tokens_html"><div class="ttname"><a href="classorcus_1_1tokens.html">orcus::tokens</a></div><div class="ttdef"><b>Definition:</b> tokens.hpp:21</div></div> <div class="ttc" id="classorcus_1_1spreadsheet_1_1sheet__range_html"><div class="ttname"><a href="classorcus_1_1spreadsheet_1_1sheet__range.html">orcus::spreadsheet::sheet_range</a></div><div class="ttdef"><b>Definition:</b> sheet_range.hpp:27</div></div> <div class="ttc" id="structorcus_1_1spreadsheet_1_1auto__filter__t_html"><div class="ttname"><a href="structorcus_1_1spreadsheet_1_1auto__filter__t.html">orcus::spreadsheet::auto_filter_t</a></div><div class="ttdef"><b>Definition:</b> auto_filter.hpp:38</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Jan 11 2019 05:05:18 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>