root/campo-sirio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
campo-sirio/wxPG/propgrid/docs/html/classwxPGEditableState.htm
mtollari a3ed46f2c3 Spostamento cartelle da extlib 
git-svn-id: svn://10.65.10.50/branches/R_10_00@23289 c028cbd2-c16b-5b4b-a496-9718f37d4682
2016-09-14 21:14:51 +00:00

328 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>wxPropertyGrid: wxPGEditableState Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.htm"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li class="current"><a href="classes.htm"><span>Classes</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.htm"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.htm"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.htm"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>wxPGEditableState Class Reference</h1><!-- doxytag: class="wxPGEditableState" --><code>#include &lt;propgrid.h&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for wxPGEditableState:</div>
<div class="dynsection">
<p><center><img src="classwxPGEditableState.png" usemap="#wxPGEditableState_map" border="0" alt=""></center>
<map name="wxPGEditableState_map">
<area href="classwxPGMEditableState.htm" alt="wxPGMEditableState" shape="rect" coords="0,56,128,80">
</map>
</div>
<p>
<a href="classwxPGEditableState-members.htm">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Contains information about wxPropertyGrid's user-editable state, as returned by <a class="el" href="classwxPropertyGrid.htm#493decd8071f100036f72acfa7b05795" title="Used to acquire user-editable state (selected property, expanded properties, scrolled...">wxPropertyGrid::SaveEditableState()</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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditableState.htm#501acdc0a4eba81c755cad80a3bd3dc1">IncludeFlags</a> { <br>
&nbsp;&nbsp;<a class="el" href="classwxPGEditableState.htm#501acdc0a4eba81c755cad80a3bd3dc12c1e860f5bd173cacf429695134d7f7d">Selection</a> = 0x01,
<a class="el" href="classwxPGEditableState.htm#501acdc0a4eba81c755cad80a3bd3dc16379fb1a1388424a4b61870fd86c6046">Expanded</a> = 0x02,
<a class="el" href="classwxPGEditableState.htm#501acdc0a4eba81c755cad80a3bd3dc1e5a6556bc3de4a7b0de2a296a88757b5">ScrollPos</a> = 0x04,
<a class="el" href="classwxPGEditableState.htm#501acdc0a4eba81c755cad80a3bd3dc1a683d9639faad1a267283b6f828845d1">Page</a> = 0x08,
<br>
&nbsp;&nbsp;<a class="el" href="classwxPGEditableState.htm#501acdc0a4eba81c755cad80a3bd3dc12f4d20fc207cbff5af0b4aab0a2ebb4f">SplitterPos</a> = 0x10,
<a class="el" href="classwxPGEditableState.htm#501acdc0a4eba81c755cad80a3bd3dc14ab629ac1fdee634b965d601f4d89e09">All</a> = Selection | Expanded | ScrollPos | Page | SplitterPos
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">wxString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditableState.htm#157ef4c0263424d91a1e0f01ad18b940">GetAsString</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df41cf697d0a73d3e1b44b060d05bf34"></a><!-- doxytag: member="wxPGEditableState::GetExpanded" ref="df41cf697d0a73d3e1b44b060d05bf34" args="() const " -->
const wxArrayString &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetExpanded</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3380015db4ce25a1a3edd7590d14a0fd"></a><!-- doxytag: member="wxPGEditableState::GetScrollPos" ref="3380015db4ce25a1a3edd7590d14a0fd" args="() const " -->
wxPoint&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetScrollPos</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="27b108872d1e13e2ae5ac2656ed740e9"></a><!-- doxytag: member="wxPGEditableState::GetSelection" ref="27b108872d1e13e2ae5ac2656ed740e9" args="() const " -->
const wxString &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetSelection</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9221a095e67b313cd0de3ef0b928a996"></a><!-- doxytag: member="wxPGEditableState::GetSplitterPos" ref="9221a095e67b313cd0de3ef0b928a996" args="() const " -->
const wxArrayInt &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetSplitterPos</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aee1d3d1725c1adbaf93218f16781e1c"></a><!-- doxytag: member="wxPGEditableState::HasFlag" ref="aee1d3d1725c1adbaf93218f16781e1c" args="(int flag) const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>HasFlag</b> (int flag) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6cb3bcb61e6e481e3012e8adb8b0549b"></a><!-- doxytag: member="wxPGEditableState::SetExpanded" ref="6cb3bcb61e6e481e3012e8adb8b0549b" args="(const wxPropertyContainerMethods *propIface)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetExpanded</b> (const <a class="el" href="classwxPropertyContainerMethods.htm">wxPropertyContainerMethods</a> *propIface)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditableState.htm#241afc46f26d80dc262ae849ce0a3cc8">SetFromString</a> (const wxString &amp;str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a40cd0abcecc84ad0e2a4e4beec389d"></a><!-- doxytag: member="wxPGEditableState::SetScrollPos" ref="7a40cd0abcecc84ad0e2a4e4beec389d" args="(int h, int v)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetScrollPos</b> (int h, int v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9747cf6b0fc9531851a3a4f7bb09551c"></a><!-- doxytag: member="wxPGEditableState::SetSelection" ref="9747cf6b0fc9531851a3a4f7bb09551c" args="(const wxString &amp;selection)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetSelection</b> (const wxString &amp;selection)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0e64dbf663e6ba79da6f9af11f141d4"></a><!-- doxytag: member="wxPGEditableState::SetSplitterPos" ref="e0e64dbf663e6ba79da6f9af11f141d4" args="(int pos)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetSplitterPos</b> (int pos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditableState.htm#c11e470a49020ae20554edeed9d6acab">wxPGEditableState</a> (const wxString &amp;str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditableState.htm#fe56d75515887a29ac66ca9329d8fd18">wxPGEditableState</a> (const <a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *pg, int includedState=All)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditableState.htm#ff42089018ad7d68ceb9365fb89157ef">wxPGEditableState</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditableState.htm#9c502de3b04daa4402e8a8686a2cb4e4">~wxPGEditableState</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5317fd47cdc40e6323fa654d4128782b"></a><!-- doxytag: member="wxPGEditableState::m_expanded" ref="5317fd47cdc40e6323fa654d4128782b" args="" -->
wxArrayString&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_expanded</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d73d1903f084e1aa70ada5996b7d63e"></a><!-- doxytag: member="wxPGEditableState::m_flags" ref="7d73d1903f084e1aa70ada5996b7d63e" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_flags</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acec5e6e066d60129e5606087ceb9b5b"></a><!-- doxytag: member="wxPGEditableState::m_hScrollPos" ref="acec5e6e066d60129e5606087ceb9b5b" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_hScrollPos</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1cd762dd4af59aaaf3023280f9e770d4"></a><!-- doxytag: member="wxPGEditableState::m_page" ref="1cd762dd4af59aaaf3023280f9e770d4" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_page</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2f5f813f58c7b5699bb6564c8b3f5488"></a><!-- doxytag: member="wxPGEditableState::m_selection" ref="2f5f813f58c7b5699bb6564c8b3f5488" args="" -->
wxString&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_selection</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dee4a653039101426e949767eb8bf5db"></a><!-- doxytag: member="wxPGEditableState::m_splitterPos" ref="dee4a653039101426e949767eb8bf5db" args="" -->
wxArrayInt&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_splitterPos</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0646eb23adafed3d60e50b4bf71f42d"></a><!-- doxytag: member="wxPGEditableState::m_vScrollPos" ref="e0646eb23adafed3d60e50b4bf71f42d" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_vScrollPos</b></td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="501acdc0a4eba81c755cad80a3bd3dc1"></a><!-- doxytag: member="wxPGEditableState::IncludeFlags" ref="501acdc0a4eba81c755cad80a3bd3dc1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classwxPGEditableState.htm#501acdc0a4eba81c755cad80a3bd3dc1">wxPGEditableState::IncludeFlags</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flags to be used with <a class="el" href="classwxPropertyGrid.htm#493decd8071f100036f72acfa7b05795" title="Used to acquire user-editable state (selected property, expanded properties, scrolled...">wxPropertyGrid::SaveEditableState()</a>.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="501acdc0a4eba81c755cad80a3bd3dc12c1e860f5bd173cacf429695134d7f7d"></a><!-- doxytag: member="Selection" ref="501acdc0a4eba81c755cad80a3bd3dc12c1e860f5bd173cacf429695134d7f7d" args="" -->Selection</em>&nbsp;</td><td>
Include selected property.
<p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="501acdc0a4eba81c755cad80a3bd3dc16379fb1a1388424a4b61870fd86c6046"></a><!-- doxytag: member="Expanded" ref="501acdc0a4eba81c755cad80a3bd3dc16379fb1a1388424a4b61870fd86c6046" args="" -->Expanded</em>&nbsp;</td><td>
Include expanded/collapsed property information.
<p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="501acdc0a4eba81c755cad80a3bd3dc1e5a6556bc3de4a7b0de2a296a88757b5"></a><!-- doxytag: member="ScrollPos" ref="501acdc0a4eba81c755cad80a3bd3dc1e5a6556bc3de4a7b0de2a296a88757b5" args="" -->ScrollPos</em>&nbsp;</td><td>
Include scrolled position.
<p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="501acdc0a4eba81c755cad80a3bd3dc1a683d9639faad1a267283b6f828845d1"></a><!-- doxytag: member="Page" ref="501acdc0a4eba81c755cad80a3bd3dc1a683d9639faad1a267283b6f828845d1" args="" -->Page</em>&nbsp;</td><td>
Include selected page information.
<p>
Only applies to <a class="el" href="classwxPropertyGridManager.htm" title="wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid, which...">wxPropertyGridManager</a>. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="501acdc0a4eba81c755cad80a3bd3dc12f4d20fc207cbff5af0b4aab0a2ebb4f"></a><!-- doxytag: member="SplitterPos" ref="501acdc0a4eba81c755cad80a3bd3dc12f4d20fc207cbff5af0b4aab0a2ebb4f" args="" -->SplitterPos</em>&nbsp;</td><td>
Include splitter position.
<p>
Stored for each page. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="501acdc0a4eba81c755cad80a3bd3dc14ab629ac1fdee634b965d601f4d89e09"></a><!-- doxytag: member="All" ref="501acdc0a4eba81c755cad80a3bd3dc14ab629ac1fdee634b965d601f4d89e09" args="" -->All</em>&nbsp;</td><td>
Include all supported user editable state information.
<p>
This is usually the default value. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="ff42089018ad7d68ceb9365fb89157ef"></a><!-- doxytag: member="wxPGEditableState::wxPGEditableState" ref="ff42089018ad7d68ceb9365fb89157ef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxPGEditableState::wxPGEditableState </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
</div>
</div><p>
<a class="anchor" name="fe56d75515887a29ac66ca9329d8fd18"></a><!-- doxytag: member="wxPGEditableState::wxPGEditableState" ref="fe56d75515887a29ac66ca9329d8fd18" args="(const wxPropertyGrid *pg, int includedState=All)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxPGEditableState::wxPGEditableState </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *&nbsp;</td>
<td class="paramname"> <em>pg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>includedState</em> = <code>All</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
</div>
</div><p>
<a class="anchor" name="c11e470a49020ae20554edeed9d6acab"></a><!-- doxytag: member="wxPGEditableState::wxPGEditableState" ref="c11e470a49020ae20554edeed9d6acab" args="(const wxString &amp;str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxPGEditableState::wxPGEditableState </td>
<td>(</td>
<td class="paramtype">const wxString &amp;&nbsp;</td>
<td class="paramname"> <em>str</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
</div>
</div><p>
<a class="anchor" name="9c502de3b04daa4402e8a8686a2cb4e4"></a><!-- doxytag: member="wxPGEditableState::~wxPGEditableState" ref="9c502de3b04daa4402e8a8686a2cb4e4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual wxPGEditableState::~wxPGEditableState </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="157ef4c0263424d91a1e0f01ad18b940"></a><!-- doxytag: member="wxPGEditableState::GetAsString" ref="157ef4c0263424d91a1e0f01ad18b940" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxString wxPGEditableState::GetAsString </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Encodes state information in a string.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>String is not guaranteed to have any particular format, except one that should be readable by <a class="el" href="classwxPGEditableState.htm#241afc46f26d80dc262ae849ce0a3cc8" title="Decodes state information from a string.">SetFromString()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="241afc46f26d80dc262ae849ce0a3cc8"></a><!-- doxytag: member="wxPGEditableState::SetFromString" ref="241afc46f26d80dc262ae849ce0a3cc8" args="(const wxString &amp;str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxPGEditableState::SetFromString </td>
<td>(</td>
<td class="paramtype">const wxString &amp;&nbsp;</td>
<td class="paramname"> <em>str</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decodes state information from a string.
<p>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Returns</em>&nbsp;</td><td>true if string was read properly. On false, <a class="el" href="classwxPGEditableState.htm" title="Contains information about wxPropertyGrid&#39;s user-editable state, as returned...">wxPGEditableState</a> will remain in undefined state. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>propgrid.h</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 4 20:56:36 2008 for wxPropertyGrid by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink