a3ed46f2c3
git-svn-id: svn://10.65.10.50/branches/R_10_00@23289 c028cbd2-c16b-5b4b-a496-9718f37d4682
183 lines
11 KiB
HTML
183 lines
11 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: wxFloatProperty 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>wxFloatProperty Class Reference</h1><!-- doxytag: class="wxFloatProperty" --><!-- doxytag: inherits="wxPGProperty" -->
|
|
<p>Basic property with double-precision floating point value.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <props.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for wxFloatProperty:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classwxFloatProperty.png" usemap="#wxFloatProperty_map" alt=""/>
|
|
<map id="wxFloatProperty_map" name="wxFloatProperty_map">
|
|
<area href="classwxPGProperty.htm" alt="wxPGProperty" shape="rect" coords="0,0,104,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classwxFloatProperty-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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxFloatProperty.htm#ac1efa28c80ba221e81d0b4fb665e9470">ValidateValue</a> (wxVariant &value, <a class="el" href="structwxPGValidationInfo.htm">wxPGValidationInfo</a> &validationInfo) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implement this function in derived class to check the value. <a href="#ac1efa28c80ba221e81d0b4fb665e9470"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab82150a1eb731dac3c2e1d5615f82d11"></a><!-- doxytag: member="wxFloatProperty::wxFloatProperty" ref="ab82150a1eb731dac3c2e1d5615f82d11" args="(const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, double value=0.0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><b>wxFloatProperty</b> (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, double value=0.0)</td></tr>
|
|
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af52a74b528b857f9bd7605436ac72afd"></a><!-- doxytag: member="wxFloatProperty::DoValidation" ref="af52a74b528b857f9bd7605436ac72afd" args="(const wxPGProperty *property, double &value, wxPGValidationInfo *pValidationInfo, int mode=wxPG_PROPERTY_VALIDATION_ERROR_MESSAGE)" -->
|
|
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxFloatProperty.htm#af52a74b528b857f9bd7605436ac72afd">DoValidation</a> (const <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, double &value, <a class="el" href="structwxPGValidationInfo.htm">wxPGValidationInfo</a> *pValidationInfo, int mode=wxPG_PROPERTY_VALIDATION_ERROR_MESSAGE)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Validation helper. <br/></td></tr>
|
|
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual wxValidator * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxFloatProperty.htm#ace08a385d33d18795d365cfb9ddaccb6">DoGetValidator</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns pointer to the wxValidator that should be used with the editor of this property (NULL for no validator). <a href="#ace08a385d33d18795d365cfb9ddaccb6"></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="a445dbab091b507337c667973249281fb"></a><!-- doxytag: member="wxFloatProperty::m_precision" ref="a445dbab091b507337c667973249281fb" args="" -->
|
|
int </td><td class="memItemRight" valign="bottom"><b>m_precision</b></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>Basic property with double-precision floating point value. </p>
|
|
<p><b>Supported special attributes:</b></p>
|
|
<ul>
|
|
<li>"Precision": Sets the (max) precision used when floating point value is rendered as text. The default -1 means infinite precision. </li>
|
|
</ul>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="ace08a385d33d18795d365cfb9ddaccb6"></a><!-- doxytag: member="wxFloatProperty::DoGetValidator" ref="ace08a385d33d18795d365cfb9ddaccb6" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual wxValidator* wxFloatProperty::DoGetValidator </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td> const<code> [protected, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns pointer to the wxValidator that should be used with the editor of this property (NULL for no validator). </p>
|
|
<p>Setting validator explicitly via SetPropertyValidator will override this.</p>
|
|
<p>In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):</p>
|
|
<div class="fragment"><pre class="fragment"> wxValidator* <a class="code" href="classwxFloatProperty.htm#ace08a385d33d18795d365cfb9ddaccb6" title="Returns pointer to the wxValidator that should be used with the editor of this property...">wxMyPropertyClass::DoGetValidator</a> ()<span class="keyword"> const</span>
|
|
<span class="keyword"> </span>{
|
|
WX_PG_DOGETVALIDATOR_ENTRY()
|
|
|
|
wxMyValidator* validator = new wxMyValidator(...);
|
|
|
|
... prepare validator...
|
|
|
|
WX_PG_DOGETVALIDATOR_EXIT(validator)
|
|
}
|
|
</pre></div><dl class="remark"><dt><b>Remarks:</b></dt><dd>You can get common filename validator by returning wxFileProperty::GetClassValidator(). <a class="el" href="classwxDirProperty.htm" title="Like wxLongStringProperty, but the button triggers dir selector instead.">wxDirProperty</a>, for example, uses it. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#af1b9f11eab24b1c1331f3f4a663ff98e">wxPGProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac1efa28c80ba221e81d0b4fb665e9470"></a><!-- doxytag: member="wxFloatProperty::ValidateValue" ref="ac1efa28c80ba221e81d0b4fb665e9470" args="(wxVariant &value, wxPGValidationInfo &validationInfo) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool wxFloatProperty::ValidateValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wxVariant & </td>
|
|
<td class="paramname"> <em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structwxPGValidationInfo.htm">wxPGValidationInfo</a> & </td>
|
|
<td class="paramname"> <em>validationInfo</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>Implement this function in derived class to check the value. </p>
|
|
<p>Return true if it is ok. Returning false prevents property change events from occurring.</p>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
|
|
<li>Default implementation always returns true. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#a2e0c041aa3e19a5934a02c65b53f9f7d">wxPGProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>props.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>
|