Get rid of obsolete wxPropertyGrid documentation

This commit is contained in:
Artur Wieczorek 2022-08-01 17:49:37 +02:00
parent 5e2da5a106
commit 5b2991bb77

View file

@ -17,10 +17,6 @@ numbers, flag sets, fonts, colours and many others. It is possible, for
example, to categorize properties, set up a complete tree-hierarchy, add more
than two columns, and set arbitrary per-property attributes.
As this version of wxPropertyGrid has some backward-incompatible changes from
version 1.4, everybody who need to maintain custom property classes should
carefully read final section in @ref propgrid_compat.
@see wxPropertyGrid, wxPropertyGridEvent, wxPropertyGridManager,
wxPropertyGridPage, wxPGProperty
@ -953,112 +949,4 @@ which choice entry.
@section propgrid_proplist Property Class Descriptions
See @ref pgproperty_properties
@section propgrid_compat Changes from wxPropertyGrid 1.4
Version of wxPropertyGrid bundled with wxWidgets 2.9+ has various backward-
incompatible changes from version 1.4, which had a stable API and will remain
as the last separate branch.
Note that in general any behaviour-breaking changes should not compile or run
without warnings or errors.
@subsection propgrid_compat_general General Changes
- Tab-traversal can no longer be used to travel between properties. Now
it only causes focus to move from main grid to editor of selected property.
Arrow keys are now your primary means of navigating between properties,
with keyboard. This change allowed fixing broken tab traversal on wxGTK
(which is open issue in wxPropertyGrid 1.4).
- wxPG_EX_UNFOCUS_ON_ENTER style is removed and is now default behaviour.
That is, when enter is pressed, editing is considered done and focus
moves back to the property grid from the editor control.
- A few member functions were removed from wxPropertyGridInterface.
Please use wxPGProperty's counterparts from now on.
- wxPGChoices now has proper Copy-On-Write behaviour.
- wxPGChoices::SetExclusive() was renamed to AllocExclusive().
- wxPGProperty::SetPropertyChoicesExclusive() was removed. Instead, use
GetChoices().AllocExclusive().
- wxPGProperty::ClearModifiedStatus() is removed. Please use
SetModifiedStatus() instead.
- wxPropertyGridInterface::GetExpandedProperties() is removed. You should
now use wxPropertyGridInterface::GetEditableState() instead.
- wxPG_EX_DISABLE_TLP_TRACKING is now enabled by default. To get the old
behaviour (recommended if you don't use a system that reparents the grid
on its own), use the wxPG_EX_ENABLE_TLP_TRACKING extra style.
- Extended window style wxPG_EX_LEGACY_VALIDATORS was removed.
- Default property validation failure behaviour has been changed to
(wxPG_VFB_MARK_CELL | wxPG_VFB_SHOW_MESSAGEBOX), which means that the
cell is marked red and wxMessageBox is shown. This is more user-friendly
than the old behaviour, which simply beeped and prevented leaving the
property editor until a valid value was entered.
- wxPropertyGridManager now has same Get/SetSelection() semantics as
wxPropertyGrid.
- Various wxPropertyGridManager page-related functions now return pointer
to the page object instead of index.
- wxArrayEditorDialog used by wxArrayStringProperty and some sample
properties has been renamed to wxPGArrayEditorDialog. Also, it now uses
wxEditableListBox for editing.
- Instead of calling wxPropertyGrid::SetButtonShortcut(), use
wxPropertyGrid::SetActionTrigger(wxPG_ACTION_PRESS_BUTTON).
- wxPGProperty::GetCell() now returns a reference. AcquireCell() was removed.
- wxPGMultiButton::FinalizePosition() has been renamed to Finalize(),
and it has slightly different argument list.
- wxPropertyGridEvent::HasProperty() is removed. You can use GetProperty()
as immediate replacement when checking if event has a property.
- "InlineHelp" property has been replaced with "Hint".
- wxPropertyGrid::CanClose() has been removed. Call
wxPropertyGridInterface::EditorValidate() instead.
- wxPGProperty::SetFlag() has been moved to private API. This was done to
underline the fact that it was not the preferred method to change a
property's state since it never had any desired side-effects. ChangeFlag()
still exists for those who really need to achieve the same effect.
- wxArrayStringProperty default delimiter is now comma (','), and it can
be changed by setting the new "Delimiter" attribute.
@subsection propgrid_compat_propdev Property and Editor Sub-classing Changes
- Confusing custom property macros have been eliminated.
- Implement wxPGProperty::ValueToString() instead of GetValueAsString().
- wxPGProperty::ChildChanged() must now return the modified value of
whole property instead of writing it back into 'thisValue' argument.
- Removed wxPropertyGrid::PrepareValueForDialogEditing(). Use
wxPropertyGrid::GetPendingEditedValue() instead.
- wxPGProperty::GetChoiceInfo() is removed, as all properties now carry
wxPGChoices instance (protected wxPGProperty::m_choices).
- Connect() should no longer be called in implementations of
wxPGEditor::CreateControls(). wxPropertyGrid automatically passes all
events from editor to wxPGEditor::OnEvent() and wxPGProperty::OnEvent(),
as appropriate.
- wxPython: Previously some of the reimplemented member functions needed a
'Py' prefix. This is no longer necessary. For instance, if you previously
implemented PyStringToValue() for your custom property, you should now
just implement StringToValue().
*/