campo-sirio/wxPG/propgrid/docs/html/classwxPropertyGridPage.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

291 lines
21 KiB
HTML

<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>wxPropertyGrid: wxPropertyGridPage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<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="annotated.htm"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.htm"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.htm"><span>Class&nbsp;Index</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>wxPropertyGridPage Class Reference</h1><!-- doxytag: class="wxPropertyGridPage" --><!-- doxytag: inherits="wxPropertyGridInterface,wxPropertyGridState" -->
<p>Holder of property grid page information.
<a href="#_details">More...</a></p>
<p><code>#include &lt;manager.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for wxPropertyGridPage:</div>
<div class="dynsection">
<div class="center">
<img src="classwxPropertyGridPage.png" usemap="#wxPropertyGridPage_map" alt=""/>
<map id="wxPropertyGridPage_map" name="wxPropertyGridPage_map">
<area href="classwxPropertyGridInterface.htm" alt="wxPropertyGridInterface" shape="rect" coords="0,0,150,24"/>
<area href="classwxPropertyGridState.htm" alt="wxPropertyGridState" shape="rect" coords="160,0,310,24"/>
</map>
</div>
</div>
<p><a href="classwxPropertyGridPage-members.htm">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a702b0d8cd205cf29c8888e80e3e426a4"></a><!-- doxytag: member="wxPropertyGridPage::Clear" ref="a702b0d8cd205cf29c8888e80e3e426a4" args="()" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a702b0d8cd205cf29c8888e80e3e426a4">Clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes all properties on page. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">wxSize&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a97fdd418c9e8727e1800428e30c6164c">FitColumns</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well). <a href="#a97fdd418c9e8727e1800428e30c6164c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a66eb036e9bd5592904446f991a013b"></a><!-- doxytag: member="wxPropertyGridPage::GetIndex" ref="a4a66eb036e9bd5592904446f991a013b" args="() const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a4a66eb036e9bd5592904446f991a013b">GetIndex</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns page index in manager;. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#ac2d74a899d99af4182a307af41be42b8">GetRoot</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns "root property". <a href="#ac2d74a899d99af4182a307af41be42b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7309da21cd3a505fb6fe53cd36cff677"></a><!-- doxytag: member="wxPropertyGridPage::GetSplitterPosition" ref="a7309da21cd3a505fb6fe53cd36cff677" args="(int col=0) const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a7309da21cd3a505fb6fe53cd36cff677">GetSplitterPosition</a> (int col=0) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns x-coordinate position of splitter on a page. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a275999256805eb1231532915053407e8"></a><!-- doxytag: member="wxPropertyGridPage::GetStatePtr" ref="a275999256805eb1231532915053407e8" args="() const " -->
const <a class="el" href="classwxPropertyGridState.htm">wxPropertyGridState</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a275999256805eb1231532915053407e8">GetStatePtr</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return pointer to contained property grid state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed1b61c2b7f64aa18cff9ba7fb36ed41"></a><!-- doxytag: member="wxPropertyGridPage::GetStatePtr" ref="aed1b61c2b7f64aa18cff9ba7fb36ed41" args="()" -->
<a class="el" href="classwxPropertyGridState.htm">wxPropertyGridState</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#aed1b61c2b7f64aa18cff9ba7fb36ed41">GetStatePtr</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return pointer to contained property grid state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8662f6cd2fd234a959493e4a3c693d2e"></a><!-- doxytag: member="wxPropertyGridPage::GetToolId" ref="a8662f6cd2fd234a959493e4a3c693d2e" args="() const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a8662f6cd2fd234a959493e4a3c693d2e">GetToolId</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns id of the tool bar item that represents this page on wxPropertyGridManager's wxToolBar. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#aada6353fdf4ff5e1d2196001f2404283">Init</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do any member initialization in this method. <a href="#aada6353fdf4ff5e1d2196001f2404283"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21a33aea3b2c498c0cf63a79c70952ef"></a><!-- doxytag: member="wxPropertyGridPage::IsHandlingAllEvents" ref="a21a33aea3b2c498c0cf63a79c70952ef" args="() const " -->
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a21a33aea3b2c498c0cf63a79c70952ef">IsHandlingAllEvents</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return false here to indicate unhandled events should be propagated to manager's parent, as normal. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#ab60f9672f417f1f124d7e777185a9263">OnShow</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called every time page is about to be shown. <a href="#ab60f9672f417f1f124d7e777185a9263"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac66be7baa5683eddb727d75dfddabd88"></a><!-- doxytag: member="wxPropertyGridPage::RefreshProperty" ref="ac66be7baa5683eddb727d75dfddabd88" args="(wxPGProperty *p)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>RefreshProperty</b> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a487917dd83814af6d6023280b8589fec">SetSplitterPosition</a> (int splitterPos, int col=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets splitter position on page. <a href="#a487917dd83814af6d6023280b8589fec"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76bc2646882cd4cbbbf4dd599140d9c5"></a><!-- doxytag: member="wxPropertyGridPage::DoSetSplitterPosition" ref="a76bc2646882cd4cbbbf4dd599140d9c5" args="(int pos, int splitterColumn=0, bool allPages=false, bool fromAutoCenter=false)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a76bc2646882cd4cbbbf4dd599140d9c5">DoSetSplitterPosition</a> (int pos, int splitterColumn=0, bool allPages=false, bool fromAutoCenter=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Propagate to other pages. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd8b6713455d996588cf5d1ddc815543"></a><!-- doxytag: member="wxPropertyGridPage::m_id" ref="abd8b6713455d996588cf5d1ddc815543" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">wxString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyGridPage.htm#a0fecf08e1b1bd2c25ea859839e345ba7">m_label</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Page label (may be referred as name in some parts of documentation). <a href="#a0fecf08e1b1bd2c25ea859839e345ba7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7447c6871d8e8214f70552f97d035ab"></a><!-- doxytag: member="wxPropertyGridPage::m_manager" ref="aa7447c6871d8e8214f70552f97d035ab" args="" -->
<a class="el" href="classwxPropertyGridManager.htm">wxPropertyGridManager</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_manager</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Holder of property grid page information. </p>
<p>You can subclass this and give instance in <a class="el" href="classwxPropertyGridManager.htm#aed7ea6d2c2a8c4df915cc3d2525f2aa4" title="Creates new property page.">wxPropertyGridManager::AddPage</a>. It inherits from wxEvtHandler and can be used to process events specific to this page (id of events will still be same as manager's). If you don't want to use it to process all events of the page, you need to return false in the derived <a class="el" href="classwxPropertyGridPage.htm#a21a33aea3b2c498c0cf63a79c70952ef" title="Return false here to indicate unhandled events should be propagated to manager&#39;s...">wxPropertyGridPage::IsHandlingAllEvents</a>.</p>
<p>Please note that <a class="el" href="classwxPropertyGridPage.htm" title="Holder of property grid page information.">wxPropertyGridPage</a> lacks many non-const property manipulation functions found in <a class="el" href="classwxPropertyGridManager.htm" title="wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid, which...">wxPropertyGridManager</a>. Please use parent manager (m_manager member variable) when needed.</p>
<p>Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read <a class="el" href="classwxPropertyGridInterface.htm" title="In order to have most same base methods, both wxPropertyGrid and wxPropertyGridManager...">wxPropertyGridInterface</a> class reference.</p>
<h4>Derived from</h4>
<p><a class="el" href="classwxPropertyGridInterface.htm" title="In order to have most same base methods, both wxPropertyGrid and wxPropertyGridManager...">wxPropertyGridInterface</a><br/>
<a class="el" href="classwxPropertyGridState.htm" title="Contains information of a single wxPropertyGrid page.">wxPropertyGridState</a><br/>
wxEvtHandler<br/>
wxObject<br/>
</p>
<h4>Include files</h4>
<p>&lt;wx/propgrid/manager.h&gt;</p>
<h4>Event handling</h4>
<p><a class="el" href="classwxPropertyGridPage.htm" title="Holder of property grid page information.">wxPropertyGridPage</a> receives events emitted by its <a class="el" href="classwxPropertyGridManager.htm" title="wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid, which...">wxPropertyGridManager</a>, but only those events that are specific to that page. If <a class="el" href="classwxPropertyGridPage.htm#a21a33aea3b2c498c0cf63a79c70952ef" title="Return false here to indicate unhandled events should be propagated to manager&#39;s...">wxPropertyGridPage::IsHandlingAllEvents</a> returns false, then unhandled events are sent to the manager's parent, as usual. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a97fdd418c9e8727e1800428e30c6164c"></a><!-- doxytag: member="wxPropertyGridPage::FitColumns" ref="a97fdd418c9e8727e1800428e30c6164c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxSize wxPropertyGridPage::FitColumns </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well). </p>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Minimum</em>&nbsp;</td><td>size for the page to still display everything.</td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>This function only works properly if size of containing grid was already fairly large.</dd></dl>
<p>Note that you can also get calculated column widths by calling GetColumnWidth() immediately after this function returns. </p>
</div>
</div>
<a class="anchor" id="ac2d74a899d99af4182a307af41be42b8"></a><!-- doxytag: member="wxPropertyGridPage::GetRoot" ref="ac2d74a899d99af4182a307af41be42b8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a>* wxPropertyGridPage::GetRoot </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns "root property". </p>
<p>It does not have name, etc. and it is not visible. It is only useful for accessing its children. </p>
</div>
</div>
<a class="anchor" id="aada6353fdf4ff5e1d2196001f2404283"></a><!-- doxytag: member="wxPropertyGridPage::Init" ref="aada6353fdf4ff5e1d2196001f2404283" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPropertyGridPage::Init </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Do any member initialization in this method. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
<li>Called every time the page is added into a manager.</li>
<li>You can add properties to the page here. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ab60f9672f417f1f124d7e777185a9263"></a><!-- doxytag: member="wxPropertyGridPage::OnShow" ref="ab60f9672f417f1f124d7e777185a9263" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPropertyGridPage::OnShow </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called every time page is about to be shown. </p>
<p>Useful, for instance, creating properties just-in-time. </p>
</div>
</div>
<a class="anchor" id="a487917dd83814af6d6023280b8589fec"></a><!-- doxytag: member="wxPropertyGridPage::SetSplitterPosition" ref="a487917dd83814af6d6023280b8589fec" args="(int splitterPos, int col=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxPropertyGridPage::SetSplitterPosition </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>splitterPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>col</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets splitter position on page. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used. </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a0fecf08e1b1bd2c25ea859839e345ba7"></a><!-- doxytag: member="wxPropertyGridPage::m_label" ref="a0fecf08e1b1bd2c25ea859839e345ba7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxString <a class="el" href="classwxPropertyGridPage.htm#a0fecf08e1b1bd2c25ea859839e345ba7">wxPropertyGridPage::m_label</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Page label (may be referred as name in some parts of documentation). </p>
<p>Can be set in constructor, or passed in <a class="el" href="classwxPropertyGridManager.htm#aed7ea6d2c2a8c4df915cc3d2525f2aa4" title="Creates new property page.">wxPropertyGridManager::AddPage()</a>, but *not* in both. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>manager.h</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sun Aug 22 12:42:15 2010 for wxPropertyGrid by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>