wxPGCachedString m_strbool;
wxPGCachedString m_strlist;
+ wxPGCachedString m_strDefaultValue;
wxPGCachedString m_strMin;
wxPGCachedString m_strMax;
wxPGCachedString m_strUnits;
int m_extraStyle; // global extra style
-#ifdef __WXDEBUG__
int m_warnings;
-#endif
int HasExtraStyle( int style ) const { return (m_extraStyle & style); }
};
#define wxPGVariant_Bool(A) (A?wxPGVariant_True:wxPGVariant_False)
+// When wxPG is loaded dynamically after the application is already running
+// then the built-in module system won't pick this one up. Add it manually.
+WXDLLIMPEXP_PROPGRID void wxPGInitResourceModule();
+
#endif // !SWIG
// -----------------------------------------------------------------------
/** wxPropertyGridManager only: Show adjustable text box showing description
or help text, if available, for currently selected property.
*/
-wxPG_DESCRIPTION = 0x00002000
+wxPG_DESCRIPTION = 0x00002000,
+/** wxPropertyGridManager only: don't show an internal border around
+ the property grid.
+*/
+wxPG_NO_INTERNAL_BORDER = 0x00004000
};
+#if wxPG_COMPATIBILITY_1_4
+ // In wxPG 1.4 this was used to enable now-default theme border support
+ // in wxPropertyGridManager.
+ #define wxPG_THEME_BORDER 0x00000000
+#endif
+
+
enum wxPG_EX_WINDOW_STYLES
{
/** Hides page selection buttons from toolbar.
*/
-wxPG_EX_HIDE_PAGE_BUTTONS = 0x01000000
+wxPG_EX_HIDE_PAGE_BUTTONS = 0x01000000,
+
+/** Allows multiple properties to be selected by user (by pressing SHIFT
+ when clicking on a property, or by dragging with left mouse button
+ down).
+
+ You can get array of selected properties with
+ wxPropertyGridInterface::GetSelectedProperties(). In multiple selection
+ mode wxPropertyGridInterface::GetSelection() returns
+ property which has editor active (usually the first one
+ selected). Other useful member functions are ClearSelection(),
+ AddToSelection() and RemoveFromSelection().
+*/
+wxPG_EX_MULTIPLE_SELECTION = 0x02000000,
+
+/**
+ This enables top-level window tracking which allows wxPropertyGrid to
+ notify the application of last-minute property value changes by user.
+
+ This style is not enabled by default because it may cause crashes when
+ wxPropertyGrid is used in with wxAUI or similar system.
+
+ @remarks If you are not in fact using any system that may change
+ wxPropertyGrid's top-level parent window on its own, then you
+ are recommended to enable this style.
+*/
+wxPG_EX_ENABLE_TLP_TRACKING = 0x04000000,
+
+/** Don't show divider above toolbar, on Windows.
+*/
+wxPG_EX_NO_TOOLBAR_DIVIDER = 0x08000000,
+
+/** Show a separator below the toolbar.
+*/
+wxPG_EX_TOOLBAR_SEPARATOR = 0x10000000
};
+#if wxPG_COMPATIBILITY_1_4
+ #define wxPG_EX_DISABLE_TLP_TRACKING 0x00000000
+#endif
+
/** Combines various styles.
*/
#define wxPG_DEFAULT_STYLE (0)
// wxPropertyGrid::DoSelectProperty flags (selFlags)
// Focuses to created editor
-#define wxPG_SEL_FOCUS 0x01
+#define wxPG_SEL_FOCUS 0x0001
// Forces deletion and recreation of editor
-#define wxPG_SEL_FORCE 0x02
+#define wxPG_SEL_FORCE 0x0002
// For example, doesn't cause EnsureVisible
-#define wxPG_SEL_NONVISIBLE 0x04
+#define wxPG_SEL_NONVISIBLE 0x0004
// Do not validate editor's value before selecting
-#define wxPG_SEL_NOVALIDATE 0x08
+#define wxPG_SEL_NOVALIDATE 0x0008
// Property being deselected is about to be deleted
-#define wxPG_SEL_DELETING 0x10
+#define wxPG_SEL_DELETING 0x0010
// Property's values was set to unspecified by the user
-#define wxPG_SEL_SETUNSPEC 0x20
+#define wxPG_SEL_SETUNSPEC 0x0020
// Property's event handler changed the value
-#define wxPG_SEL_DIALOGVAL 0x40
-
+#define wxPG_SEL_DIALOGVAL 0x0040
+// Set to disable sending of wxEVT_PG_SELECTED event
+#define wxPG_SEL_DONT_SEND_EVENT 0x0080
+// Don't make any graphics updates
+#define wxPG_SEL_NO_REFRESH 0x0100
// -----------------------------------------------------------------------
@beginEventTable{wxPropertyGridEvent}
@event{EVT_PG_SELECTED (id, func)}
- Respond to wxEVT_PG_SELECTED event, generated when property value
- has been changed by user.
+ Respond to wxEVT_PG_SELECTED event, generated when a property selection
+ has been changed, either by user action or by indirect program
+ function. For instance, collapsing a parent property programmatically
+ causes any selected child property to become unselected, and may
+ therefore cause this event to be generated.
@event{EVT_PG_CHANGING(id, func)}
Respond to wxEVT_PG_CHANGING event, generated when property value
is about to be changed by user. Use wxPropertyGridEvent::GetValue()
@event{EVT_PG_ITEM_EXPANDED(id, func)}
Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands
a property or category..
+ @event{EVT_PG_LABEL_EDIT_BEGIN(id, func)}
+ Respond to wxEVT_PG_LABEL_EDIT_BEGIN event, generated when is about to
+ begin editing a property label. You can veto this event to prevent the
+ action.
+ @event{EVT_PG_LABEL_EDIT_ENDING(id, func)}
+ Respond to wxEVT_PG_LABEL_EDIT_ENDING event, generated when is about to
+ end editing of a property label. You can veto this event to prevent the
+ action.
@endEventTable
@remarks
friend class wxPropertyGridManager;
friend class wxPGCanvas;
-#ifndef SWIG
DECLARE_DYNAMIC_CLASS(wxPropertyGrid)
-#endif
public:
-#ifdef SWIG
- %pythonAppend wxPropertyGrid {
- self._setOORInfo(self)
- self.DoDefaultTypeMappings()
- self.edited_objects = {}
- self.DoDefaultValueTypeMappings()
- if not hasattr(self.__class__,'_vt2setter'):
- self.__class__._vt2setter = {}
- }
- %pythonAppend wxPropertyGrid() ""
-
- wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxPG_DEFAULT_STYLE,
- const wxChar* name = wxPyPropertyGridNameStr );
- %RenameCtor(PrePropertyGrid, wxPropertyGrid());
-#else
-
+#ifndef SWIG
/**
Two step constructor.
wxPropertyGrid
*/
wxPropertyGrid();
+#endif
/** The default constructor. The styles to be used are styles valid for
the wxWindow and wxScrolledWindow.
/** Destructor */
virtual ~wxPropertyGrid();
-#endif
/** Adds given key combination to trigger given action.
/** Returns currently selected property. */
wxPGProperty* GetSelectedProperty() const { return GetSelection(); }
- /** Returns currently selected property. */
- wxPGProperty* GetSelection() const
- {
- return m_selected;
- }
-
/** Returns current selection background colour. */
wxColour GetSelectionBackgroundColour() const { return m_colSelBack; }
*/
bool IsFrozen() const { return (m_frozen>0)?true:false; }
+ /**
+ It is recommended that you call this function any time your code causes
+ wxPropertyGrid's top-level parent to change. wxPropertyGrid's OnIdle()
+ handler should be able to detect most changes, but it is not perfect.
+
+ @param newTLP
+ New top-level parent that is about to be set. Old top-level parent
+ window should still exist as the current one.
+
+ @remarks This function is automatically called from wxPropertyGrid::
+ Reparent() and wxPropertyGridManager::Reparent(). You only
+ need to use it if you reparent wxPropertyGrid indirectly.
+ */
+ void OnTLPChanging( wxWindow* newTLP );
+
/** Redraws given property.
*/
virtual void RefreshProperty( wxPGProperty* p );
Pointer to the editor class instance that should be used.
*/
static wxPGEditor* RegisterEditorClass( wxPGEditor* editor,
- bool noDefCheck = false );
+ bool noDefCheck = false )
+ {
+ return DoRegisterEditorClass(editor, wxEmptyString, noDefCheck);
+ }
+
+ static wxPGEditor* DoRegisterEditorClass( wxPGEditor* editorClass,
+ const wxString& editorName,
+ bool noDefCheck = false );
#endif
/** Resets all colours to the original system values.
/**
Selects a property.
Editor widget is automatically created, but not focused unless focus is
- true. This will generate wxEVT_PG_SELECT event.
+ true.
+
@param id
Property to select.
+
@return
True if selection finished successfully. Usually only fails if
current value in editor is not valid.
- @see wxPropertyGrid::Unselect
+
+ @remarks In wxPropertyGrid 1.4, this member function used to generate
+ wxEVT_PG_SELECTED. In wxWidgets 2.9 and later, it no longer
+ does that.
+
+ @remarks This clears any previous selection.
*/
- bool SelectProperty( wxPGPropArg id, bool focus = false )
+ bool SelectProperty( wxPGPropArg id, bool focus = false );
+
+ /**
+ Set entire new selection from given list of properties.
+ */
+ void SetSelection( const wxArrayPGProperty& newSelection )
+ {
+ DoSetSelection( newSelection, wxPG_SEL_DONT_SEND_EVENT );
+ }
+
+ /**
+ Adds given property into selection. If wxPG_EX_MULTIPLE_SELECTION
+ extra style is not used, then this has same effect as
+ calling SelectProperty().
+
+ @remarks Multiple selection is not supported for categories. This
+ means that if you have properties selected, you cannot
+ add category to selection, and also if you have category
+ selected, you cannot add other properties to selection.
+ This member function will fail silently in these cases,
+ even returning true.
+ */
+ bool AddToSelection( wxPGPropArg id )
{
wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
- return DoSelectProperty(p,focus?wxPG_SEL_FOCUS:0);
+ return DoAddToSelection(p, wxPG_SEL_DONT_SEND_EVENT);
+ }
+
+ /**
+ Removes given property from selection. If property is not selected,
+ an assertion failure will occur.
+ */
+ bool RemoveFromSelection( wxPGPropArg id )
+ {
+ wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
+ return DoRemoveFromSelection(p, wxPG_SEL_DONT_SEND_EVENT);
+ }
+
+ /**
+ Makes given column editable by user.
+
+ @param editable
+ Using @false here will disable column from being editable.
+ */
+ void MakeColumnEditable( unsigned int column, bool editable = true );
+
+ /**
+ Creates label editor wxTextCtrl for given column, for property
+ that is currently selected. When multiple selection is
+ enabled, this applies to whatever property GetSelection()
+ returns.
+
+ @param colIndex
+ Which column's label to edit. Note that you should not
+ use value 1, which is reserved for property value
+ column.
+
+ @see EndLabelEdit(), MakeColumnEditable()
+ */
+ void BeginLabelEdit( unsigned int column = 0 )
+ {
+ DoBeginLabelEdit(column, wxPG_SEL_DONT_SEND_EVENT);
+ }
+
+ /**
+ Destroys label editor wxTextCtrl, if any.
+
+ @param commit
+ Use @true (default) to store edited label text in
+ property cell data.
+
+ @see BeginLabelEdit(), MakeColumnEditable()
+ */
+ void EndLabelEdit( bool commit = true )
+ {
+ DoEndLabelEdit(commit, wxPG_SEL_DONT_SEND_EVENT);
+ }
+
+ /**
+ Returns currently active label editor, NULL if none.
+ */
+ wxTextCtrl* GetLabelEditor() const
+ {
+ return m_labelEditor;
}
/** Sets category caption background colour. */
shown).
*/
void FixPosForTextCtrl( wxWindow* ctrl,
+ unsigned int forColumn = 1,
const wxPoint& offset = wxPoint(0, 0) );
/** Shortcut for creating text editor widget.
const wxString& value,
wxWindow* secondary,
int extraStyle = 0,
- int maxLen = 0 );
+ int maxLen = 0,
+ unsigned int forColumn = 1 );
/* Generates both textctrl and button.
*/
m_iFlags |= wxPG_FL_VALUE_CHANGE_IN_EVENT;
}
+ /**
+ You can use this member function, for instance, to detect in
+ wxPGProperty::OnEvent() if wxPGProperty::SetValueInEvent() was
+ already called in wxPGEditor::OnEvent(). It really only detects
+ if was value was changed using wxPGProperty::SetValueInEvent(), which
+ is usually used when a 'picker' dialog is displayed. If value was
+ written by "normal means" in wxPGProperty::StringToValue() or
+ IntToValue(), then this function will return false (on the other hand,
+ wxPGProperty::OnEvent() is not even called in those cases).
+ */
+ bool WasValueChangedInEvent() const
+ {
+ return (m_iFlags & wxPG_FL_VALUE_CHANGE_IN_EVENT) ? true : false;
+ }
+
/** Returns true if given event is from first of an array of buttons
(as can be in case when wxPGMultiButton is used).
*/
virtual void SetWindowStyleFlag( long style );
+ void DrawItems( const wxPGProperty* p1, const wxPGProperty* p2 );
+
+ void DrawItem( wxPGProperty* p )
+ {
+ DrawItems(p,p);
+ }
+
+ virtual void DrawItemAndChildren( wxPGProperty* p );
+
+ /**
+ Draws item, children, and consequtive parents as long as category is
+ not met.
+ */
+ void DrawItemAndValueRelated( wxPGProperty* p );
+
protected:
/**
//
// Public methods for semi-public use
- // (not protected for optimization)
//
bool DoSelectProperty( wxPGProperty* p, unsigned int flags = 0 );
virtual void Freeze();
virtual void SetExtraStyle( long exStyle );
virtual void Thaw();
-
+ virtual bool Reparent( wxWindowBase *newParent );
protected:
virtual wxSize DoGetBestSize() const;
/** When drawing next time, clear this many item slots at the end. */
int m_clearThisMany;
- /** Pointer to selected property. Note that this is duplicated in
- m_state for better transiency between pages so that the selected
- item can be retained.
- */
- wxPGProperty* m_selected;
+ // Mouse is hovering over this column (index)
+ unsigned int m_colHover;
// pointer to property that has mouse hovering
wxPGProperty* m_propHover;
+ // Active label editor
+ wxTextCtrl* m_labelEditor;
+
+ // For which property the label editor is active
+ wxPGProperty* m_labelEditorProperty;
+
// EventObject for wxPropertyGridEvents
wxWindow* m_eventObject;
// handling mess).
wxWindow* m_curFocused;
- // wxPGTLWHandler
- wxEvtHandler* m_tlwHandler;
+ // Event currently being sent - NULL if none at the moment
+ wxPropertyGridEvent* m_processedEvent;
- // Top level parent
+ // Last known top-level parent
wxWindow* m_tlp;
+ // Last closed top-level parent
+ wxWindow* m_tlpClosed;
+
+ // Local time ms when tlp was closed.
+ wxLongLong m_tlpClosedTime;
+
// Sort function
wxPGSortCallback m_sortFunction;
// y coordinate of property that mouse hovering
int m_propHoverY;
+
// Which column's editor is selected (usually 1)?
- int m_selColumn;
+ unsigned int m_selColumn;
// x relative to splitter (needed for resize).
int m_ctrlXAdjust;
void OnSysColourChanged( wxSysColourChangedEvent &event );
+ void OnTLPClose( wxCloseEvent& event );
+
protected:
+ bool AddToSelectionFromInputEvent( wxPGProperty* prop,
+ unsigned int colIndex,
+ wxMouseEvent* event = NULL,
+ int selFlags = 0 );
+
/**
Adjust the centering of the bitmap icons (collapse / expand) when the
caption font changes.
*/
void CorrectEditorWidgetPosY();
-#ifdef __WXDEBUG__
- void _log_items();
- void OnScreenNote( const wxChar* format, ... );
-#endif
-
- /** Deselect current selection, if any. Returns true if success
- (ie. validator did not intercept). */
- bool DoClearSelection();
-
int DoDrawItems( wxDC& dc,
const wxRect* clipRect,
bool isBuffered ) const;
void DrawItems( wxDC& dc, unsigned int topitemy, unsigned int bottomitemy,
const wxRect* clip_rect = (const wxRect*) NULL );
- void DrawItems( const wxPGProperty* p1, const wxPGProperty* p2 );
-
- void DrawItem( wxPGProperty* p )
- {
- DrawItems(p,p);
- }
-
- virtual void DrawItemAndChildren( wxPGProperty* p );
-
- /**
- Draws item, children, and consequtive parents as long as category is
- not met.
- */
- void DrawItemAndValueRelated( wxPGProperty* p );
-
// Translate wxKeyEvent to wxPG_ACTION_XXX
int KeyEventToActions(wxKeyEvent &event, int* pSecond) const;
bool DoEditorValidate();
+ // Similar to DoSelectProperty() but also works on columns
+ // other than 1. Does not active editor if column is not
+ // editable.
+ bool DoSelectAndEdit( wxPGProperty* prop,
+ unsigned int colIndex,
+ unsigned int selFlags );
+
+ void DoSetSelection( const wxArrayPGProperty& newSelection,
+ int selFlags = 0 );
+
+ bool DoAddToSelection( wxPGProperty* prop,
+ int selFlags = 0 );
+
+ bool DoRemoveFromSelection( wxPGProperty* prop,
+ int selFlags = 0 );
+
+ void DoBeginLabelEdit( unsigned int colIndex, int selFlags = 0 );
+ void DoEndLabelEdit( bool commit, int selFlags = 0 );
+ void OnLabelEditorEnterPress( wxCommandEvent& event );
+ void OnLabelEditorKeyPress( wxKeyEvent& event );
+
wxPGProperty* DoGetItemAtY( int y ) const;
void DoSetSplitterPosition_( int newxpos,
int splitterIndex = 0,
bool allPages = false );
+ void DestroyEditorWnd( wxWindow* wnd );
void FreeEditors();
virtual bool DoExpand( wxPGProperty* p, bool sendEvent = false );
void PrepareAfterItemsAdded();
- bool SendEvent( int eventType,
- wxPGProperty* p,
+ // Omit the wxPG_SEL_NOVALIDATE flag to allow vetoing the event
+ bool SendEvent( int eventType, wxPGProperty* p,
wxVariant* pValue = NULL,
- unsigned int selFlags = 0 );
+ unsigned int selFlags = wxPG_SEL_NOVALIDATE,
+ unsigned int column = 1 );
void SetFocusOnCanvas();
return 0;
}
-inline void wxPGProperty::SetEditor( const wxString& editorName )
+inline void wxPGProperty::SetDefaultValue( wxVariant& value )
{
- m_customEditor = wxPropertyGridInterface::GetEditorByName(editorName);
+ SetAttribute(wxPG_ATTR_DEFAULT_VALUE, value);
}
-inline void wxPGProperty::SetName( const wxString& newName )
+inline void wxPGProperty::SetEditor( const wxString& editorName )
{
- GetGrid()->SetPropertyName(this, newName);
+ m_customEditor = wxPropertyGridInterface::GetEditorByName(editorName);
}
inline bool wxPGProperty::Hide( bool hide, int flags )
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_PROPGRID, wxEVT_PG_ITEM_COLLAPSED, wxPropertyGridEvent );
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_PROPGRID, wxEVT_PG_ITEM_EXPANDED, wxPropertyGridEvent );
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_PROPGRID, wxEVT_PG_DOUBLE_CLICK, wxPropertyGridEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_PROPGRID,
+ wxEVT_PG_LABEL_EDIT_BEGIN, wxPropertyGridEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_PROPGRID,
+ wxEVT_PG_LABEL_EDIT_ENDING, wxPropertyGridEvent );
#else
enum {
wxEVT_PG_PAGE_CHANGED,
wxEVT_PG_ITEM_COLLAPSED,
wxEVT_PG_ITEM_EXPANDED,
- wxEVT_PG_DOUBLE_CLICK
+ wxEVT_PG_DOUBLE_CLICK,
+ wxEVT_PG_LABEL_EDIT_BEGIN,
+ wxEVT_PG_LABEL_EDIT_ENDING
};
#endif
#define EVT_PG_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_PAGE_CHANGED, id, -1, wxEVENT_HANDLER_CAST( wxPropertyGridEventFunction, fn ), NULL ),
#define EVT_PG_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_COLLAPSED, id, -1, wxEVENT_HANDLER_CAST( wxPropertyGridEventFunction, fn ), NULL ),
#define EVT_PG_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_EXPANDED, id, -1, wxEVENT_HANDLER_CAST( wxPropertyGridEventFunction, fn ), NULL ),
+#define EVT_PG_LABEL_EDIT_BEGIN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_LABEL_EDIT_BEGIN, id, -1, wxEVENT_HANDLER_CAST( wxPropertyGridEventFunction, fn ), NULL ),
+#define EVT_PG_LABEL_EDIT_ENDING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_LABEL_EDIT_ENDING, id, -1, wxEVENT_HANDLER_CAST( wxPropertyGridEventFunction, fn ), NULL ),
#define wxPropertyGridEventHandler(fn) \
wxEVENT_HANDLER_CAST( wxPropertyGridEventFunction, fn )
/** Copyer. */
virtual wxEvent* Clone() const;
+ /**
+ Returns the column index associated with this event.
+ */
+ unsigned int GetColumn() const
+ {
+ return m_column;
+ }
+
wxPGProperty* GetMainParent() const
{
wxASSERT(m_property);
return m_validationInfo->GetFailureBehavior();
}
+ void SetColumn( unsigned int column )
+ {
+ m_column = column;
+ }
+
void SetCanVeto( bool canVeto ) { m_canVeto = canVeto; }
bool WasVetoed() const { return m_wasVetoed; }
wxPropertyGrid* m_pg;
wxPGValidationInfo* m_validationInfo;
+ unsigned int m_column;
+
bool m_canVeto;
bool m_wasVetoed;
projects / wxWidgets.git / blobdiff