📄 classziglet__c.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>ziglet_c class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</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> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>ziglet_c Class Reference</h1>A "ziglet" represents a filesystem directory (folder) where there are "ziglet components" (resource files). ziglet_c offers methods for listing the components and doing version checking on the whole resource directory. You will not instantiate this class yourself, the instances are created for you by a <a class="el" href="classziglet__manager__c.html">ziglet_manager_c</a>. <a href="#_details">More...</a><p><code>#include <<a class="el" href="ziglet_8h-source.html">ziglet.h</a>></code><p><a href="classziglet__c-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 Methods</h2></td></tr><tr><td nowrap align=right valign=top><a name="a1" doxytag="ziglet_c::ziglet_c"></a> </td><td valign=bottom><a class="el" href="classziglet__c.html#a1">ziglet_c</a> (const ziglet_c &z)</td></tr><tr><td> </td><td><font size=-1><em>copy ctor</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a3" doxytag="ziglet_c::update"></a>void </td><td valign=bottom><a class="el" href="classziglet__c.html#a3">update</a> ()</td></tr><tr><td> </td><td><font size=-1><em>update this entire ziglet (first the version list, and then the file list)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a4" doxytag="ziglet_c::update_version_list"></a>void </td><td valign=bottom><a class="el" href="classziglet__c.html#a4">update_version_list</a> ()</td></tr><tr><td> </td><td><font size=-1><em>re-scan disk for all the versions available for this ziglet</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a5" doxytag="ziglet_c::select_version"></a>bool </td><td valign=bottom><a class="el" href="classziglet__c.html#a5">select_version</a> (std::string ver)</td></tr><tr><td> </td><td><font size=-1><em>select current version of this ziglet for operations that need a currentversion set. selecting the current version causes <a class="el" href="classziglet__c.html#a14">update_file_list()</a> to be called.this method calls <a class="el" href="classziglet__c.html#a4">update_version_list()</a> at the beginning automatically.returns true if selection was successful (that is, the version directory existed)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a6" doxytag="ziglet_c::get_versions"></a>std::vector< std::string > </td><td valign=bottom><a class="el" href="classziglet__c.html#a6">get_versions</a> ()</td></tr><tr><td> </td><td><font size=-1><em>get an enumeration of all versions, in descending order (versions[0] is the most recent)this method calls <a class="el" href="classziglet__c.html#a4">update_version_list()</a> at the beginning, automatically.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a7" doxytag="ziglet_c::get_version"></a>std::string </td><td valign=bottom><a class="el" href="classziglet__c.html#a7">get_version</a> ()</td></tr><tr><td> </td><td><font size=-1><em>get the currently selected version. may return "" (empty) string if there are noversion folders inside this ziglet folder or maybe on some other screw-up occasion.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a8" doxytag="ziglet_c::create_version"></a>bool </td><td valign=bottom><a class="el" href="classziglet__c.html#a8">create_version</a> (std::string ver)</td></tr><tr><td> </td><td><font size=-1><em>create a new version inside this ziglet. returns true if successful.this method calls <a class="el" href="classziglet__c.html#a4">update_version_list()</a> at the end, automatically.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a9" doxytag="ziglet_c::delete_version"></a>bool </td><td valign=bottom><a class="el" href="classziglet__c.html#a9">delete_version</a> (std::string ver)</td></tr><tr><td> </td><td><font size=-1><em>remove an old version of this ziglet. returns true if successful.this method calls <a class="el" href="classziglet__c.html#a4">update_version_list()</a> at the end, automatically.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a10" doxytag="ziglet_c::get_prefix"></a>std::string </td><td valign=bottom><a class="el" href="classziglet__c.html#a10">get_prefix</a> ()</td></tr><tr><td> </td><td><font size=-1><em>get the path prefix for loading files of this ziglet, WITHOUT the version folder prefix!example: "c:\ziglets\myziglet\".</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a11" doxytag="ziglet_c::find"></a><a class="el" href="classziglet__component__c.html">ziglet_component_c</a> * </td><td valign=bottom><a class="el" href="classziglet__c.html#a11">find</a> (std::string name)</td></tr><tr><td> </td><td><font size=-1><em>find file by filename (with extension), returns component object wrapper or 0 if not foundsearches only from currently selected version towards the earliest one.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a12" doxytag="ziglet_c::get_first"></a><a class="el" href="classziglet__component__c.html">ziglet_component_c</a> * </td><td valign=bottom><a class="el" href="classziglet__c.html#a12">get_first</a> ()</td></tr><tr><td> </td><td><font size=-1><em>find first file, or 0 if nonesearches only from currently selected version towards the earliest one.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a13" doxytag="ziglet_c::get_next"></a><a class="el" href="classziglet__component__c.html">ziglet_component_c</a> * </td><td valign=bottom><a class="el" href="classziglet__c.html#a13">get_next</a> ()</td></tr><tr><td> </td><td><font size=-1><em>find next file, or 0 if no moresearches only from currently selected version towards the earliest one.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a14" doxytag="ziglet_c::update_file_list"></a>void </td><td valign=bottom><a class="el" href="classziglet__c.html#a14">update_file_list</a> ()</td></tr><tr><td> </td><td><font size=-1><em>re-scan the file system and update the internal component list for this ziglet.this method is dependant on the current version selected in <a class="el" href="classziglet__c.html#a5">select_version()</a>. ifno version was ever selected, then it is assumed that the most recent version isthe one selected.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a15" doxytag="ziglet_c::get_name"></a>std::string </td><td valign=bottom><a class="el" href="classziglet__c.html#a15">get_name</a> ()</td></tr><tr><td> </td><td><font size=-1><em>get name</em></font><br><br></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>A "ziglet" represents a filesystem directory (folder) where there are "ziglet components" (resource files). ziglet_c offers methods for listing the components and doing version checking on the whole resource directory. You will not instantiate this class yourself, the instances are created for you by a <a class="el" href="classziglet__manager__c.html">ziglet_manager_c</a>.<p><hr>The documentation for this class was generated from the following files:<ul><li><a class="el" href="ziglet_8h-source.html">ziglet.h</a><li>ziglet.cpp</ul><hr><address style="align: right;"><small>Generated on Mon Jan 24 21:14:23 2005 for ZIG by<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.18 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -