a3ed46f2c3
git-svn-id: svn://10.65.10.50/branches/R_10_00@23289 c028cbd2-c16b-5b4b-a496-9718f37d4682
364 lines
23 KiB
HTML
364 lines
23 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: wxBaseEnumProperty 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>wxBaseEnumProperty Class Reference</h1><!-- doxytag: class="wxBaseEnumProperty" --><!-- doxytag: inherits="wxPGProperty" -->
|
|
<p>Derive dynamic custom properties with choices from this class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <props.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for wxBaseEnumProperty:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classwxBaseEnumProperty.png" usemap="#wxBaseEnumProperty_map" alt=""/>
|
|
<map id="wxBaseEnumProperty_map" name="wxBaseEnumProperty_map">
|
|
<area href="classwxPGProperty.htm" alt="wxPGProperty" shape="rect" coords="164,0,318,24"/>
|
|
<area href="classwxEnumProperty.htm" alt="wxEnumProperty" shape="rect" coords="164,112,318,136"/>
|
|
<area href="classwxCursorProperty.htm" alt="wxCursorProperty" shape="rect" coords="0,168,154,192"/>
|
|
<area href="classwxEditEnumProperty.htm" alt="wxEditEnumProperty" shape="rect" coords="164,168,318,192"/>
|
|
<area href="classwxSystemColourProperty.htm" alt="wxSystemColourProperty" shape="rect" coords="328,168,482,192"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classwxBaseEnumProperty-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="aa3f91b3fdd20fb7aa2799cc0a57da8c4"></a><!-- doxytag: member="wxBaseEnumProperty::GetEntry" ref="aa3f91b3fdd20fb7aa2799cc0a57da8c4" args="(size_t index, int *pvalue) const =0" -->
|
|
virtual const wxString * </td><td class="memItemRight" valign="bottom"><b>GetEntry</b> (size_t index, int *pvalue) const =0</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcfb459d0a2133a0b3483fd2877b9fa9"></a><!-- doxytag: member="wxBaseEnumProperty::GetIndexForValue" ref="afcfb459d0a2133a0b3483fd2877b9fa9" args="(int value) const " -->
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>GetIndexForValue</b> (int value) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual wxString </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxBaseEnumProperty.htm#aa3f4987d0178b9acdcbd9794ff4f3d72">GetValueAsString</a> (int argFlags) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns text representation of property's value. <a href="#aa3f4987d0178b9acdcbd9794ff4f3d72"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2aad9b9a5612c263584212d0f2de230"></a><!-- doxytag: member="wxBaseEnumProperty::GetValueForIndex" ref="ab2aad9b9a5612c263584212d0f2de230" args="(size_t index) const " -->
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetValueForIndex</b> (size_t index) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxBaseEnumProperty.htm#a6bd6d1bd40730256e42b95d8724e9bc6">IntToValue</a> (wxVariant &variant, int number, int argFlags=0) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts 'number' (including choice selection) into proper value 'variant'. <a href="#a6bd6d1bd40730256e42b95d8724e9bc6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxBaseEnumProperty.htm#a04c13f797615778c3359e81c8155200c">OnSetValue</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This virtual function is called after m_value has been set. <a href="#a04c13f797615778c3359e81c8155200c"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxBaseEnumProperty.htm#a16b54370a862e434f7061d26cde8b305">OnValidationFailure</a> (wxVariant &pendingValue)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever validation has failed with given pending value. <a href="#a16b54370a862e434f7061d26cde8b305"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxBaseEnumProperty.htm#ae66f1522fd28f71a079b1d79bdfc4fd3">StringToValue</a> (wxVariant &variant, const wxString &text, int argFlags=0) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts 'text' into proper value 'variant'. <a href="#ae66f1522fd28f71a079b1d79bdfc4fd3"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxBaseEnumProperty.htm#a33f0cbad91d333c74064e5206cfbf8cc">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="#a33f0cbad91d333c74064e5206cfbf8cc"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb4ecb56b89adab0c40e6403ab3aae81"></a><!-- doxytag: member="wxBaseEnumProperty::wxBaseEnumProperty" ref="abb4ecb56b89adab0c40e6403ab3aae81" args="(const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL)" -->
|
|
</td><td class="memItemRight" valign="bottom"><b>wxBaseEnumProperty</b> (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL)</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="ac2d17fc2835e5b02de1598c72efde9ad"></a><!-- doxytag: member="wxBaseEnumProperty::GetIndex" ref="ac2d17fc2835e5b02de1598c72efde9ad" args="() const " -->
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetIndex</b> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3312f70b758f4c6d2db8bde424c3dc00"></a><!-- doxytag: member="wxBaseEnumProperty::SetIndex" ref="a3312f70b758f4c6d2db8bde424c3dc00" args="(int index)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetIndex</b> (int index)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac8e35e6a17fc2320a7668f67765dd82"></a><!-- doxytag: member="wxBaseEnumProperty::ValueFromInt_" ref="aac8e35e6a17fc2320a7668f67765dd82" args="(wxVariant &value, int intVal, int argFlags) const " -->
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ValueFromInt_</b> (wxVariant &value, int intVal, int argFlags) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d9b1e6b41941523a49be291576abc53"></a><!-- doxytag: member="wxBaseEnumProperty::ValueFromString_" ref="a2d9b1e6b41941523a49be291576abc53" args="(wxVariant &value, const wxString &text, int argFlags) const " -->
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ValueFromString_</b> (wxVariant &value, const wxString &text, int argFlags) const </td></tr>
|
|
<tr><td colspan="2"><h2>Static Protected Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04a8574d814ba033c710daeba6419020"></a><!-- doxytag: member="wxBaseEnumProperty::ResetNextIndex" ref="a04a8574d814ba033c710daeba6419020" args="()" -->
|
|
static void </td><td class="memItemRight" valign="bottom"><b>ResetNextIndex</b> ()</td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>Derive dynamic custom properties with choices from this class. </p>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
|
|
<li>Updating private index is important. You can do this either by calling SetIndex() in IntToValue, and then letting <a class="el" href="classwxBaseEnumProperty.htm#a04c13f797615778c3359e81c8155200c" title="This virtual function is called after m_value has been set.">wxBaseEnumProperty::OnSetValue</a> be called (by not implementing it, or by calling super class function in it) -OR- you can just call SetIndex in OnSetValue. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="aa3f4987d0178b9acdcbd9794ff4f3d72"></a><!-- doxytag: member="wxBaseEnumProperty::GetValueAsString" ref="aa3f4987d0178b9acdcbd9794ff4f3d72" args="(int argFlags) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual wxString wxBaseEnumProperty::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>Returns text representation of property's value. </p>
|
|
<p>Generally this function should not be called from the application code. Instead, call <a class="el" href="classwxPGProperty.htm#a9133d43d6e539e2814ed28d2f37d953e" title="Same as GetValueAsString, except takes common value into account.">GetValueString()</a>.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>argFlags</em> </td><td>If wxPG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If wxPG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display as a part of composite property string value.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
|
|
<li>Default implementation returns string composed from text representations of child properties.</li>
|
|
<li>Implementations are never called with m_value being null variant (ie. unspecified value), so you don't need to check for that. Naturally this means that unspecified value is always displayed as an empty string.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classwxPGProperty.htm#a9133d43d6e539e2814ed28d2f37d953e" title="Same as GetValueAsString, except takes common value into account.">GetValueString()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#a29f70a60e4844efbebc140270e1a4358">wxPGProperty</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classwxSystemColourProperty.htm#a92e1bbcbd610ee118cb7ca1e4c3bdd83">wxSystemColourProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6bd6d1bd40730256e42b95d8724e9bc6"></a><!-- doxytag: member="wxBaseEnumProperty::IntToValue" ref="a6bd6d1bd40730256e42b95d8724e9bc6" args="(wxVariant &variant, int number, int argFlags=0) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool wxBaseEnumProperty::IntToValue </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">int </td>
|
|
<td class="paramname"> <em>number</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>argFlags</em> = <code>0</code></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>Converts 'number' (including choice selection) into proper value 'variant'. </p>
|
|
<p>Returns true if new (different than m_value) value could be interpreted from the integer. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>argFlags</em> </td><td>If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
|
|
<li>Default implementation may work correctly if used value type is int.</li>
|
|
<li>If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.</li>
|
|
<li>If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.</li>
|
|
<li>You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behavior). </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#ad0a8e61a356e1366170967d56af66231">wxPGProperty</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classwxSystemColourProperty.htm#aacd92d2ddffdf36c05f6726b749f9e32">wxSystemColourProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a04c13f797615778c3359e81c8155200c"></a><!-- doxytag: member="wxBaseEnumProperty::OnSetValue" ref="a04c13f797615778c3359e81c8155200c" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void wxBaseEnumProperty::OnSetValue </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>This virtual function is called after m_value has been set. </p>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
|
|
<li>If m_value was set to Null variant (ie. unspecified value), <a class="el" href="classwxBaseEnumProperty.htm#a04c13f797615778c3359e81c8155200c" title="This virtual function is called after m_value has been set.">OnSetValue()</a> will not be called.</li>
|
|
<li>m_value may be of any variant type. Typically properties internally support only one variant type, and as such <a class="el" href="classwxBaseEnumProperty.htm#a04c13f797615778c3359e81c8155200c" title="This virtual function is called after m_value has been set.">OnSetValue()</a> provides a good opportunity to convert supported values into internal type.</li>
|
|
<li>Default implementation does nothing. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#ae5c4f47d3ff609d19346b994a9a25acb">wxPGProperty</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classwxSystemColourProperty.htm#ab5a97bd1acae0a58fa96f8282d89b4e9">wxSystemColourProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a16b54370a862e434f7061d26cde8b305"></a><!-- doxytag: member="wxBaseEnumProperty::OnValidationFailure" ref="a16b54370a862e434f7061d26cde8b305" args="(wxVariant &pendingValue)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void wxBaseEnumProperty::OnValidationFailure </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wxVariant & </td>
|
|
<td class="paramname"> <em>pendingValue</em></td>
|
|
<td> ) </td>
|
|
<td><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Called whenever validation has failed with given pending value. </p>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd>If you implement this in your custom property class, please remember to call the baser implementation as well as they may use it to revert property into pre-change state. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#acbffb1a7f8dee530918ff74c5cb70363">wxPGProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae66f1522fd28f71a079b1d79bdfc4fd3"></a><!-- doxytag: member="wxBaseEnumProperty::StringToValue" ref="ae66f1522fd28f71a079b1d79bdfc4fd3" args="(wxVariant &variant, const wxString &text, int argFlags=0) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool wxBaseEnumProperty::StringToValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">wxVariant & </td>
|
|
<td class="paramname"> <em>variant</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const wxString & </td>
|
|
<td class="paramname"> <em>text</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>argFlags</em> = <code>0</code></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>Converts 'text' into proper value 'variant'. </p>
|
|
<p>Returns true if new (different than m_value) value could be interpreted from the text. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>argFlags</em> </td><td>If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite property string value (as generated by <a class="el" href="classwxBaseEnumProperty.htm#aa3f4987d0178b9acdcbd9794ff4f3d72" title="Returns text representation of property's value.">GetValueAsString()</a> called with this same flag).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
|
|
<li>Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.</li>
|
|
<li>You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behavior). </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#a974a9b01c1f88cf4db630b6895453db8">wxPGProperty</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classwxSystemColourProperty.htm#ac32c042d219650b6f720ac30dba21d7d">wxSystemColourProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a33f0cbad91d333c74064e5206cfbf8cc"></a><!-- doxytag: member="wxBaseEnumProperty::ValidateValue" ref="a33f0cbad91d333c74064e5206cfbf8cc" args="(wxVariant &value, wxPGValidationInfo &validationInfo) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool wxBaseEnumProperty::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>
|