diff --git a/interface/wx/propgrid/editors.h b/interface/wx/propgrid/editors.h index 7409284b74..cddb8fc900 100644 --- a/interface/wx/propgrid/editors.h +++ b/interface/wx/propgrid/editors.h @@ -38,7 +38,7 @@ public: calling wxPropertyGrid::RegisterAdditionalEditors() prior use. - Pointer to built-in editor is available as wxPGEditor_EditorName - (eg. wxPGEditor_TextCtrl). + (e.g. wxPGEditor_TextCtrl). - Before you start using new editor you just created, you need to register it using static function @@ -113,7 +113,7 @@ public: @remarks wxPropertyGrid will automatically unfocus the editor when @c wxEVT_TEXT_ENTER is received and when it results in property value being modified. This happens regardless of - editor type (ie. behaviour is same for any wxTextCtrl and + editor type (i.e. behaviour is same for any wxTextCtrl and wxComboBox based editor). */ virtual bool OnEvent( wxPropertyGrid* propgrid, wxPGProperty* property, diff --git a/interface/wx/propgrid/manager.h b/interface/wx/propgrid/manager.h index 4c2cfea320..6322ca1874 100644 --- a/interface/wx/propgrid/manager.h +++ b/interface/wx/propgrid/manager.h @@ -143,8 +143,8 @@ public: wxPropertyGridManager inherits from wxPropertyGridInterface, and as such it has most property manipulation functions. However, only some of them affect - properties on all pages (eg. GetPropertyByName() and ExpandAll()), while some - (eg. Append()) only apply to the currently selected page. + properties on all pages (e.g. GetPropertyByName() and ExpandAll()), while some + (e.g. Append()) only apply to the currently selected page. To operate explicitly on properties on specific page, use wxPropertyGridManager::GetPage() to obtain pointer to page's @@ -419,7 +419,7 @@ public: bool IsAnyModified() const; /** - Returns @true if updating is frozen (ie. Freeze() called but not yet Thaw() ). + Returns @true if updating is frozen (i.e. Freeze() called but not yet Thaw() ). */ bool IsFrozen() const; @@ -496,7 +496,7 @@ public: labels to be shown in full. @param subProps - If @false, will still allow sub-properties (ie. properties which + If @false, will still allow sub-properties (i.e. properties which parent is not root or category) to be cropped. @param allPages @@ -550,7 +550,7 @@ protected: /** Creates property grid for the manager. Reimplement in derived class to 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 manager. */ diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h index ed79e1617d..045291967e 100644 --- a/interface/wx/propgrid/property.h +++ b/interface/wx/propgrid/property.h @@ -422,7 +422,7 @@ wxPG_PROP_CUSTOMIMAGE = 0x0008, */ wxPG_PROP_NOEDITOR = 0x0010, -/** Property is collapsed, ie. it's children are hidden. +/** Property is collapsed, i.e. it's children are hidden. */ wxPG_PROP_COLLAPSED = 0x0020, @@ -606,7 +606,7 @@ wxPG_PROP_CLASS_SPECIFIC_3 = 0x00400000 @subsection wxIntProperty Like wxStringProperty, but converts text to a signed long integer. - wxIntProperty seamlessly supports 64-bit integers (ie. wxLongLong). + wxIntProperty seamlessly supports 64-bit integers (i.e. wxLongLong). To safely convert variant to integer, use code like this: @code @@ -625,7 +625,7 @@ wxPG_PROP_CLASS_SPECIFIC_3 = 0x00400000 attribute. Regardless of current prefix, understands (hex) values starting with both "0x" and "$". Like wxIntProperty, wxUIntProperty seamlessly supports 64-bit unsigned - integers (ie. wxULongLong). Same wxVariant safety rules apply. + integers (i.e. wxULongLong). Same wxVariant safety rules apply. @subsection wxFloatProperty @@ -707,7 +707,7 @@ wxPG_PROP_CLASS_SPECIFIC_3 = 0x00400000 manually edit the flags as a text; a continuous sequence of spaces, commas and semicolons are considered as a flag id separator. - Note: When changing "choices" (ie. flag labels) of wxFlagsProperty, + Note: When changing "choices" (i.e. flag labels) of wxFlagsProperty, you will need to use wxPGProperty::SetChoices() - otherwise they will not get updated properly. @@ -937,7 +937,7 @@ public: This virtual function is called after m_value has been set. @remarks - - If m_value was set to Null variant (ie. unspecified value), OnSetValue() + - If m_value was set to Null variant (i.e. unspecified value), OnSetValue() will not be called. - m_value may be of any variant type. Typically properties internally support only one variant type, and as such OnSetValue() provides a good opportunity to convert @@ -1294,7 +1294,7 @@ public: Returns instance of a new wxPGEditorDialogAdapter instance, which is used when user presses the (optional) button next to the editor control; - Default implementation returns @NULL (ie. no action is generated when + Default implementation returns @NULL (i.e. no action is generated when button is pressed). */ virtual wxPGEditorDialogAdapter* GetEditorDialog() const; @@ -1348,7 +1348,7 @@ public: void AdaptListToValue( wxVariant& list, wxVariant* value ) const; /** - Use this member function to add independent (ie. regular) children to + Use this member function to add independent (i.e. regular) children to a property. @return Appended childProperty. @@ -1461,7 +1461,7 @@ public: */ const wxPGEditor* GetColumnEditor( int column ) const; - /** Returns property's base name (ie. parent's name is not added in any case) */ + /** Returns property's base name (i.e. parent's name is not added in any case) */ const wxString& GetBaseName() const; /** @@ -1707,7 +1707,7 @@ public: int Index( const wxPGProperty* p ) const; /** - Use this member function to add independent (ie. regular) children to + Use this member function to add independent (i.e. regular) children to a property. @return Inserted childProperty. @@ -2037,13 +2037,13 @@ public: void SetValueInEvent( wxVariant value ) const; /** - Sets property's value to unspecified (ie. Null variant). + Sets property's value to unspecified (i.e. Null variant). */ void SetValueToUnspecified(); /** 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 ); diff --git a/interface/wx/propgrid/propgrid.h b/interface/wx/propgrid/propgrid.h index 7a39445bcf..b35b736d9c 100644 --- a/interface/wx/propgrid/propgrid.h +++ b/interface/wx/propgrid/propgrid.h @@ -920,7 +920,7 @@ public: bool IsEditorFocused() const; /** - Returns true if updating is frozen (ie. Freeze() called but not + Returns true if updating is frozen (i.e. Freeze() called but not yet Thaw() ). */ bool IsFrozen() const; diff --git a/interface/wx/propgrid/propgridiface.h b/interface/wx/propgrid/propgridiface.h index e40069d446..21637fa6bd 100644 --- a/interface/wx/propgrid/propgridiface.h +++ b/interface/wx/propgrid/propgridiface.h @@ -142,7 +142,7 @@ public: Refresh() when calling this function after control has been shown for the first time. - This functions deselects selected property, if any. Validation - failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. + failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e. selection is cleared even if editor had invalid value. */ wxPGProperty* Append( wxPGProperty* property ); @@ -171,7 +171,7 @@ public: Deletes all properties. @remarks This functions deselects selected property, if any. Validation - failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. + failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e. selection is cleared even if editor had invalid value. */ virtual void Clear() = 0; @@ -206,7 +206,7 @@ public: @return Returns @true if actually collapsed. @remarks This function may deselect selected property, if any. Validation - failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. + failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e. selection is cleared even if editor had invalid value. */ bool Collapse( wxPGPropArg id ); @@ -218,7 +218,7 @@ public: Return @false if failed (may fail if editor value cannot be validated). @remarks This functions clears selection. Validation failure option - wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection + wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e. selection is cleared even if editor had invalid value. */ bool CollapseAll(); @@ -244,7 +244,7 @@ public: This functions deselects selected property, if any. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not - respected, ie. selection is cleared even if editor had + respected, i.e. selection is cleared even if editor had invalid value. */ void DeleteProperty( wxPGPropArg id ); @@ -295,7 +295,7 @@ public: @return Returns @true if actually expanded. @remarks This function may deselect selected property, if any. Validation - failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. + failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e. selection is cleared even if editor had invalid value. */ bool Expand( wxPGPropArg id ); @@ -304,7 +304,7 @@ public: Expands all items that can be expanded. @remarks This functions clears selection. Validation failure option - wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection + wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e. selection is cleared even if editor had invalid value. */ bool ExpandAll( bool expand = true ); @@ -626,7 +626,7 @@ public: especially true if current mode is non-categoric. - This functions deselects selected property, if any. Validation - failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. + failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e. selection is cleared even if editor had invalid value. Example of use: diff --git a/interface/wx/propgrid/propgridpagestate.h b/interface/wx/propgrid/propgridpagestate.h index 3f16b4faae..328af6c0c6 100644 --- a/interface/wx/propgrid/propgridpagestate.h +++ b/interface/wx/propgrid/propgridpagestate.h @@ -129,7 +129,7 @@ wxPG_ITERATOR_MASK_OP_PARENT = wxPG_ITERATOR_FLAGS_ALL, /** Combines all flags needed to iterate through visible properties - (ie. hidden properties and children of collapsed parents are skipped). + (i.e. hidden properties and children of collapsed parents are skipped). @hideinitializer */ wxPG_ITERATE_VISIBLE = wxPG_ITERATE_PROPERTIES |