a3ed46f2c3
git-svn-id: svn://10.65.10.50/branches/R_10_00@23289 c028cbd2-c16b-5b4b-a496-9718f37d4682
149 lines
11 KiB
HTML
149 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: wxEnumProperty 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>wxEnumProperty Class Reference</h1><!-- doxytag: class="wxEnumProperty" --><!-- doxytag: inherits="wxBaseEnumProperty" -->
|
|
<p>You can derive 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 wxEnumProperty:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classwxEnumProperty.png" usemap="#wxEnumProperty_map" alt=""/>
|
|
<map id="wxEnumProperty_map" name="wxEnumProperty_map">
|
|
<area href="classwxBaseEnumProperty.htm" alt="wxBaseEnumProperty" shape="rect" coords="164,56,318,80"/>
|
|
<area href="classwxPGProperty.htm" alt="wxPGProperty" shape="rect" coords="164,0,318,24"/>
|
|
<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="classwxEnumProperty-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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxEnumProperty.htm#af54a110e6df0419802d378f36f23e38d">GetChoiceInfo</a> (<a class="el" href="structwxPGChoiceInfo.htm">wxPGChoiceInfo</a> *choiceinfo)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns current value's index to the choice control. <a href="#af54a110e6df0419802d378f36f23e38d"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c0a6b732faa4850f748bff95091b458"></a><!-- doxytag: member="wxEnumProperty::GetChoices" ref="a3c0a6b732faa4850f748bff95091b458" args="() const " -->
|
|
const <a class="el" href="classwxPGChoices.htm">wxPGChoices</a> & </td><td class="memItemRight" valign="bottom"><b>GetChoices</b> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48148d3ef835596254d9a51c1018860a"></a><!-- doxytag: member="wxEnumProperty::GetEntry" ref="a48148d3ef835596254d9a51c1018860a" args="(size_t index, int *pvalue) const " -->
|
|
virtual const wxString * </td><td class="memItemRight" valign="bottom"><b>GetEntry</b> (size_t index, int *pvalue) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1eecc0fdbfbbbddb6c0fd875d5612718"></a><!-- doxytag: member="wxEnumProperty::GetIndexForValue" ref="a1eecc0fdbfbbbddb6c0fd875d5612718" 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"><a class="anchor" id="a0a7ab8eb5efd7163218df1da276e5c88"></a><!-- doxytag: member="wxEnumProperty::GetItemCount" ref="a0a7ab8eb5efd7163218df1da276e5c88" args="() const " -->
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>GetItemCount</b> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab4a79ec124220c76957fd74b9aebdf4"></a><!-- doxytag: member="wxEnumProperty::wxEnumProperty" ref="aab4a79ec124220c76957fd74b9aebdf4" args="(const wxString &label, const wxString &name, const wxArrayString &labels, const wxArrayInt &values=wxArrayInt(), int value=0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><b>wxEnumProperty</b> (const wxString &label, const wxString &name, const wxArrayString &labels, const wxArrayInt &values=wxArrayInt(), int value=0)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a98c23883134041adcd8d166939fb48"></a><!-- doxytag: member="wxEnumProperty::wxEnumProperty" ref="a9a98c23883134041adcd8d166939fb48" args="(const wxString &label, const wxString &name, const wxChar **labels, const long *values, wxPGChoices *choicesCache, int value=0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><b>wxEnumProperty</b> (const wxString &label, const wxString &name, const wxChar **labels, const long *values, <a class="el" href="classwxPGChoices.htm">wxPGChoices</a> *choicesCache, int value=0)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6faa345ddcaf8cadc47004cdde5f232f"></a><!-- doxytag: member="wxEnumProperty::wxEnumProperty" ref="a6faa345ddcaf8cadc47004cdde5f232f" args="(const wxString &label, const wxString &name, wxPGChoices &choices, int value=0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><b>wxEnumProperty</b> (const wxString &label, const wxString &name, <a class="el" href="classwxPGChoices.htm">wxPGChoices</a> &choices, int value=0)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2e29c51d5205f7fbb2e5c66539c14f4"></a><!-- doxytag: member="wxEnumProperty::wxEnumProperty" ref="ae2e29c51d5205f7fbb2e5c66539c14f4" args="(const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, const wxChar **labels=NULL, const long *values=NULL, int value=0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><b>wxEnumProperty</b> (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, const wxChar **labels=NULL, const long *values=NULL, int value=0)</td></tr>
|
|
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a902050632f3fd101b33b0c6dd9c7031a"></a><!-- doxytag: member="wxEnumProperty::m_choices" ref="a902050632f3fd101b33b0c6dd9c7031a" args="" -->
|
|
<a class="el" href="classwxPGChoices.htm">wxPGChoices</a> </td><td class="memItemRight" valign="bottom"><b>m_choices</b></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>You can derive custom properties with choices from this class. </p>
|
|
<p>See <a class="el" href="classwxBaseEnumProperty.htm" title="Derive dynamic custom properties with choices from this class.">wxBaseEnumProperty</a> for remarks. </p>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="af54a110e6df0419802d378f36f23e38d"></a><!-- doxytag: member="wxEnumProperty::GetChoiceInfo" ref="af54a110e6df0419802d378f36f23e38d" args="(wxPGChoiceInfo *choiceinfo)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int wxEnumProperty::GetChoiceInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structwxPGChoiceInfo.htm">wxPGChoiceInfo</a> * </td>
|
|
<td class="paramname"> <em>choiceinfo</em></td>
|
|
<td> ) </td>
|
|
<td><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns current value's index to the choice control. </p>
|
|
<p>May also return, through pointer arguments, strings that should be inserted to that control. Irrelevant to classes which do not employ wxPG_EDITOR(Choice) or similar. </p>
|
|
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
|
|
<li>If returns NULL in choices, then this class must be derived from <a class="el" href="classwxBaseEnumProperty.htm" title="Derive dynamic custom properties with choices from this class.">wxBaseEnumProperty</a>.</li>
|
|
<li>Must not crash even if property's set of choices is uninitialized (i.e. it points to wxPGGlobalVars->m_emptyConstants). </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#a805b98f7d147782079bb9a48915a949f">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>
|