<html> <head><title>ClanLib Reference: CL_Resource</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_Resource</h1><p> <b> Interface representing a resource in the resource manager.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Core (Resources) <p> #include <ClanLib/core.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Resource.html#795"><tt><font color=blue><b>CL_Resource</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>type</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>location</font></tt>, <tt>const</tt> <a href="CL_ResourceOptions.html"><tt><font color=navy><b>CL_ResourceOptions</b></font></tt></a>& <tt><font color=blue>options</font></tt>, <tt>const</tt> <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>& <tt><font color=blue>manager</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Resource.html#796"><tt><font color=blue><b>CL_Resource</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Resource.html#819"><tt><font color=blue><b>CL_Resource</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Resource.html#797"><tt><font color=blue><b>CL_Resource</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Resource.html#798"><tt><font color=blue><b>~CL_Resource</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_Resource.html#799"><tt><font color=blue><b>get_type</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_Resource.html#800"><tt><font color=blue><b>get_name</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_Resource.html#801"><tt><font color=blue><b>get_location</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_Resource.html#802"><tt><font color=blue><b>get_full_location</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><a href="CL_ResourceOptions.html"><tt><font color=navy><b>CL_ResourceOptions</b></font></tt></a>&</tt> </td><td align=right><a href="CL_Resource.html#803"><tt><font color=blue><b>get_options</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a></tt> </td><td align=right><a href="CL_Resource.html#804"><tt><font color=blue><b>get_manager</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_ResourceData.html"><tt><font color=navy><b>CL_ResourceData</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Resource.html#805"><tt><font color=blue><b>get_data</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Resource.html#806"><tt><font color=blue><b>get_reference_count</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=left><h3>Signals:</h3></td> <tr valign=top><td align=right><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> </td><td align=right><a href="CL_Resource.html#807"><tt><font color=blue><b>sig_load_file</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* >&</tt> </td><td align=right><a href="CL_Resource.html#808"><tt><font color=blue><b>sig_load_datafile</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_OutputSourceProvider.html"><tt><font color=navy><b>CL_OutputSourceProvider</b></font></tt></a>* >&</tt> </td><td align=right><a href="CL_Resource.html#809"><tt><font color=blue><b>sig_save_datafile</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> </td><td align=right><a href="CL_Resource.html#810"><tt><font color=blue><b>sig_unload</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Operators:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Resource.html#811"><tt><font color=black><b>operator</b></font></tt><tt> = </tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Resource.html#819"><tt><font color=blue><b>CL_Resource</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Resource.html#812"><tt><font color=blue><b>attach_data</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <a href="CL_ResourceData.html"><tt><font color=navy><b>CL_ResourceData</b></font></tt></a>* <tt><font color=blue>data</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Resource.html#813"><tt><font color=blue><b>detach_data</b></font></tt></a></td><td><tt>(<a href="CL_ResourceData.html"><tt><font color=navy><b>CL_ResourceData</b></font></tt></a>* <tt><font color=blue>data</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Resource.html#814"><tt><font color=blue><b>unload</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Resource.html#815"><tt><font color=blue><b>load</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Resource.html#816"><tt><font color=blue><b>load_file</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Resource.html#817"><tt><font color=blue><b>load_datafile</b></font></tt></a></td><td><tt>(<a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>input_provider</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Resource.html#818"><tt><font color=blue><b>save_datafile</b></font></tt></a></td><td><tt>(<a href="CL_OutputSourceProvider.html"><tt><font color=navy><b>CL_OutputSourceProvider</b></font></tt></a>* <tt><font color=blue>output_provider</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Implementation:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Resource.html#819"><tt><font color=blue><b>CL_Resource</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_Resource_Generic</font></tt>* <tt><font color=blue>impl</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="795"><font size=+1><b>CL_Resource::CL_Resource</b></font></a> - Resource Constructor<br><tt></tt> <a href="CL_Resource.html#795"><tt><font color=blue><b>CL_Resource</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>type</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>location</font></tt>, <tt>const</tt> <a href="CL_ResourceOptions.html"><tt><font color=navy><b>CL_ResourceOptions</b></font></tt></a>& <tt><font color=blue>options</font></tt>, <tt>const</tt> <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>& <tt><font color=blue>manager</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="796"><font size=+1><b>CL_Resource::CL_Resource</b></font></a> - Resource Constructor<br><tt></tt> <a href="CL_Resource.html#796"><tt><font color=blue><b>CL_Resource</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_Resource.html#819"><tt><font color=blue><b>CL_Resource</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="797"><font size=+1><b>CL_Resource::CL_Resource</b></font></a> - Resource Constructor<br><tt></tt> <a href="CL_Resource.html#797"><tt><font color=blue><b>CL_Resource</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="819"><font size=+1><b>CL_Resource::CL_Resource</b></font></a> - Resource Constructor<br><tt></tt> <a href="CL_Resource.html#819"><tt><font color=blue><b>CL_Resource</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_Resource_Generic</font></tt>* <tt><font color=blue>impl</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="812"><font size=+1><b>CL_Resource::attach_data</b></font></a> - Attach some data to the resource.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Resource.html#812"><tt><font color=blue><b>attach_data</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <a href="CL_ResourceData.html"><tt><font color=navy><b>CL_ResourceData</b></font></tt></a>* <tt><font color=blue>data</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="813"><font size=+1><b>CL_Resource::detach_data</b></font></a> - Detach some data from the resource.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Resource.html#813"><tt><font color=blue><b>detach_data</b></font></tt></a><tt>(<a href="CL_ResourceData.html"><tt><font color=navy><b>CL_ResourceData</b></font></tt></a>* <tt><font color=blue>data</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="805"><font size=+1><b>CL_Resource::get_data</b></font></a> - Returns the data with the matching name.<br><tt><a href="CL_ResourceData.html"><tt><font color=navy><b>CL_ResourceData</b></font></tt></a>*</tt> <a href="CL_Resource.html#805"><tt><font color=blue><b>get_data</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="802"><font size=+1><b>CL_Resource::get_full_location</b></font></a> - Returns the full path location of the resource.<br> Use this function if file is to be opened without ClanLib input sources.<br><tt><tt><font color=navy>std::string</font></tt></tt> <a href="CL_Resource.html#802"><tt><font color=blue><b>get_full_location</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="801"><font size=+1><b>CL_Resource::get_location</b></font></a> - Returns the location of the resource (relative to resource definition file).<br> Use this function if file is to be opened with CL_ResourceManager::get_resource_provider().<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_Resource.html#801"><tt><font color=blue><b>get_location</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="804"><font size=+1><b>CL_Resource::get_manager</b></font></a> - Returns the resource manager.<br><tt><a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a></tt> <a href="CL_Resource.html#804"><tt><font color=blue><b>get_manager</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="800"><font size=+1><b>CL_Resource::get_name</b></font></a> - Returns the name of the resource.<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_Resource.html#800"><tt><font color=blue><b>get_name</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="803"><font size=+1><b>CL_Resource::get_options</b></font></a> - Returns the resource options.<br><tt><a href="CL_ResourceOptions.html"><tt><font color=navy><b>CL_ResourceOptions</b></font></tt></a>&</tt> <a href="CL_Resource.html#803"><tt><font color=blue><b>get_options</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="806"><font size=+1><b>CL_Resource::get_reference_count</b></font></a> - Returns the current reference count.<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_Resource.html#806"><tt><font color=blue><b>get_reference_count</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="799"><font size=+1><b>CL_Resource::get_type</b></font></a> - Returns the type of the resource.<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_Resource.html#799"><tt><font color=blue><b>get_type</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="815"><font size=+1><b>CL_Resource::load</b></font></a> - Loads the resource, using the prefered source as specified by the resource manager.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Resource.html#815"><tt><font color=blue><b>load</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="817"><font size=+1><b>CL_Resource::load_datafile</b></font></a> - Loads the resource from the input source.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Resource.html#817"><tt><font color=blue><b>load_datafile</b></font></tt></a><tt>(<a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>input_provider</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="816"><font size=+1><b>CL_Resource::load_file</b></font></a> - Loads the resource from file.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Resource.html#816"><tt><font color=blue><b>load_file</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="811"><font size=+1><b>CL_Resource::operator = </b></font></a> - Copy a resource.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Resource.html#811"><tt><font color=black><b>operator</b></font></tt><tt> = </tt></a><tt>(<tt>const</tt> <a href="CL_Resource.html#819"><tt><font color=blue><b>CL_Resource</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="818"><font size=+1><b>CL_Resource::save_datafile</b></font></a> - Saves the resource to the output source.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Resource.html#818"><tt><font color=blue><b>save_datafile</b></font></tt></a><tt>(<a href="CL_OutputSourceProvider.html"><tt><font color=navy><b>CL_OutputSourceProvider</b></font></tt></a>* <tt><font color=blue>output_provider</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="808"><font size=+1><b>CL_Resource::sig_load_datafile</b></font></a> - Signal invoked when a call to load_datafile is made.<br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* >&</tt> <a href="CL_Resource.html#808"><tt><font color=blue><b>sig_load_datafile</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="807"><font size=+1><b>CL_Resource::sig_load_file</b></font></a> - Signal invoked when a call to load_file is made.<br><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> <a href="CL_Resource.html#807"><tt><font color=blue><b>sig_load_file</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="809"><font size=+1><b>CL_Resource::sig_save_datafile</b></font></a> - Signal invoked when a call to save_datafile is made.<br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<a href="CL_OutputSourceProvider.html"><tt><font color=navy><b>CL_OutputSourceProvider</b></font></tt></a>* >&</tt> <a href="CL_Resource.html#809"><tt><font color=blue><b>sig_save_datafile</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="810"><font size=+1><b>CL_Resource::sig_unload</b></font></a> - Signal invoked when a call to unload is made.<br><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> <a href="CL_Resource.html#810"><tt><font color=blue><b>sig_unload</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="814"><font size=+1><b>CL_Resource::unload</b></font></a> - Unloads the resource from memory.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Resource.html#814"><tt><font color=blue><b>unload</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="798"><font size=+1><b>CL_Resource::~CL_Resource</b></font></a> - Resource Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Resource.html#798"><tt><font color=blue><b>~CL_Resource</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <a name="820"><font size=+1><b>CL_Resource::impl</b></font></a> - Pointer to implementation<br> <tt><tt><font color=navy>CL_Resource_Generic</font></tt> *</tt> <tt><a href="CL_Resource.html#820"><tt><font color=blue>impl</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <hr noshade> </body> </html>
