Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1362

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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>Crystal Space 1.2.1: csutil/csobject.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/csobject.h</h1><a href="csobject_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 1998-2001 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">    csObject library (C) 1999 by Ivan Avramovic &lt;ivan@avramovic.com&gt;</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSOBJECT_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSOBJECT_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include "csutil/leakguard.h"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="refarr_8h.html" title="Smart Pointer array.">csutil/refarr.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="iutil_2object_8h.html" title="Generic object interface.">iutil/object.h</a>"</span>
<a name="l00034"></a>00034 
<a name="l00035"></a><a class="code" href="csobject_8h.html#dd135d9dbae8ee650e6f620090d6be2d">00035</a> <span class="keyword">typedef</span> <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray&lt;iObject&gt;</a> <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csObjectContainer</a>;
<a name="l00036"></a>00036 
<a name="l00042"></a><a class="code" href="classcsObject.html">00042</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsObject.html" title="A generic csObject class.">csObject</a> : 
<a name="l00043"></a>00043   <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;csObject, iObject&gt;
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">protected</span>:
<a name="l00046"></a><a class="code" href="classcsObject.html#a808c1010616623075c42f0176a0c192">00046</a>   <span class="keyword">friend</span> <span class="keyword">class </span>csObjectIterator;
<a name="l00048"></a><a class="code" href="classcsObject.html#87f8cf898df971529f72c83759a3e5d3">00048</a>   <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> csid;
<a name="l00049"></a>00049 
<a name="l00051"></a><a class="code" href="classcsObject.html#ca035275b1510a504974c133da617b78">00051</a>   <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csObjectContainer</a> *Children;
<a name="l00052"></a>00052 
<a name="l00054"></a><a class="code" href="classcsObject.html#6878e2b755ad607e409c2ebd37ada8db">00054</a>   <span class="keywordtype">char</span> *Name;
<a name="l00055"></a>00055 
<a name="l00057"></a><a class="code" href="classcsObject.html#e4b19f4d796c7671f16cbc0bd68c8b9f">00057</a>   <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *ParentObject;
<a name="l00058"></a>00058 
<a name="l00060"></a><a class="code" href="classcsObject.html#30e0b2027ecd3939d189266deff237d4">00060</a>   <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray&lt;iObjectNameChangeListener&gt;</a> listeners;
<a name="l00061"></a>00061 
<a name="l00063"></a>00063   <span class="keywordtype">void</span> InitializeObject ();
<a name="l00064"></a>00064 
<a name="l00066"></a>00066   <span class="keywordtype">void</span> FireNameChangeListeners (<span class="keyword">const</span> <span class="keywordtype">char</span>* oldname, <span class="keyword">const</span> <span class="keywordtype">char</span>* newname);
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 <span class="keyword">public</span>:
<a name="l00069"></a>00069   CS_LEAKGUARD_DECLARE (<a class="code" href="classcsObject.html" title="A generic csObject class.">csObject</a>);
<a name="l00070"></a>00070 
<a name="l00072"></a>00072   <a class="code" href="classcsObject.html" title="A generic csObject class.">csObject</a> (<a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>* pParent = 0);
<a name="l00073"></a>00073 
<a name="l00079"></a>00079   <a class="code" href="classcsObject.html" title="A generic csObject class.">csObject</a> (<a class="code" href="classcsObject.html" title="A generic csObject class.">csObject</a> &amp;o);
<a name="l00080"></a>00080 
<a name="l00082"></a>00082   <span class="keyword">virtual</span> ~<a class="code" href="classcsObject.html" title="A generic csObject class.">csObject</a> ();
<a name="l00083"></a>00083 
<a name="l00085"></a>00085   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetName (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName);
<a name="l00086"></a>00086 
<a name="l00088"></a>00088   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetName () <span class="keyword">const</span>;
<a name="l00089"></a>00089 
<a name="l00091"></a>00091   <span class="keyword">virtual</span> <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> GetID () <span class="keyword">const</span>;
<a name="l00092"></a>00092 
<a name="l00094"></a>00094   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetObjectParent (<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *);
<a name="l00095"></a>00095 
<a name="l00097"></a>00097   <span class="keyword">virtual</span> <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>* GetObjectParent () <span class="keyword">const</span>;
<a name="l00098"></a>00098 
<a name="l00100"></a>00100   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ObjAdd (<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *obj);
<a name="l00101"></a>00101 
<a name="l00103"></a>00103   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ObjRemove (<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *obj);
<a name="l00104"></a>00104 
<a name="l00106"></a>00106   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ObjRemoveAll ();
<a name="l00107"></a>00107 
<a name="l00109"></a>00109   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ObjAddChildren (<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *Parent);
<a name="l00110"></a>00110 
<a name="l00120"></a>00120   <span class="keyword">virtual</span> <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>* GetChild (<span class="keywordtype">int</span> iInterfaceID, <span class="keywordtype">int</span> iVersion,
<a name="l00121"></a>00121     <span class="keyword">const</span> <span class="keywordtype">char</span> *Name = 0, <span class="keywordtype">bool</span> FirstName = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00122"></a>00122 
<a name="l00124"></a>00124   <span class="keyword">virtual</span> <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *GetChild (<span class="keyword">const</span> <span class="keywordtype">char</span> *Name) <span class="keyword">const</span>;
<a name="l00125"></a>00125 
<a name="l00130"></a>00130   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iObjectIterator&gt;</a> GetIterator ();
<a name="l00131"></a>00131 
<a name="l00132"></a>00132   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddNameChangeListener (
<a name="l00133"></a>00133         <a class="code" href="structiObjectNameChangeListener.html" title="A callback that you can implement to get notified of name changes in an iObject.">iObjectNameChangeListener</a>* listener);
<a name="l00134"></a>00134   <span class="keyword">virtual</span> <span class="keywordtype">void</span> RemoveNameChangeListener (
<a name="l00135"></a>00135         <a class="code" href="structiObjectNameChangeListener.html" title="A callback that you can implement to get notified of name changes in an iObject.">iObjectNameChangeListener</a>* listener);
<a name="l00136"></a>00136 
<a name="l00137"></a>00137   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ObjReleaseOld (<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *obj);
<a name="l00138"></a>00138 };
<a name="l00139"></a>00139 
<a name="l00140"></a>00140 <span class="preprocessor">#endif // __CS_CSOBJECT_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>