Fixed minor typos in comments.
Yet another iteration.
This commit is contained in:
@@ -60,7 +60,7 @@ public:
|
|||||||
calling wxPropertyGrid::RegisterAdditionalEditors() prior use.
|
calling wxPropertyGrid::RegisterAdditionalEditors() prior use.
|
||||||
|
|
||||||
- Pointer to builtin editor is available as wxPGEditor_EditorName
|
- Pointer to builtin editor is available as wxPGEditor_EditorName
|
||||||
(eg. wxPGEditor_TextCtrl).
|
(e.g. wxPGEditor_TextCtrl).
|
||||||
|
|
||||||
- To add new editor you need to register it first using static function
|
- To add new editor you need to register it first using static function
|
||||||
wxPropertyGrid::RegisterEditorClass(), with code like this:
|
wxPropertyGrid::RegisterEditorClass(), with code like this:
|
||||||
@@ -93,7 +93,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Returns pointer to the name of the editor. For example,
|
Returns pointer to the name of the editor. For example,
|
||||||
wxPGEditor_TextCtrl has name "TextCtrl". If you dont' need to access
|
wxPGEditor_TextCtrl has name "TextCtrl". If you don't need to access
|
||||||
your custom editor by string name, then you do not need to implement
|
your custom editor by string name, then you do not need to implement
|
||||||
this function.
|
this function.
|
||||||
*/
|
*/
|
||||||
@@ -398,7 +398,7 @@ public:
|
|||||||
|
|
||||||
//
|
//
|
||||||
// Use custom check box code instead of native control
|
// Use custom check box code instead of native control
|
||||||
// for cleaner (ie. more integrated) look.
|
// for cleaner (i.e. more integrated) look.
|
||||||
//
|
//
|
||||||
class WXDLLIMPEXP_PROPGRID wxPGCheckBoxEditor : public wxPGEditor
|
class WXDLLIMPEXP_PROPGRID wxPGCheckBoxEditor : public wxPGEditor
|
||||||
{
|
{
|
||||||
|
@@ -513,7 +513,7 @@ public:
|
|||||||
/** Select and displays a given page.
|
/** Select and displays a given page.
|
||||||
|
|
||||||
@param index
|
@param index
|
||||||
Index of page being seleced. Can be -1 to select nothing.
|
Index of page being selected. Can be -1 to select nothing.
|
||||||
*/
|
*/
|
||||||
void SelectPage( int index );
|
void SelectPage( int index );
|
||||||
|
|
||||||
@@ -623,7 +623,7 @@ protected:
|
|||||||
/**
|
/**
|
||||||
Creates property grid for the manager. Reimplement in derived class to
|
Creates property grid for the manager. Reimplement in derived class to
|
||||||
use subclassed wxPropertyGrid. However, if you do this then you
|
use subclassed wxPropertyGrid. However, if you do this then you
|
||||||
must also use the two-step construction (ie. default constructor and
|
must also use the two-step construction (i.e. default constructor and
|
||||||
Create() instead of constructor with arguments) when creating the
|
Create() instead of constructor with arguments) when creating the
|
||||||
manager.
|
manager.
|
||||||
*/
|
*/
|
||||||
|
@@ -606,7 +606,7 @@ wxPG_PROP_CLASS_SPECIFIC_3 = 0x00400000
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
The text will be echoed as asterisks (wxTE_PASSWORD will be passed to
|
The text will be echoed as asterisks (wxTE_PASSWORD will be passed to
|
||||||
textctrl etc).
|
textctrl etc.).
|
||||||
*/
|
*/
|
||||||
#define wxPG_STRING_PASSWORD wxS("Password")
|
#define wxPG_STRING_PASSWORD wxS("Password")
|
||||||
|
|
||||||
@@ -1473,7 +1473,7 @@ public:
|
|||||||
/** Returns which choice is currently selected. Only applies to properties
|
/** Returns which choice is currently selected. Only applies to properties
|
||||||
which have choices.
|
which have choices.
|
||||||
|
|
||||||
Needs to reimplemented in derived class if property value does not
|
Needs to be reimplemented in derived class if property value does not
|
||||||
map directly to a choice. Integer as index, bool, and string usually do.
|
map directly to a choice. Integer as index, bool, and string usually do.
|
||||||
*/
|
*/
|
||||||
virtual int GetChoiceSelection() const;
|
virtual int GetChoiceSelection() const;
|
||||||
@@ -1594,7 +1594,7 @@ public:
|
|||||||
wxString GetName() const;
|
wxString GetName() const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Returns property's base name (ie parent's name is not added in any
|
Returns property's base name (i.e. parent's name is not added in any
|
||||||
case)
|
case)
|
||||||
*/
|
*/
|
||||||
const wxString& GetBaseName() const { return m_name; }
|
const wxString& GetBaseName() const { return m_name; }
|
||||||
@@ -2237,7 +2237,7 @@ public:
|
|||||||
inline bool SetMaxLength( int maxLen );
|
inline bool SetMaxLength( int maxLen );
|
||||||
|
|
||||||
/** Call with 'false' in OnSetValue to cancel value changes after all
|
/** Call with 'false' in OnSetValue to cancel value changes after all
|
||||||
(ie. cancel 'true' returned by StringToValue() or IntToValue()).
|
(i.e. cancel 'true' returned by StringToValue() or IntToValue()).
|
||||||
*/
|
*/
|
||||||
void SetWasModified( bool set = true )
|
void SetWasModified( bool set = true )
|
||||||
{
|
{
|
||||||
@@ -2409,7 +2409,7 @@ protected:
|
|||||||
Start looking for the child at this index.
|
Start looking for the child at this index.
|
||||||
|
|
||||||
@remarks
|
@remarks
|
||||||
Does not support scope (ie. Parent.Child notation).
|
Does not support scope (i.e. Parent.Child notation).
|
||||||
*/
|
*/
|
||||||
wxPGProperty* GetPropertyByNameWH( const wxString& name,
|
wxPGProperty* GetPropertyByNameWH( const wxString& name,
|
||||||
unsigned int hintIndex ) const;
|
unsigned int hintIndex ) const;
|
||||||
|
@@ -1759,7 +1759,7 @@ public:
|
|||||||
virtual void DrawItemAndChildren( wxPGProperty* p );
|
virtual void DrawItemAndChildren( wxPGProperty* p );
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Draws item, children, and consequtive parents as long as category is
|
Draws item, children, and consecutive parents as long as category is
|
||||||
not met.
|
not met.
|
||||||
*/
|
*/
|
||||||
void DrawItemAndValueRelated( wxPGProperty* p );
|
void DrawItemAndValueRelated( wxPGProperty* p );
|
||||||
|
@@ -224,9 +224,9 @@ class wxPGValidationInfo;
|
|||||||
|
|
||||||
// -----------------------------------------------------------------------
|
// -----------------------------------------------------------------------
|
||||||
|
|
||||||
/** @section propgrid_misc wxPropertyGrid Miscellanous
|
/** @section propgrid_misc wxPropertyGrid Miscellaneous
|
||||||
|
|
||||||
This section describes some miscellanous values, types and macros.
|
This section describes some miscellaneous values, types and macros.
|
||||||
@{
|
@{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@@ -761,7 +761,7 @@ public:
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Returns true if property is shown (ie hideproperty with true not
|
Returns true if property is shown (i.e. HideProperty with true not
|
||||||
called for it).
|
called for it).
|
||||||
*/
|
*/
|
||||||
bool IsPropertyShown( wxPGPropArg id ) const
|
bool IsPropertyShown( wxPGPropArg id ) const
|
||||||
@@ -928,7 +928,7 @@ public:
|
|||||||
DoSetPropertyAttribute(id,attrName,value,argFlags);
|
DoSetPropertyAttribute(id,attrName,value,argFlags);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Sets property attribute for all applicapple properties.
|
/** Sets property attribute for all applicable properties.
|
||||||
Be sure to use this method only after all properties have been
|
Be sure to use this method only after all properties have been
|
||||||
added to the grid.
|
added to the grid.
|
||||||
*/
|
*/
|
||||||
@@ -1068,7 +1068,7 @@ public:
|
|||||||
This is mainly for use with textctrl editor. Not all other editors fully
|
This is mainly for use with textctrl editor. Not all other editors fully
|
||||||
support it.
|
support it.
|
||||||
@param flags
|
@param flags
|
||||||
By default changes are applied recursively. Set this paramter
|
By default changes are applied recursively. Set this parameter
|
||||||
wxPG_DONT_RECURSE to prevent this.
|
wxPG_DONT_RECURSE to prevent this.
|
||||||
*/
|
*/
|
||||||
void SetPropertyReadOnly( wxPGPropArg id,
|
void SetPropertyReadOnly( wxPGPropArg id,
|
||||||
|
@@ -223,7 +223,7 @@ public:
|
|||||||
void Prev();
|
void Prev();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Set base parent, ie a property when, in which iteration returns, it
|
Set base parent, i.e. a property when, in which iteration returns, it
|
||||||
ends.
|
ends.
|
||||||
|
|
||||||
Default base parent is the root of the used wxPropertyGridPageState.
|
Default base parent is the root of the used wxPropertyGridPageState.
|
||||||
@@ -402,7 +402,7 @@ protected:
|
|||||||
/** @class wxPropertyGridPageState
|
/** @class wxPropertyGridPageState
|
||||||
|
|
||||||
Contains low-level property page information (properties, column widths,
|
Contains low-level property page information (properties, column widths,
|
||||||
etc) of a single wxPropertyGrid or single wxPropertyGridPage. Generally you
|
etc.) of a single wxPropertyGrid or single wxPropertyGridPage. Generally you
|
||||||
should not use this class directly, but instead member functions in
|
should not use this class directly, but instead member functions in
|
||||||
wxPropertyGridInterface, wxPropertyGrid, wxPropertyGridPage, and
|
wxPropertyGridInterface, wxPropertyGrid, wxPropertyGridPage, and
|
||||||
wxPropertyGridManager.
|
wxPropertyGridManager.
|
||||||
|
@@ -969,7 +969,7 @@ public:
|
|||||||
|
|
||||||
/** Override to return wxValidator to be used with the wxTextCtrl
|
/** Override to return wxValidator to be used with the wxTextCtrl
|
||||||
in dialog. Note that the validator is used in the standard
|
in dialog. Note that the validator is used in the standard
|
||||||
wx way, ie. it immediately prevents user from entering invalid
|
wx way, i.e. it immediately prevents user from entering invalid
|
||||||
input.
|
input.
|
||||||
|
|
||||||
@remarks
|
@remarks
|
||||||
|
@@ -833,7 +833,7 @@ void wxPGProperty::GetDisplayInfo( unsigned int column,
|
|||||||
|
|
||||||
if ( choiceIndex != wxNOT_FOUND )
|
if ( choiceIndex != wxNOT_FOUND )
|
||||||
{
|
{
|
||||||
// Overrride default cell settings with
|
// Override default cell settings with
|
||||||
// custom settings defined for choice item.
|
// custom settings defined for choice item.
|
||||||
const wxPGChoiceEntry& entry = m_choices[choiceIndex];
|
const wxPGChoiceEntry& entry = m_choices[choiceIndex];
|
||||||
cell.MergeFrom(entry);
|
cell.MergeFrom(entry);
|
||||||
|
Reference in New Issue
Block a user