root/campo-sirio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
campo-sirio/libraries/wxPG/propgrid/docs/html/classwxPGEditor.htm
mtollari 4db94043cb Patch level : 12.0 no-patch 
Files correlati     : 
Commento            : Spostamento in libraries delle librerie esterne di Campo per una maggiore pulizia e organizzazione

git-svn-id: svn://10.65.10.50/branches/R_10_00@24150 c028cbd2-c16b-5b4b-a496-9718f37d4682
2017-10-26 09:11:15 +00:00

645 lines
34 KiB
HTML
Raw Blame History

<!-- 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: wxPGEditor 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&nbsp;Page</span></a></li>
<li><a href="pages.htm"><span>Related&nbsp;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&nbsp;List</span></a></li>
<li><a href="classes.htm"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.htm"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>wxPGEditor Class Reference</h1><!-- doxytag: class="wxPGEditor" -->
<p>Base for property editor classes.
<a href="#_details">More...</a></p>
<p><code>#include &lt;editors.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for wxPGEditor:</div>
<div class="dynsection">
<div class="center">
<img src="classwxPGEditor.png" usemap="#wxPGEditor_map" alt=""/>
<map id="wxPGEditor_map" name="wxPGEditor_map">
<area href="classwxPGCheckBoxEditor.htm" alt="wxPGCheckBoxEditor" shape="rect" coords="0,56,178,80"/>
<area href="classwxPGChoiceEditor.htm" alt="wxPGChoiceEditor" shape="rect" coords="188,56,366,80"/>
<area href="classwxPGTextCtrlEditor.htm" alt="wxPGTextCtrlEditor" shape="rect" coords="470,56,648,80"/>
<area href="classwxPGChoiceAndButtonEditor.htm" alt="wxPGChoiceAndButtonEditor" shape="rect" coords="94,112,272,136"/>
<area href="classwxPGComboBoxEditor.htm" alt="wxPGComboBoxEditor" shape="rect" coords="282,112,460,136"/>
<area href="classwxPGTextCtrlAndButtonEditor.htm" alt="wxPGTextCtrlAndButtonEditor" shape="rect" coords="470,112,648,136"/>
</map>
</div>
</div>
<p><a href="classwxPGEditor-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="a7b937295fbbefaa6dd6495067afd5920"></a><!-- doxytag: member="wxPGEditor::ActualGetValueFromControl" ref="a7b937295fbbefaa6dd6495067afd5920" args="(wxVariant &amp;variant, wxPGProperty *property, wxWindow *ctrl) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>ActualGetValueFromControl</b> (wxVariant &amp;variant, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#abd6bbee08a30f42d55b386cd5d400946">CanContainCustomImage</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if control itself can contain the custom image. <a href="#abd6bbee08a30f42d55b386cd5d400946"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwxPGWindowList.htm">wxPGWindowList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a9d33fbd55fe4fe390bdaa826a7ff87e2">CreateControls</a> (<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *propgrid, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, const wxPoint &amp;pos, const wxSize &amp;size) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Instantiates editor controls. <a href="#a9d33fbd55fe4fe390bdaa826a7ff87e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#afc7056e3e42a7deba94e13b519fdbc7c">DeleteItem</a> (wxWindow *ctrl, int index) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes item from existing control. <a href="#afc7056e3e42a7deba94e13b519fdbc7c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#ac44a1db95b88f0f33f723eff7bc3d983">DrawValue</a> (wxDC &amp;dc, const wxRect &amp;rect, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, const wxString &amp;text) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to get the renderer to draw the value with when the control is hidden. <a href="#ac44a1db95b88f0f33f723eff7bc3d983"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual wxPG_CONST_WXCHAR_PTR&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#afa649c297f922540215fcaf097c2d7fb">GetName</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns pointer to the name of the editor. <a href="#afa649c297f922540215fcaf097c2d7fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#ad92b01e177e2448d63755c7b3cf58a13">GetValueFromControl</a> (wxVariant &amp;variant, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl) const WX_PG_NOT_PURE_IN_WXPYTHON</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns value from control, via parameter 'variant'. <a href="#ad92b01e177e2448d63755c7b3cf58a13"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a97de228636ce4e4b3f8d00593c65fe26">InsertItem</a> (wxWindow *ctrl, const wxString &amp;label, int index) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inserts item to existing control. <a href="#a97de228636ce4e4b3f8d00593c65fe26"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a035fa3bee4ac87e4300df0c637a56261">OnEvent</a> (<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *propgrid, <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *wnd_primary, wxEvent &amp;event) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handles events. <a href="#a035fa3bee4ac87e4300df0c637a56261"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a479f4ec8deeb41a41c5427f4e506c499">OnFocus</a> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *wnd) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extra processing when control gains focus. <a href="#a479f4ec8deeb41a41c5427f4e506c499"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#ad9667eb541f25f1d667de8cb937d24af">SetControlIntValue</a> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl, int value) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets control's value specifically from int (applies to choice etc. <a href="#ad9667eb541f25f1d667de8cb937d24af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a5fefad75f7890ac414f365d0b949a7a6">SetControlStringValue</a> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl, const wxString &amp;txt) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets control's value specifically from string. <a href="#a5fefad75f7890ac414f365d0b949a7a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a8b4f403f1311f9b3a57807147f0e8473">SetValueToUnspecified</a> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets value in control to unspecified. <a href="#a8b4f403f1311f9b3a57807147f0e8473"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a229b635a46763efa40814584eb480c51">UpdateControl</a> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *property, wxWindow *ctrl) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads value from property to the control. <a href="#a229b635a46763efa40814584eb480c51"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a31af1e59136a4246e19a4f2792762a1f">wxPGEditor</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#a31af1e59136a4246e19a4f2792762a1f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwxPGEditor.htm#a29dc3fd2736e4e4929753e10df3fa01c">~wxPGEditor</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#a29dc3fd2736e4e4929753e10df3fa01c"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Base for property editor classes. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
<li>Event handling: <a class="el" href="classwxPGEditor.htm#a9d33fbd55fe4fe390bdaa826a7ff87e2" title="Instantiates editor controls.">wxPGEditor::CreateControls</a> should Connect all necessary events to the <a class="el" href="classwxPropertyGrid.htm#a4f5d8650023b5693b2b1c848930f2abc" title="Pass this function to Connect calls in propertyclass::CreateEditor.">wxPropertyGrid::OnCustomEditorEvent</a>. For Example: <div class="fragment"><pre class="fragment"> <span class="comment">// Relays wxEVT_COMMAND_TEXT_UPDATED events of primary editor</span>
<span class="comment">// control to the OnEvent.</span>
<span class="comment">// NOTE: This event in particular is actually automatically conveyed, but</span>
<span class="comment">// it is just used as an example.</span>
propgrid-&gt;Connect( wxPG_SUBID1, wxEVT_COMMAND_TEXT_UPDATED,
(wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction)
&amp;<a class="code" href="classwxPropertyGrid.htm#a4f5d8650023b5693b2b1c848930f2abc" title="Pass this function to Connect calls in propertyclass::CreateEditor.">wxPropertyGrid::OnCustomEditorEvent</a> );
</pre></div> OnCustomEditorEvent will then forward events, first to <a class="el" href="classwxPGEditor.htm#a035fa3bee4ac87e4300df0c637a56261" title="Handles events.">wxPGEditor::OnEvent</a> and then to <a class="el" href="classwxPGProperty.htm#a16fbe26240bf47ab0a9a02d21781da73" title="Events received by editor widgets are processed here.">wxPGProperty::OnEvent</a>.</li>
<li>You need to call macro wxPGRegisterEditorClass(EditorName) before using a custom editor class.</li>
<li>See propgrid.cpp for how builtin editors works (starting from <a class="el" href="classwxPGTextCtrlEditor.htm">wxPGTextCtrlEditor</a>). </li>
</ul>
</dd></dl>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a31af1e59136a4246e19a4f2792762a1f"></a><!-- doxytag: member="wxPGEditor::wxPGEditor" ref="a31af1e59136a4246e19a4f2792762a1f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxPGEditor::wxPGEditor </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a29dc3fd2736e4e4929753e10df3fa01c"></a><!-- doxytag: member="wxPGEditor::~wxPGEditor" ref="a29dc3fd2736e4e4929753e10df3fa01c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual wxPGEditor::~wxPGEditor </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abd6bbee08a30f42d55b386cd5d400946"></a><!-- doxytag: member="wxPGEditor::CanContainCustomImage" ref="abd6bbee08a30f42d55b386cd5d400946" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool wxPGEditor::CanContainCustomImage </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if control itself can contain the custom image. </p>
<p>Default is to return false. </p>
<p>Reimplemented in <a class="el" href="classwxPGChoiceEditor.htm#a3923cb234de120441cc27ff4d410aa95">wxPGChoiceEditor</a>.</p>
</div>
</div>
<a class="anchor" id="a9d33fbd55fe4fe390bdaa826a7ff87e2"></a><!-- doxytag: member="wxPGEditor::CreateControls" ref="a9d33fbd55fe4fe390bdaa826a7ff87e2" args="(wxPropertyGrid *propgrid, wxPGProperty *property, const wxPoint &amp;pos, const wxSize &amp;size) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classwxPGWindowList.htm">wxPGWindowList</a> wxPGEditor::CreateControls </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *&nbsp;</td>
<td class="paramname"> <em>propgrid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxPoint &amp;&nbsp;</td>
<td class="paramname"> <em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxSize &amp;&nbsp;</td>
<td class="paramname"> <em>size</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiates editor controls. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd><ul>
<li>Primary control shall use id wxPG_SUBID1, and secondary (button) control shall use wxPG_SUBID2. </li>
</ul>
</dd></dl>
<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>&nbsp;</td><td><a class="el" href="classwxPropertyGrid.htm" title="wxPropertyGrid is a specialized two-column grid for editing properties such as strings...">wxPropertyGrid</a> to which the property belongs (use as parent for control). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>property</em>&nbsp;</td><td>Property for which this method is called. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em>&nbsp;</td><td>Position, inside <a class="el" href="classwxPropertyGrid.htm" title="wxPropertyGrid is a specialized two-column grid for editing properties such as strings...">wxPropertyGrid</a>, to create control(s) to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>Initial size for control(s). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afc7056e3e42a7deba94e13b519fdbc7c"></a><!-- doxytag: member="wxPGEditor::DeleteItem" ref="afc7056e3e42a7deba94e13b519fdbc7c" args="(wxWindow *ctrl, int index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPGEditor::DeleteItem </td>
<td>(</td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>ctrl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>index</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deletes item from existing control. </p>
<p>Default implementation does nothing. </p>
<p>Reimplemented in <a class="el" href="classwxPGChoiceEditor.htm#a5a2888446bed7d2029779bddd08c7bc1">wxPGChoiceEditor</a>.</p>
</div>
</div>
<a class="anchor" id="ac44a1db95b88f0f33f723eff7bc3d983"></a><!-- doxytag: member="wxPGEditor::DrawValue" ref="ac44a1db95b88f0f33f723eff7bc3d983" args="(wxDC &amp;dc, const wxRect &amp;rect, wxPGProperty *property, const wxString &amp;text) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPGEditor::DrawValue </td>
<td>(</td>
<td class="paramtype">wxDC &amp;&nbsp;</td>
<td class="paramname"> <em>dc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxRect &amp;&nbsp;</td>
<td class="paramname"> <em>rect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxString &amp;&nbsp;</td>
<td class="paramname"> <em>text</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to get the renderer to draw the value with when the control is hidden. </p>
<p>Default implementation returns g_wxPGDefaultRenderer. Draws value for given property. </p>
<p>Reimplemented in <a class="el" href="classwxPGCheckBoxEditor.htm#a9050cabb3d00003e40baa69ecaf57f60">wxPGCheckBoxEditor</a>.</p>
</div>
</div>
<a class="anchor" id="afa649c297f922540215fcaf097c2d7fb"></a><!-- doxytag: member="wxPGEditor::GetName" ref="afa649c297f922540215fcaf097c2d7fb" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual wxPG_CONST_WXCHAR_PTR wxPGEditor::GetName </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns pointer to the name of the editor. </p>
<p>For example, wxPG_EDITOR(TextCtrl) has name "TextCtrl". This method is autogenerated for custom editors. </p>
<p>Implemented in <a class="el" href="classwxPGTextCtrlEditor.htm#a5e8deb2f97b9329b4d686e6af88ae345">wxPGTextCtrlEditor</a>, <a class="el" href="classwxPGChoiceEditor.htm#a3689631b501299037e089f99cb9b5b78">wxPGChoiceEditor</a>, <a class="el" href="classwxPGComboBoxEditor.htm#a606e5218f8014287f33f24b239ccc72d">wxPGComboBoxEditor</a>, <a class="el" href="classwxPGChoiceAndButtonEditor.htm#aea7555b65f78ffddc5186bd5e153ed5d">wxPGChoiceAndButtonEditor</a>, <a class="el" href="classwxPGTextCtrlAndButtonEditor.htm#a865448db790fb54714c04c66fca2dc20">wxPGTextCtrlAndButtonEditor</a>, and <a class="el" href="classwxPGCheckBoxEditor.htm#a9420e45f6ee1c26341c3dfb239b51f2d">wxPGCheckBoxEditor</a>.</p>
</div>
</div>
<a class="anchor" id="ad92b01e177e2448d63755c7b3cf58a13"></a><!-- doxytag: member="wxPGEditor::GetValueFromControl" ref="ad92b01e177e2448d63755c7b3cf58a13" args="(wxVariant &amp;variant, wxPGProperty *property, wxWindow *ctrl) const WX_PG_NOT_PURE_IN_WXPYTHON" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool wxPGEditor::GetValueFromControl </td>
<td>(</td>
<td class="paramtype">wxVariant &amp;&nbsp;</td>
<td class="paramname"> <em>variant</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>ctrl</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns value from control, via parameter 'variant'. </p>
<p>Usually ends up calling property's StringToValue or IntToValue. Returns true if value was different. </p>
<p>Reimplemented in <a class="el" href="classwxPGComboBoxEditor.htm#a53989f20f91d4129639ed33c93bb7644">wxPGComboBoxEditor</a>.</p>
</div>
</div>
<a class="anchor" id="a97de228636ce4e4b3f8d00593c65fe26"></a><!-- doxytag: member="wxPGEditor::InsertItem" ref="a97de228636ce4e4b3f8d00593c65fe26" args="(wxWindow *ctrl, const wxString &amp;label, int index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int wxPGEditor::InsertItem </td>
<td>(</td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>ctrl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxString &amp;&nbsp;</td>
<td class="paramname"> <em>label</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>index</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inserts item to existing control. </p>
<p>Index -1 means appending. Default implementation does nothing. Returns index of item added. </p>
<p>Reimplemented in <a class="el" href="classwxPGChoiceEditor.htm#ae4f15eeddd2c9e9ae4cfe767bb0c2c31">wxPGChoiceEditor</a>.</p>
</div>
</div>
<a class="anchor" id="a035fa3bee4ac87e4300df0c637a56261"></a><!-- doxytag: member="wxPGEditor::OnEvent" ref="a035fa3bee4ac87e4300df0c637a56261" args="(wxPropertyGrid *propgrid, wxPGProperty *property, wxWindow *wnd_primary, wxEvent &amp;event) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool wxPGEditor::OnEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *&nbsp;</td>
<td class="paramname"> <em>propgrid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>wnd_primary</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxEvent &amp;&nbsp;</td>
<td class="paramname"> <em>event</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles events. </p>
<p>Returns true if value in control was modified (see <a class="el" href="classwxPGProperty.htm#a16fbe26240bf47ab0a9a02d21781da73" title="Events received by editor widgets are processed here.">wxPGProperty::OnEvent</a> for more information). </p>
<p>Implemented in <a class="el" href="classwxPGComboBoxEditor.htm#a888445fcd39e3c1b02538f0915188cf8">wxPGComboBoxEditor</a>.</p>
</div>
</div>
<a class="anchor" id="a479f4ec8deeb41a41c5427f4e506c499"></a><!-- doxytag: member="wxPGEditor::OnFocus" ref="a479f4ec8deeb41a41c5427f4e506c499" args="(wxPGProperty *property, wxWindow *wnd) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPGEditor::OnFocus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>wnd</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extra processing when control gains focus. </p>
<p>For example, wxTextCtrl based controls should select all text. </p>
<p>Reimplemented in <a class="el" href="classwxPGTextCtrlEditor.htm#a22797e527d3578903a04477024b92db9">wxPGTextCtrlEditor</a>, and <a class="el" href="classwxPGComboBoxEditor.htm#a7f3b6bf5db56b03243858d9fd37bca2e">wxPGComboBoxEditor</a>.</p>
</div>
</div>
<a class="anchor" id="ad9667eb541f25f1d667de8cb937d24af"></a><!-- doxytag: member="wxPGEditor::SetControlIntValue" ref="ad9667eb541f25f1d667de8cb937d24af" args="(wxPGProperty *property, wxWindow *ctrl, int value) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPGEditor::SetControlIntValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>ctrl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>value</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets control's value specifically from int (applies to choice etc. </p>
<p>). </p>
<p>Reimplemented in <a class="el" href="classwxPGChoiceEditor.htm#a90dfadf653aa43eb28688582d302b044">wxPGChoiceEditor</a>, and <a class="el" href="classwxPGCheckBoxEditor.htm#a15e3f34d1d8420359f0aaf602dbb8f56">wxPGCheckBoxEditor</a>.</p>
</div>
</div>
<a class="anchor" id="a5fefad75f7890ac414f365d0b949a7a6"></a><!-- doxytag: member="wxPGEditor::SetControlStringValue" ref="a5fefad75f7890ac414f365d0b949a7a6" args="(wxPGProperty *property, wxWindow *ctrl, const wxString &amp;txt) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPGEditor::SetControlStringValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>ctrl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxString &amp;&nbsp;</td>
<td class="paramname"> <em>txt</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets control's value specifically from string. </p>
<p>Reimplemented in <a class="el" href="classwxPGTextCtrlEditor.htm#a3d002fa9838124d48c4edf4c0c565a04">wxPGTextCtrlEditor</a>, and <a class="el" href="classwxPGChoiceEditor.htm#a4ad9cce1b4004860f5458811f4f1ec3d">wxPGChoiceEditor</a>.</p>
</div>
</div>
<a class="anchor" id="a8b4f403f1311f9b3a57807147f0e8473"></a><!-- doxytag: member="wxPGEditor::SetValueToUnspecified" ref="a8b4f403f1311f9b3a57807147f0e8473" args="(wxPGProperty *property, wxWindow *ctrl) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPGEditor::SetValueToUnspecified </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>ctrl</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets value in control to unspecified. </p>
</div>
</div>
<a class="anchor" id="a229b635a46763efa40814584eb480c51"></a><!-- doxytag: member="wxPGEditor::UpdateControl" ref="a229b635a46763efa40814584eb480c51" args="(wxPGProperty *property, wxWindow *ctrl) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxPGEditor::UpdateControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *&nbsp;</td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxWindow *&nbsp;</td>
<td class="paramname"> <em>ctrl</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads value from property to the control. </p>
<p>Implemented in <a class="el" href="classwxPGComboBoxEditor.htm#abaa91efde70ebdfcaa5fd45b2328d2ab">wxPGComboBoxEditor</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>editors.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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink