a3ed46f2c3
git-svn-id: svn://10.65.10.50/branches/R_10_00@23289 c028cbd2-c16b-5b4b-a496-9718f37d4682
275 lines
18 KiB
HTML
275 lines
18 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: wxDateProperty 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>wxDateProperty Class Reference</h1><!-- doxytag: class="wxDateProperty" --><!-- doxytag: inherits="wxPGProperty" -->
|
|
<p>Property representing wxDateTime.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <advprops.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for wxDateProperty:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classwxDateProperty.png" usemap="#wxDateProperty_map" alt=""/>
|
|
<map id="wxDateProperty_map" name="wxDateProperty_map">
|
|
<area href="classwxPGProperty.htm" alt="wxPGProperty" shape="rect" coords="0,0,102,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classwxDateProperty-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="classwxDateProperty.htm#a8002d8507435979658552562ef88f6b4">DoSetAttribute</a> (const wxString &name, wxVariant &value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Special handling for attributes of this property. <a href="#a8002d8507435979658552562ef88f6b4"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d7bf2a3afaaf32c2617b605bc477365"></a><!-- doxytag: member="wxDateProperty::GetDatePickerStyle" ref="a2d7bf2a3afaaf32c2617b605bc477365" args="() const " -->
|
|
long </td><td class="memItemRight" valign="bottom"><b>GetDatePickerStyle</b> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27dbc2a68364c2fd5fa5b1af4fbf4399"></a><!-- doxytag: member="wxDateProperty::GetDateValue" ref="a27dbc2a68364c2fd5fa5b1af4fbf4399" args="() const " -->
|
|
wxDateTime </td><td class="memItemRight" valign="bottom"><b>GetDateValue</b> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb5ccf31881db73500ebd6452879f5d8"></a><!-- doxytag: member="wxDateProperty::GetFormat" ref="abb5ccf31881db73500ebd6452879f5d8" args="() const " -->
|
|
const wxString & </td><td class="memItemRight" valign="bottom"><b>GetFormat</b> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual wxString </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxDateProperty.htm#a884baa6bdf985b70bbf55b29d35472f0">GetValueAsString</a> (int flags=0) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns text representation of property's value. <a href="#a884baa6bdf985b70bbf55b29d35472f0"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxDateProperty.htm#a41352b386ea75996caec85a48bc1cfca">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="#a41352b386ea75996caec85a48bc1cfca"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3881dd60792f1605880bd4c7299d316"></a><!-- doxytag: member="wxDateProperty::SetDateValue" ref="ad3881dd60792f1605880bd4c7299d316" args="(const wxDateTime &dt)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetDateValue</b> (const wxDateTime &dt)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae38dac7b67e12989ca4933ddb21f6509"></a><!-- doxytag: member="wxDateProperty::SetFormat" ref="ae38dac7b67e12989ca4933ddb21f6509" args="(const wxString &format)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetFormat</b> (const wxString &format)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwxDateProperty.htm#a2b1646bc5d256760d5f0f6082fc26421">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="#a2b1646bc5d256760d5f0f6082fc26421"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad612233f6776de696bccf3603ebd927e"></a><!-- doxytag: member="wxDateProperty::wxDateProperty" ref="ad612233f6776de696bccf3603ebd927e" args="(const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, const wxDateTime &value=wxDateTime())" -->
|
|
</td><td class="memItemRight" valign="bottom"><b>wxDateProperty</b> (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, const wxDateTime &value=wxDateTime())</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="aff15d061406f713916fcf609d89ebb7c"></a><!-- doxytag: member="wxDateProperty::DetermineDefaultDateFormat" ref="aff15d061406f713916fcf609d89ebb7c" args="(bool showCentury)" -->
|
|
static wxString </td><td class="memItemRight" valign="bottom"><b>DetermineDefaultDateFormat</b> (bool showCentury)</td></tr>
|
|
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f4debd2fbb6fb59b84d6f4f3051918d"></a><!-- doxytag: member="wxDateProperty::m_dpStyle" ref="a7f4debd2fbb6fb59b84d6f4f3051918d" args="" -->
|
|
long </td><td class="memItemRight" valign="bottom"><b>m_dpStyle</b></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4efe2d1425c1d1496bb53cad997fc19d"></a><!-- doxytag: member="wxDateProperty::m_format" ref="a4efe2d1425c1d1496bb53cad997fc19d" args="" -->
|
|
wxString </td><td class="memItemRight" valign="bottom"><b>m_format</b></td></tr>
|
|
<tr><td colspan="2"><h2>Static Protected Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ab0ab383f718f6a56d5a1b93f7e3ddd"></a><!-- doxytag: member="wxDateProperty::ms_defaultDateFormat" ref="a9ab0ab383f718f6a56d5a1b93f7e3ddd" args="" -->
|
|
static wxString </td><td class="memItemRight" valign="bottom"><b>ms_defaultDateFormat</b></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>Property representing wxDateTime. </p>
|
|
<p><b>Supported special attributes:</b></p>
|
|
<ul>
|
|
<li>"DateFormat": Determines displayed date format.</li>
|
|
<li>"PickerStyle": Determines window style used with wxDatePickerCtrl. Default is wxDP_DEFAULT | wxDP_SHOWCENTURY. Using wxDP_ALLOWNONE enables additional support for unspecified property value. </li>
|
|
</ul>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a8002d8507435979658552562ef88f6b4"></a><!-- doxytag: member="wxDateProperty::DoSetAttribute" ref="a8002d8507435979658552562ef88f6b4" args="(const wxString &name, wxVariant &value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool wxDateProperty::DoSetAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const wxString & </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">wxVariant & </td>
|
|
<td class="paramname"> <em>value</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Special handling for attributes of this property. </p>
|
|
<p>If returns false, then the attribute will be automatically stored in m_attributes.</p>
|
|
<p>Default implementation simply returns false. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classwxPGProperty.htm#a7d355ae4bd55f00bc149e5416c39908c">wxPGProperty</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a884baa6bdf985b70bbf55b29d35472f0"></a><!-- doxytag: member="wxDateProperty::GetValueAsString" ref="a884baa6bdf985b70bbf55b29d35472f0" args="(int flags=0) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual wxString wxDateProperty::GetValueAsString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>argFlags</em> = <code>0</code></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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a41352b386ea75996caec85a48bc1cfca"></a><!-- doxytag: member="wxDateProperty::OnSetValue" ref="a41352b386ea75996caec85a48bc1cfca" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void wxDateProperty::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="classwxDateProperty.htm#a41352b386ea75996caec85a48bc1cfca" 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="classwxDateProperty.htm#a41352b386ea75996caec85a48bc1cfca" 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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2b1646bc5d256760d5f0f6082fc26421"></a><!-- doxytag: member="wxDateProperty::StringToValue" ref="a2b1646bc5d256760d5f0f6082fc26421" 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 wxDateProperty::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="classwxDateProperty.htm#a884baa6bdf985b70bbf55b29d35472f0" 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>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>advprops.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>
|