Added named section 'Property development funcions'

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61405 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Jaakko Salli 2009-07-11 08:16:04 +00:00
parent eddcc4b442
commit 7dfede7b92

View File

@ -451,24 +451,6 @@ public:
long style = wxPG_DEFAULT_STYLE,
const wxChar* name = wxPropertyGridNameStr );
/**
Call when editor widget's contents is modified. For example, this is
called when changes text in wxTextCtrl (used in wxStringProperty and
wxIntProperty).
@remarks This function should only be called by custom properties.
@see wxPGProperty::OnEvent()
*/
void EditorsValueWasModified();
/**
Reverse of EditorsValueWasModified().
@remarks This function should only be called by custom properties.
*/
void EditorsValueWasNotModified();
/**
Enables or disables (shows/hides) categories according to parameter
enable.
@ -603,14 +585,6 @@ public:
*/
wxColour GetMarginColour() const;
/**
Returns most up-to-date value of selected property. This will return
value different from GetSelectedProperty()->GetValue() only when text
editor is activate and string edited by user represents valid,
uncommitted property value.
*/
wxVariant GetUncommittedPropertyValue();
/**
Returns "root property". It does not have name, etc. and it is not
visible. It is only useful for accessing its children.
@ -665,11 +639,6 @@ public:
*/
int GetVerticalSpacing() const;
/**
Returns true if editor's value was marked modified.
*/
bool IsEditorsValueModified() const;
/**
Returns information about arbitrary position in the grid.
@ -878,6 +847,46 @@ public:
*/
void SetVerticalSpacing( int vspacing );
/**
@name Property development functions
These member functions are usually only called when creating custom
user properties.
*/
//@{
/**
Call when editor widget's contents is modified. For example, this is
called when changes text in wxTextCtrl (used in wxStringProperty and
wxIntProperty).
@remarks This function should only be called by custom properties.
@see wxPGProperty::OnEvent()
*/
void EditorsValueWasModified();
/**
Reverse of EditorsValueWasModified().
@remarks This function should only be called by custom properties.
*/
void EditorsValueWasNotModified();
/**
Returns most up-to-date value of selected property. This will return
value different from GetSelectedProperty()->GetValue() only when text
editor is activate and string edited by user represents valid,
uncommitted property value.
*/
wxVariant GetUncommittedPropertyValue();
/**
Returns true if editor's value was marked modified.
*/
bool IsEditorsValueModified() const;
/**
Shows an brief error message that is related to a property.
*/
@ -894,6 +903,8 @@ public:
wxPGProperty::OnEvent() is not even called in those cases).
*/
bool WasValueChangedInEvent() const;
//@}
};