<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libvisio::VisioDocument Class Reference documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classlibvisio_1_1VisioDocument.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classlibvisio_1_1VisioDocument-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">libvisio::VisioDocument Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="VisioDocument_8h_source.html">VisioDocument.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a887173084f8fbdd35b9a2082772b7a4e"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibvisio_1_1VisioDocument.html#a887173084f8fbdd35b9a2082772b7a4e">isSupported</a> (WPXInputStream *input)</td></tr>
<tr class="memdesc:a887173084f8fbdd35b9a2082772b7a4e"><td class="mdescLeft"> </td><td class="mdescRight">Analyzes the content of an input stream to see if it can be parsed. <a href="#a887173084f8fbdd35b9a2082772b7a4e">More...</a><br/></td></tr>
<tr class="separator:a887173084f8fbdd35b9a2082772b7a4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6dc0f7b4d7e432956965cd76630957f0"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibvisio_1_1VisioDocument.html#a6dc0f7b4d7e432956965cd76630957f0">parse</a> (WPXInputStream *input, libwpg::WPGPaintInterface *painter)</td></tr>
<tr class="memdesc:a6dc0f7b4d7e432956965cd76630957f0"><td class="mdescLeft"> </td><td class="mdescRight">Parses the input stream content. <a href="#a6dc0f7b4d7e432956965cd76630957f0">More...</a><br/></td></tr>
<tr class="separator:a6dc0f7b4d7e432956965cd76630957f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b234424f04826a03c7ef3b85cba5607"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibvisio_1_1VisioDocument.html#a1b234424f04826a03c7ef3b85cba5607">parseStencils</a> (WPXInputStream *input, libwpg::WPGPaintInterface *painter)</td></tr>
<tr class="memdesc:a1b234424f04826a03c7ef3b85cba5607"><td class="mdescLeft"> </td><td class="mdescRight">Parses the input stream content and extracts stencil pages, one stencil page per output page. <a href="#a1b234424f04826a03c7ef3b85cba5607">More...</a><br/></td></tr>
<tr class="separator:a1b234424f04826a03c7ef3b85cba5607"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4264dd82f8acd960aedb437be0febbf"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibvisio_1_1VisioDocument.html#ae4264dd82f8acd960aedb437be0febbf">generateSVG</a> (WPXInputStream *input, <a class="el" href="classlibvisio_1_1VSDStringVector.html">VSDStringVector</a> &output)</td></tr>
<tr class="memdesc:ae4264dd82f8acd960aedb437be0febbf"><td class="mdescLeft"> </td><td class="mdescRight">Parses the input stream content and generates a valid Scalable Vector Graphics Provided as a convenience function for applications that support SVG internally. <a href="#ae4264dd82f8acd960aedb437be0febbf">More...</a><br/></td></tr>
<tr class="separator:ae4264dd82f8acd960aedb437be0febbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77ecb4d0c1086d38377d33a51510b55e"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibvisio_1_1VisioDocument.html#a77ecb4d0c1086d38377d33a51510b55e">generateSVGStencils</a> (WPXInputStream *input, <a class="el" href="classlibvisio_1_1VSDStringVector.html">VSDStringVector</a> &output)</td></tr>
<tr class="memdesc:a77ecb4d0c1086d38377d33a51510b55e"><td class="mdescLeft"> </td><td class="mdescRight">Parses the input stream content and extracts stencil pages. <a href="#a77ecb4d0c1086d38377d33a51510b55e">More...</a><br/></td></tr>
<tr class="separator:a77ecb4d0c1086d38377d33a51510b55e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae4264dd82f8acd960aedb437be0febbf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool libvisio::VisioDocument::generateSVG </td>
<td>(</td>
<td class="paramtype">WPXInputStream * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlibvisio_1_1VSDStringVector.html">VSDStringVector</a> & </td>
<td class="paramname"><em>output</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the input stream content and generates a valid Scalable Vector Graphics Provided as a convenience function for applications that support SVG internally. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>The input stream </td></tr>
<tr><td class="paramname">output</td><td>The output string whose content is the resulting SVG </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value that indicates whether the SVG generation was successful. </dd></dl>
</div>
</div>
<a class="anchor" id="a77ecb4d0c1086d38377d33a51510b55e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool libvisio::VisioDocument::generateSVGStencils </td>
<td>(</td>
<td class="paramtype">WPXInputStream * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlibvisio_1_1VSDStringVector.html">VSDStringVector</a> & </td>
<td class="paramname"><em>output</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the input stream content and extracts stencil pages. </p>
<p>It generates a valid Scalable Vector Graphics document per stencil. Provided as a convenience function for applications that support SVG internally. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>The input stream </td></tr>
<tr><td class="paramname">output</td><td>The output string whose content is the resulting SVG </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value that indicates whether the SVG generation was successful. </dd></dl>
</div>
</div>
<a class="anchor" id="a887173084f8fbdd35b9a2082772b7a4e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool libvisio::VisioDocument::isSupported </td>
<td>(</td>
<td class="paramtype">WPXInputStream * </td>
<td class="paramname"><em>input</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Analyzes the content of an input stream to see if it can be parsed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>The input stream </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value that indicates whether the content from the input stream is a Visio Document that libvisio able to parse </dd></dl>
</div>
</div>
<a class="anchor" id="a6dc0f7b4d7e432956965cd76630957f0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool libvisio::VisioDocument::parse </td>
<td>(</td>
<td class="paramtype">WPXInputStream * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">libwpg::WPGPaintInterface * </td>
<td class="paramname"><em>painter</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the input stream content. </p>
<p>It will make callbacks to the functions provided by a WPGPaintInterface class implementation when needed. This is often commonly called the 'main parsing routine'. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>The input stream </td></tr>
<tr><td class="paramname">painter</td><td>A WPGPainterInterface implementation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value that indicates whether the parsing was successful </dd></dl>
<p>Referenced by <a class="el" href="classlibvisio_1_1VisioDocument.html#ae4264dd82f8acd960aedb437be0febbf">generateSVG()</a>.</p>
</div>
</div>
<a class="anchor" id="a1b234424f04826a03c7ef3b85cba5607"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool libvisio::VisioDocument::parseStencils </td>
<td>(</td>
<td class="paramtype">WPXInputStream * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">libwpg::WPGPaintInterface * </td>
<td class="paramname"><em>painter</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the input stream content and extracts stencil pages, one stencil page per output page. </p>
<p>It will make callbacks to the functions provided by a WPGPaintInterface class implementation when needed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>The input stream </td></tr>
<tr><td class="paramname">painter</td><td>A WPGPainterInterface implementation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value that indicates whether the parsing was successful </dd></dl>
<p>Referenced by <a class="el" href="classlibvisio_1_1VisioDocument.html#a77ecb4d0c1086d38377d33a51510b55e">generateSVGStencils()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="VisioDocument_8h_source.html">VisioDocument.h</a></li>
<li><a class="el" href="VisioDocument_8cpp.html">VisioDocument.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<hr size="1"><address style="align: right;"><small>
Generated for libvisio by <a href="http://www.doxygen.org/index.html">
doxygen</a> 1.8.3.1</small></address>
</body>
</html>
