a3ed46f2c3
git-svn-id: svn://10.65.10.50/branches/R_10_00@23289 c028cbd2-c16b-5b4b-a496-9718f37d4682
191 lines
17 KiB
HTML
191 lines
17 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: wxPropertyGrid Miscellanous</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><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>
|
|
<div class="contents">
|
|
<h1>wxPropertyGrid Miscellanous</h1>
|
|
<p>This section describes some miscellanous values, types and macros.
|
|
<a href="#_details">More...</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscellaneous.htm#ga74d8d2f3302b624b76d343d2abb1ff53">WX_PG_CLASSINFO</a>(NAME) (&NAME::ms_classInfo)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use this with <a class="el" href="classwxPropertyGridInterface.htm#a34c9622a8a65bdcf494a9fabff8e7e6e" title="Returns true if property is of certain type.">wxPropertyGrid::IsPropertyKindOf</a>. <a href="#ga74d8d2f3302b624b76d343d2abb1ff53"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga59fd572254a501df13236ad5363b4253"></a><!-- doxytag: member="miscellaneous::wxPG_COLOUR" ref="ga59fd572254a501df13236ad5363b4253" args="(R, G, B)" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscellaneous.htm#ga59fd572254a501df13236ad5363b4253">wxPG_COLOUR</a>(R, G, B) ((wxUint32)(R+(G<<8)+(B<<16)))</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert Red, Green and Blue to a single 32-bit value. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7ba4ad4a4912e3d0c814ab0a08fc6f01"></a><!-- doxytag: member="miscellaneous::wxPG_COLOUR_BLACK" ref="ga7ba4ad4a4912e3d0c814ab0a08fc6f01" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><b>wxPG_COLOUR_BLACK</b> (*wxBLACK)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6da9de26639368cfba7ef3306a64fd45"></a><!-- doxytag: member="miscellaneous::wxPG_DEFAULT_IMAGE_SIZE" ref="ga6da9de26639368cfba7ef3306a64fd45" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscellaneous.htm#ga6da9de26639368cfba7ef3306a64fd45">wxPG_DEFAULT_IMAGE_SIZE</a> wxSize(-1, -1)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">If property is supposed to have custom-painted image, then returning this in OnMeasureImage() will usually be enough. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf79753c2eecb1edfebcfe9d63c4de63a"></a><!-- doxytag: member="miscellaneous::wxPG_EMPTY_ARRAYINT" ref="gaf79753c2eecb1edfebcfe9d63c4de63a" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><b>wxPG_EMPTY_ARRAYINT</b> wxArrayInt()</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga245f15e776616b75f953d1498160760a"></a><!-- doxytag: member="miscellaneous::wxPG_EMPTY_ARRAYSTRING" ref="ga245f15e776616b75f953d1498160760a" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><b>wxPG_EMPTY_ARRAYSTRING</b> wxArrayString()</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga35567004c2b7c2fbf73ba2a8d3dfa6ab"></a><!-- doxytag: member="miscellaneous::wxPG_INVALID_VALUE" ref="ga35567004c2b7c2fbf73ba2a8d3dfa6ab" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><b>wxPG_INVALID_VALUE</b> INT_MAX</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga02064e949a659998a5b05d94a5203158"></a><!-- doxytag: member="miscellaneous::wxPG_LABEL" ref="ga02064e949a659998a5b05d94a5203158" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><b>wxPG_LABEL</b> (*((wxString*)NULL))</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga05384e90f45b0f639241e0fee623ba85"></a><!-- doxytag: member="miscellaneous::wxPG_NULL_BITMAP" ref="ga05384e90f45b0f639241e0fee623ba85" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><b>wxPG_NULL_BITMAP</b> wxNullBitmap</td></tr>
|
|
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafe257745b4d138d5d3414baeb2260be1"></a><!-- doxytag: member="miscellaneous::wxPGCachedString" ref="gafe257745b4d138d5d3414baeb2260be1" args="" -->
|
|
typedef wxString </td><td class="memItemRight" valign="bottom"><b>wxPGCachedString</b></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscellaneous.htm#ga21937a843330941d01d8ed7d9f8902de">wxPGPaintCallback</a> )(<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxDC &dc, const wxRect &rect, <a class="el" href="structwxPGPaintData.htm">wxPGPaintData</a> &paintdata)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This callback function is used by atleast <a class="el" href="classwxCustomProperty.htm" title="This is a somewhat inefficient but versatile property class.">wxCustomProperty</a> to facilitiate drawing items in drop down list. <a href="#ga21937a843330941d01d8ed7d9f8902de"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscellaneous.htm#gadd392b8d6550141475e3efb953b0a20f">wxPGSortCallback</a> )(<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *propGrid, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *p1, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *p2)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This callback function is used for sorting properties. <a href="#gadd392b8d6550141475e3efb953b0a20f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscellaneous.htm#ga0e03fc054d4245043dccd522d6ce3929">wxPropertyGridCallback</a> )(<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *propGrid, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl, int data)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This callback function is used by atleast <a class="el" href="classwxCustomProperty.htm" title="This is a somewhat inefficient but versatile property class.">wxCustomProperty</a> to facilitiate easy custom action on button press. <a href="#ga0e03fc054d4245043dccd522d6ce3929"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>This section describes some miscellanous values, types and macros. </p>
|
|
<hr/><h2>Define Documentation</h2>
|
|
<a class="anchor" id="ga74d8d2f3302b624b76d343d2abb1ff53"></a><!-- doxytag: member="propgrid.h::WX_PG_CLASSINFO" ref="ga74d8d2f3302b624b76d343d2abb1ff53" args="(NAME)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define WX_PG_CLASSINFO</td>
|
|
<td>(</td>
|
|
<td class="paramtype">NAME </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td> (&NAME::ms_classInfo)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Use this with <a class="el" href="classwxPropertyGridInterface.htm#a34c9622a8a65bdcf494a9fabff8e7e6e" title="Returns true if property is of certain type.">wxPropertyGrid::IsPropertyKindOf</a>. </p>
|
|
<p>For example, as in </p>
|
|
<div class="fragment"><pre class="fragment"> pg-><a class="code" href="classwxPropertyGridInterface.htm#a34c9622a8a65bdcf494a9fabff8e7e6e" title="Returns true if property is of certain type.">IsPropertyKindOf</a>(<a class="code" href="group__miscellaneous.htm#ga74d8d2f3302b624b76d343d2abb1ff53" title="Use this with wxPropertyGrid::IsPropertyKindOf.">WX_PG_CLASSINFO</a>(<a class="code" href="classwxStringProperty.htm" title="Basic property with string value.">wxStringProperty</a>))
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Typedef Documentation</h2>
|
|
<a class="anchor" id="ga21937a843330941d01d8ed7d9f8902de"></a><!-- doxytag: member="propgrid.h::wxPGPaintCallback" ref="ga21937a843330941d01d8ed7d9f8902de" args=")(wxPGProperty *property, wxDC &dc, const wxRect &rect, wxPGPaintData &paintdata)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* <a class="el" href="group__miscellaneous.htm#ga21937a843330941d01d8ed7d9f8902de">wxPGPaintCallback</a>)(<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxDC &dc, const wxRect &rect, <a class="el" href="structwxPGPaintData.htm">wxPGPaintData</a> &paintdata)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>This callback function is used by atleast <a class="el" href="classwxCustomProperty.htm" title="This is a somewhat inefficient but versatile property class.">wxCustomProperty</a> to facilitiate drawing items in drop down list. </p>
|
|
<p>Works very much like the old <a class="el" href="classwxPGProperty.htm#ad0b00df4a3916cb80adfa1227c70baf4" title="Override to paint an image in front of the property value text or drop-down list...">wxPGProperty::OnCustomPaint</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gadd392b8d6550141475e3efb953b0a20f"></a><!-- doxytag: member="propgrid.h::wxPGSortCallback" ref="gadd392b8d6550141475e3efb953b0a20f" args=")(wxPropertyGrid *propGrid, wxPGProperty *p1, wxPGProperty *p2)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef int(* <a class="el" href="group__miscellaneous.htm#gadd392b8d6550141475e3efb953b0a20f">wxPGSortCallback</a>)(<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *propGrid, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *p1, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *p2)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>This callback function is used for sorting properties. </p>
|
|
<p>Call <a class="el" href="classwxPropertyGrid.htm#ad413c2a9f94db90466bc9039f928afe6" title="Sets the property sorting function.">wxPropertyGrid::SetSortFunction()</a> to set it.</p>
|
|
<p>This function should return a value greater than 0 if position of p1 is after p2. So, for instance, when comparing property names, you can use following implementation:</p>
|
|
<div class="fragment"><pre class="fragment"> <span class="keywordtype">int</span> MyPropertySortFunction(<a class="code" href="classwxPropertyGrid.htm" title="wxPropertyGrid is a specialized two-column grid for editing properties such as strings...">wxPropertyGrid</a>* propGrid,
|
|
<a class="code" href="classwxPGProperty.htm" title="wxPGProperty is base class for all wxPropertyGrid properties.">wxPGProperty</a>* p1,
|
|
<a class="code" href="classwxPGProperty.htm" title="wxPGProperty is base class for all wxPropertyGrid properties.">wxPGProperty</a>* p2)
|
|
{
|
|
<span class="keywordflow">return</span> p1-><a class="code" href="classwxPGProperty.htm#adc211e2a17cfaab3a1c7d4b6fd8788b6" title="Returns property&#39;s base name (ie.">GetBaseName</a>().compare( p2-><a class="code" href="classwxPGProperty.htm#adc211e2a17cfaab3a1c7d4b6fd8788b6" title="Returns property&#39;s base name (ie.">GetBaseName</a>() );
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0e03fc054d4245043dccd522d6ce3929"></a><!-- doxytag: member="propgrid.h::wxPropertyGridCallback" ref="ga0e03fc054d4245043dccd522d6ce3929" args=")(wxPropertyGrid *propGrid, wxPGProperty *property, wxWindow *ctrl, int data)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef bool(* <a class="el" href="group__miscellaneous.htm#ga0e03fc054d4245043dccd522d6ce3929">wxPropertyGridCallback</a>)(<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *propGrid, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl, int data)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>This callback function is used by atleast <a class="el" href="classwxCustomProperty.htm" title="This is a somewhat inefficient but versatile property class.">wxCustomProperty</a> to facilitiate easy custom action on button press. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>propGrid</em> </td><td>related <a class="el" href="classwxPropertyGrid.htm" title="wxPropertyGrid is a specialized two-column grid for editing properties such as strings...">wxPropertyGrid</a> </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>property</em> </td><td>related <a class="el" href="classwxPGProperty.htm" title="wxPGProperty is base class for all wxPropertyGrid properties.">wxPGProperty</a> </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ctrl</em> </td><td>If not NULL (for example, not selected), a wxWindow* or equivalent </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Value depends on the context. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>True</em> </td><td>if changed value of the property. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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:13 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>
|