<html> <head> <link rel="stylesheet" href="page.css" type="text/css"> <title>fox-toolkit.org - Documentation</title> </head> <body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000> <font face='verdana,sans-serif' size=2 > <!---- TOPIC TITLE WITH LOGO---> <table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table> <p> <!--- TOPIC TITLE WITH LOGO ---> <!-- Generated by Doxygen 1.3.3 --> <h1>FX::FXDocument Class Reference</h1>Abstract base class for documents. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="FXDocument_8h-source.html">FXDocument.h</a>></code> <p> <p>Inheritance diagram for FX::FXDocument: <p><center><img src="classFX_1_1FXDocument.png" usemap="#FX::FXDocument_map" border="0" alt=""></center> <map name="FX::FXDocument_map"> <area href="classFX_1_1FXObject.html" alt="FX::FXObject" shape="rect" coords="0,0,108,24"> </map> <a href="classFX_1_1FXDocument-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom>{ <br> <a class="el" href="classFX_1_1FXDocument.html#w3w0">ID_TITLE</a> = 10000, <br> <b>ID_FILENAME</b>, <br> <b>ID_LAST</b> <br> }</td></tr> <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a0">FXDocument</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXbool </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a1">isModified</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a2">setModified</a> (FXbool mdfy=TRUE)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a3">setTitle</a> (const <a class="el" href="classFX_1_1FXString.html">FXString</a> &name)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classFX_1_1FXString.html">FXString</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a4">getTitle</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a5">setFilename</a> (const <a class="el" href="classFX_1_1FXString.html">FXString</a> &path)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classFX_1_1FXString.html">FXString</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a6">getFilename</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a7">save</a> (<a class="el" href="classFX_1_1FXStream.html">FXStream</a> &store) const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a8">load</a> (<a class="el" href="classFX_1_1FXStream.html">FXStream</a> &store)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXDocument.html#a9">~FXDocument</a> ()</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Abstract base class for documents. <p> <hr><h2>Member Enumeration Documentation</h2> <a name="w3" doxytag="FX::FXDocument::@22"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> anonymous enum </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt><b>Enumeration values: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em><a name="w3w0" doxytag="ID_TITLE"></a><em>ID_TITLE</em></em> </td><td> Don't interfere with viewer's message id's. </td></tr> </table> </dl> </td> </tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="FX::FXDocument::FXDocument"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FX::FXDocument::FXDocument </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Constructor. <p> </td> </tr> </table> <a name="a9" doxytag="FX::FXDocument::~FXDocument"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual FX::FXDocument::~<a class="el" href="classFX_1_1FXDocument.html">FXDocument</a> </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Destructor. <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="a1" doxytag="FX::FXDocument::isModified"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FXbool FX::FXDocument::isModified </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return true if document is modified. <p> </td> </tr> </table> <a name="a2" doxytag="FX::FXDocument::setModified"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXDocument::setModified </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXbool </td> <td class="mdname1" valign="top" nowrap> <em>mdfy</em> = TRUE </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Set its modified state. <p> </td> </tr> </table> <a name="a3" doxytag="FX::FXDocument::setTitle"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXDocument::setTitle </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classFX_1_1FXString.html">FXString</a> & </td> <td class="mdname1" valign="top" nowrap> <em>name</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Set document title. <p> </td> </tr> </table> <a name="a4" doxytag="FX::FXDocument::getTitle"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classFX_1_1FXString.html">FXString</a> FX::FXDocument::getTitle </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get document title. <p> </td> </tr> </table> <a name="a5" doxytag="FX::FXDocument::setFilename"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXDocument::setFilename </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classFX_1_1FXString.html">FXString</a> & </td> <td class="mdname1" valign="top" nowrap> <em>path</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Set document filename. <p> </td> </tr> </table> <a name="a6" doxytag="FX::FXDocument::getFilename"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classFX_1_1FXString.html">FXString</a> FX::FXDocument::getFilename </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get document filename. <p> </td> </tr> </table> <a name="a7" doxytag="FX::FXDocument::save"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual void FX::FXDocument::save </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXStream.html">FXStream</a> & </td> <td class="mdname1" valign="top" nowrap> <em>store</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Save document to a stream. <p> <p> Reimplemented from <a class="el" href="classFX_1_1FXObject.html#a3">FX::FXObject</a>. </td> </tr> </table> <a name="a8" doxytag="FX::FXDocument::load"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual void FX::FXDocument::load </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXStream.html">FXStream</a> & </td> <td class="mdname1" valign="top" nowrap> <em>store</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Load document from a stream. <p> <p> Reimplemented from <a class="el" href="classFX_1_1FXObject.html#a4">FX::FXObject</a>. </td> </tr> </table> </font> <!--- COPYRIGHT --> <p> <table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right> <img src='../art/line.gif' width=100% height=1><font size=-1> Copyright © 1997-2004 Jeroen van der Zijp</font> </td></tr></table> </p> <!--- COPYRIGHT --> </body> </html>