a3ed46f2c3
git-svn-id: svn://10.65.10.50/branches/R_10_00@23289 c028cbd2-c16b-5b4b-a496-9718f37d4682
262 lines
15 KiB
HTML
262 lines
15 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: wxPropertyCategory 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 Page</span></a></li>
|
|
<li><a href="pages.htm"><span>Related 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 List</span></a></li>
|
|
<li><a href="classes.htm"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.htm"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>wxPropertyCategory Class Reference</h1><!-- doxytag: class="wxPropertyCategory" --><!-- doxytag: inherits="wxPGProperty" -->
|
|
<p>Category (caption) property.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <propgrid.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for wxPropertyCategory:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classwxPropertyCategory.png" usemap="#wxPropertyCategory_map" alt=""/>
|
|
<map id="wxPropertyCategory_map" name="wxPropertyCategory_map">
|
|
<area href="classwxPGProperty.htm" alt="wxPGProperty" shape="rect" coords="0,0,128,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classwxPropertyCategory-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="aa350a9fbd2d0b7a4a0917da6cd94e7a5"></a><!-- doxytag: member="wxPropertyCategory::CalculateTextExtent" ref="aa350a9fbd2d0b7a4a0917da6cd94e7a5" args="(wxWindow *wnd, const wxFont &font)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><b>CalculateTextExtent</b> (wxWindow *wnd, const wxFont &font)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyCategory.htm#aa7b59821d008f0f7ccab0453e175726a">ChildChanged</a> (wxVariant &, int, wxVariant &) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called after value of a child property has been altered. <a href="#aa7b59821d008f0f7ccab0453e175726a"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f0cbe07797dc6f458f721093a47bf79"></a><!-- doxytag: member="wxPropertyCategory::DECLARE_DYNAMIC_CLASS" ref="a9f0cbe07797dc6f458f721093a47bf79" args="(wxPropertyCategory) virtual const wxPGEditor *DoGetEditorClass() const " -->
|
|
</td><td class="memItemRight" valign="bottom"><b>DECLARE_DYNAMIC_CLASS</b> (<a class="el" href="classwxPropertyCategory.htm">wxPropertyCategory</a>) virtual const <a class="el" href="classwxPGEditor.htm">wxPGEditor</a> *DoGetEditorClass() const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3edaaa0a1e90f79cbb68be77979d586"></a><!-- doxytag: member="wxPropertyCategory::GetTextColIndex" ref="ab3edaaa0a1e90f79cbb68be77979d586" args="() const " -->
|
|
unsigned int </td><td class="memItemRight" valign="bottom"><b>GetTextColIndex</b> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac67deaa94610a5b598afdd6965c47555"></a><!-- doxytag: member="wxPropertyCategory::GetTextExtent" ref="ac67deaa94610a5b598afdd6965c47555" args="(const wxWindow *wnd, const wxFont &font) const " -->
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetTextExtent</b> (const wxWindow *wnd, const wxFont &font) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual wxString </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyCategory.htm#a1fe8abbb2fcb24c88f787f3aefaa0800">GetValueAsString</a> (int argFlags) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Must be overridden with function that doesn't do anything. <a href="#a1fe8abbb2fcb24c88f787f3aefaa0800"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaddd34899b33c0ed3fcafb0c8e0c95e2"></a><!-- doxytag: member="wxPropertyCategory::SetTextColIndex" ref="aaddd34899b33c0ed3fcafb0c8e0c95e2" args="(unsigned int colInd)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetTextColIndex</b> (unsigned int colInd)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyCategory.htm#a30463c479b95e5b004f10f93d5da5d4f">wxPropertyCategory</a> (const wxString &label, const wxString &name=(*((wxString *) NULL)))</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct. <a href="#a30463c479b95e5b004f10f93d5da5d4f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPropertyCategory.htm#ae999774041f1f0bf788aad149439a688">wxPropertyCategory</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Special constructor only used in special cases. <a href="#ae999774041f1f0bf788aad149439a688"></a><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="a8c68463ab4c57de72bc737df81391d4e"></a><!-- doxytag: member="wxPropertyCategory::m_capFgColIndex" ref="a8c68463ab4c57de72bc737df81391d4e" args="" -->
|
|
wxByte </td><td class="memItemRight" valign="bottom"><b>m_capFgColIndex</b></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53b62bd10f95e903d5e2778b84a89e4e"></a><!-- doxytag: member="wxPropertyCategory::m_textExtent" ref="a53b62bd10f95e903d5e2778b84a89e4e" args="" -->
|
|
int </td><td class="memItemRight" valign="bottom"><b>m_textExtent</b></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>Category (caption) property. </p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ae999774041f1f0bf788aad149439a688"></a><!-- doxytag: member="wxPropertyCategory::wxPropertyCategory" ref="ae999774041f1f0bf788aad149439a688" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">wxPropertyCategory::wxPropertyCategory </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Special constructor only used in special cases. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a30463c479b95e5b004f10f93d5da5d4f"></a><!-- doxytag: member="wxPropertyCategory::wxPropertyCategory" ref="a30463c479b95e5b004f10f93d5da5d4f" args="(const wxString &label, const wxString &name=(*((wxString *) NULL)))" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">wxPropertyCategory::wxPropertyCategory </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const wxString & </td>
|
|
<td class="paramname"> <em>label</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const wxString & </td>
|
|
<td class="paramname"> <em>name</em> = <code>(*((wxString *) NULL))</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Construct. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>label</em> </td><td>Label for the category. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd>All non-category properties appended will have most recently added category. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="aa7b59821d008f0f7ccab0453e175726a"></a><!-- doxytag: member="wxPropertyCategory::ChildChanged" ref="aa7b59821d008f0f7ccab0453e175726a" args="(wxVariant &, int, wxVariant &) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void wxPropertyCategory::ChildChanged </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wxVariant & </td>
|
|
<td class="paramname"> <em>thisValue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>childIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wxVariant & </td>
|
|
<td class="paramname"> <em>childValue</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td> const<code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Called after value of a child property has been altered. </p>
|
|
<p>Note that this function is usually called at the time that value of this property, or given child property, is still pending for change.</p>
|
|
<p>Sample pseudo-code implementation:</p>
|
|
<div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> <a class="code" href="classwxPropertyCategory.htm#aa7b59821d008f0f7ccab0453e175726a" title="Called after value of a child property has been altered.">MyProperty::ChildChanged</a>( wxVariant& thisValue, <span class="keywordtype">int</span> childIndex, wxVariant& childValue )<span class="keyword"> const</span>
|
|
<span class="keyword"> </span>{
|
|
<span class="comment">// Acquire reference to actual type of data stored in variant</span>
|
|
<span class="comment">// (TFromVariant only exists if wxPropertyGrid's wxVariant-macros were used to create</span>
|
|
<span class="comment">// the variant class).</span>
|
|
T& data = TFromVariant(thisValue);
|
|
|
|
<span class="comment">// Copy childValue into data.</span>
|
|
<span class="keywordflow">switch</span> ( childIndex )
|
|
{
|
|
<span class="keywordflow">case</span> 0:
|
|
data.SetSubProp1( childvalue.GetLong() );
|
|
<span class="keywordflow">break</span>;
|
|
<span class="keywordflow">case</span> 1:
|
|
data.SetSubProp2( childvalue.GetString() );
|
|
<span class="keywordflow">break</span>;
|
|
...
|
|
}
|
|
}
|
|
</pre></div><dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>thisValue</em> </td><td>Value of this property, that should be altered. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>childIndex</em> </td><td>Index of child changed (you can use Item(childIndex) to get). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>childValue</em> </td><td>Value of the child property. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#ace7a9dc69fdf8185cff04c1604cb4fbd">wxPGProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1fe8abbb2fcb24c88f787f3aefaa0800"></a><!-- doxytag: member="wxPropertyCategory::GetValueAsString" ref="a1fe8abbb2fcb24c88f787f3aefaa0800" args="(int argFlags) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual wxString wxPropertyCategory::GetValueAsString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>argFlags</em></td>
|
|
<td> ) </td>
|
|
<td> const<code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Must be overridden with function that doesn't do anything. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#a29f70a60e4844efbebc140270e1a4358">wxPGProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>propgrid.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </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:14 2010 for wxPropertyGrid by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
|
|
</body>
|
|
</html>
|