1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/propgrid/propgrid.cpp
3 // Purpose: wxPropertyGrid
4 // Author: Jaakko Salli
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx/wx.h".
13 #include "wx/wxprec.h"
23 #include "wx/object.h"
25 #include "wx/string.h"
28 #include "wx/window.h"
31 #include "wx/dcmemory.h"
32 #include "wx/button.h"
35 #include "wx/cursor.h"
36 #include "wx/dialog.h"
37 #include "wx/settings.h"
38 #include "wx/msgdlg.h"
39 #include "wx/choice.h"
40 #include "wx/stattext.h"
41 #include "wx/scrolwin.h"
42 #include "wx/dirdlg.h"
44 #include "wx/textdlg.h"
45 #include "wx/filedlg.h"
46 #include "wx/statusbr.h"
52 // This define is necessary to prevent macro clearing
53 #define __wxPG_SOURCE_FILE__
55 #include "wx/propgrid/propgrid.h"
56 #include "wx/propgrid/editors.h"
58 #if wxPG_USE_RENDERER_NATIVE
59 #include "wx/renderer.h"
62 #include "wx/odcombo.h"
65 #include "wx/dcbuffer.h"
67 // Two pics for the expand / collapse buttons.
68 // Files are not supplied with this project (since it is
69 // recommended to use either custom or native rendering).
70 // If you want them, get wxTreeMultiCtrl by Jorgen Bodde,
71 // and copy xpm files from archive to wxPropertyGrid src directory
72 // (and also comment/undef wxPG_ICON_WIDTH in propGrid.h
73 // and set wxPG_USE_RENDERER_NATIVE to 0).
74 #ifndef wxPG_ICON_WIDTH
75 #if defined(__WXMAC__)
76 #include "mac_collapse.xpm"
77 #include "mac_expand.xpm"
78 #elif defined(__WXGTK__)
79 #include "linux_collapse.xpm"
80 #include "linux_expand.xpm"
82 #include "default_collapse.xpm"
83 #include "default_expand.xpm"
88 //#define wxPG_TEXT_INDENT 4 // For the wxComboControl
89 //#define wxPG_ALLOW_CLIPPING 1 // If 1, GetUpdateRegion() in OnPaint event handler is not ignored
90 #define wxPG_GUTTER_DIV 3 // gutter is max(iconwidth/gutter_div,gutter_min)
91 #define wxPG_GUTTER_MIN 3 // gutter before and after image of [+] or [-]
92 #define wxPG_YSPACING_MIN 1
93 #define wxPG_DEFAULT_VSPACING 2 // This matches .NET propertygrid's value,
94 // but causes normal combobox to spill out under MSW
96 //#define wxPG_OPTIMAL_WIDTH 200 // Arbitrary
98 //#define wxPG_MIN_SCROLLBAR_WIDTH 10 // Smallest scrollbar width on any platform
99 // Must be larger than largest control border
103 #define wxPG_DEFAULT_CURSOR wxNullCursor
106 //#define wxPG_NAT_CHOICE_BORDER_ANY 0
108 //#define wxPG_HIDER_BUTTON_HEIGHT 25
110 #define wxPG_PIXELS_PER_UNIT m_lineHeight
112 #ifdef wxPG_ICON_WIDTH
113 #define m_iconHeight m_iconWidth
116 //#define wxPG_TOOLTIP_DELAY 1000
118 // This is the number of pixels the expander button inside
119 // property cells (i.e. not in the grey margin area are
121 #define IN_CELL_EXPANDER_BUTTON_X_ADJUST 2
123 // -----------------------------------------------------------------------
126 void wxPropertyGrid::AutoGetTranslation ( bool enable
)
128 wxPGGlobalVars
->m_autoGetTranslation
= enable
;
131 void wxPropertyGrid::AutoGetTranslation ( bool ) { }
134 // -----------------------------------------------------------------------
136 const char wxPropertyGridNameStr
[] = "wxPropertyGrid";
138 // -----------------------------------------------------------------------
139 // Statics in one class for easy destruction.
140 // -----------------------------------------------------------------------
142 #include "wx/module.h"
144 class wxPGGlobalVarsClassManager
: public wxModule
146 DECLARE_DYNAMIC_CLASS(wxPGGlobalVarsClassManager
)
148 wxPGGlobalVarsClassManager() {}
149 virtual bool OnInit() { wxPGGlobalVars
= new wxPGGlobalVarsClass(); return true; }
150 virtual void OnExit() { delete wxPGGlobalVars
; wxPGGlobalVars
= NULL
; }
153 IMPLEMENT_DYNAMIC_CLASS(wxPGGlobalVarsClassManager
, wxModule
)
156 // When wxPG is loaded dynamically after the application is already running
157 // then the built-in module system won't pick this one up. Add it manually.
158 void wxPGInitResourceModule()
160 wxModule
* module = new wxPGGlobalVarsClassManager
;
162 wxModule::RegisterModule(module);
165 wxPGGlobalVarsClass
* wxPGGlobalVars
= NULL
;
168 wxPGGlobalVarsClass::wxPGGlobalVarsClass()
170 wxPGProperty::sm_wxPG_LABEL
= new wxString(wxPG_LABEL_STRING
);
172 m_boolChoices
.Add(_("False"));
173 m_boolChoices
.Add(_("True"));
175 m_fontFamilyChoices
= NULL
;
177 m_defaultRenderer
= new wxPGDefaultRenderer();
179 m_autoGetTranslation
= false;
187 // Prepare some shared variants
188 m_vEmptyString
= wxString();
190 m_vMinusOne
= (long) -1;
194 // Prepare cached string constants
195 m_strstring
= wxS("string");
196 m_strlong
= wxS("long");
197 m_strbool
= wxS("bool");
198 m_strlist
= wxS("list");
199 m_strDefaultValue
= wxS("DefaultValue");
200 m_strMin
= wxS("Min");
201 m_strMax
= wxS("Max");
202 m_strUnits
= wxS("Units");
203 m_strInlineHelp
= wxS("InlineHelp");
209 wxPGGlobalVarsClass::~wxPGGlobalVarsClass()
213 delete m_defaultRenderer
;
215 // This will always have one ref
216 delete m_fontFamilyChoices
;
219 for ( i
=0; i
<m_arrValidators
.size(); i
++ )
220 delete ((wxValidator
*)m_arrValidators
[i
]);
224 // Destroy value type class instances.
225 wxPGHashMapS2P::iterator vt_it
;
227 // Destroy editor class instances.
228 // iterate over all the elements in the class
229 for( vt_it
= m_mapEditorClasses
.begin(); vt_it
!= m_mapEditorClasses
.end(); ++vt_it
)
231 delete ((wxPGEditor
*)vt_it
->second
);
234 delete wxPGProperty::sm_wxPG_LABEL
;
237 void wxPropertyGridInitGlobalsIfNeeded()
241 // -----------------------------------------------------------------------
243 // -----------------------------------------------------------------------
245 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGrid
, wxScrolledWindow
)
247 BEGIN_EVENT_TABLE(wxPropertyGrid
, wxScrolledWindow
)
248 EVT_IDLE(wxPropertyGrid::OnIdle
)
249 EVT_PAINT(wxPropertyGrid::OnPaint
)
250 EVT_SIZE(wxPropertyGrid::OnResize
)
251 EVT_ENTER_WINDOW(wxPropertyGrid::OnMouseEntry
)
252 EVT_LEAVE_WINDOW(wxPropertyGrid::OnMouseEntry
)
253 EVT_MOUSE_CAPTURE_CHANGED(wxPropertyGrid::OnCaptureChange
)
254 EVT_SCROLLWIN(wxPropertyGrid::OnScrollEvent
)
255 EVT_CHILD_FOCUS(wxPropertyGrid::OnChildFocusEvent
)
256 EVT_SET_FOCUS(wxPropertyGrid::OnFocusEvent
)
257 EVT_KILL_FOCUS(wxPropertyGrid::OnFocusEvent
)
258 EVT_SYS_COLOUR_CHANGED(wxPropertyGrid::OnSysColourChanged
)
259 EVT_MOTION(wxPropertyGrid::OnMouseMove
)
260 EVT_LEFT_DOWN(wxPropertyGrid::OnMouseClick
)
261 EVT_LEFT_UP(wxPropertyGrid::OnMouseUp
)
262 EVT_RIGHT_UP(wxPropertyGrid::OnMouseRightClick
)
263 EVT_LEFT_DCLICK(wxPropertyGrid::OnMouseDoubleClick
)
264 EVT_KEY_DOWN(wxPropertyGrid::OnKey
)
267 // -----------------------------------------------------------------------
269 wxPropertyGrid::wxPropertyGrid()
275 // -----------------------------------------------------------------------
277 wxPropertyGrid::wxPropertyGrid( wxWindow
*parent
,
282 const wxString
& name
)
286 Create(parent
,id
,pos
,size
,style
,name
);
289 // -----------------------------------------------------------------------
291 bool wxPropertyGrid::Create( wxWindow
*parent
,
296 const wxString
& name
)
299 if (!(style
&wxBORDER_MASK
))
301 style
|= wxBORDER_THEME
;
306 // Filter out wxTAB_TRAVERSAL - we will handle TABs manually
307 style
&= ~(wxTAB_TRAVERSAL
);
308 style
|= wxWANTS_CHARS
;
310 wxScrolledWindow::Create(parent
,id
,pos
,size
,style
,name
);
317 // -----------------------------------------------------------------------
320 // Initialize values to defaults
322 void wxPropertyGrid::Init1()
324 // Register editor classes, if necessary.
325 if ( wxPGGlobalVars
->m_mapEditorClasses
.empty() )
326 wxPropertyGrid::RegisterDefaultEditors();
330 m_wndEditor
= m_wndEditor2
= NULL
;
334 m_labelEditor
= NULL
;
335 m_labelEditorProperty
= NULL
;
336 m_eventObject
= this;
338 m_processedEvent
= NULL
;
339 m_sortFunction
= NULL
;
340 m_inDoPropertyChanged
= 0;
341 m_inCommitChangesFromEditor
= 0;
342 m_inDoSelectProperty
= 0;
343 m_permanentValidationFailureBehavior
= wxPG_VFB_DEFAULT
;
349 AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY
, WXK_RIGHT
);
350 AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY
, WXK_DOWN
);
351 AddActionTrigger( wxPG_ACTION_PREV_PROPERTY
, WXK_LEFT
);
352 AddActionTrigger( wxPG_ACTION_PREV_PROPERTY
, WXK_UP
);
353 AddActionTrigger( wxPG_ACTION_EXPAND_PROPERTY
, WXK_RIGHT
);
354 AddActionTrigger( wxPG_ACTION_COLLAPSE_PROPERTY
, WXK_LEFT
);
355 AddActionTrigger( wxPG_ACTION_CANCEL_EDIT
, WXK_ESCAPE
);
356 AddActionTrigger( wxPG_ACTION_PRESS_BUTTON
, WXK_DOWN
, wxMOD_ALT
);
357 AddActionTrigger( wxPG_ACTION_PRESS_BUTTON
, WXK_F4
);
359 m_coloursCustomized
= 0;
362 #if wxPG_DOUBLE_BUFFER
363 m_doubleBuffer
= NULL
;
366 #ifndef wxPG_ICON_WIDTH
372 m_iconWidth
= wxPG_ICON_WIDTH
;
377 m_gutterWidth
= wxPG_GUTTER_MIN
;
378 m_subgroup_extramargin
= 10;
382 m_width
= m_height
= 0;
384 m_commonValues
.push_back(new wxPGCommonValue(_("Unspecified"), wxPGGlobalVars
->m_defaultRenderer
) );
387 m_chgInfo_changedProperty
= NULL
;
390 // -----------------------------------------------------------------------
393 // Initialize after parent etc. set
395 void wxPropertyGrid::Init2()
397 wxASSERT( !(m_iFlags
& wxPG_FL_INITIALIZED
) );
400 // Smaller controls on Mac
401 SetWindowVariant(wxWINDOW_VARIANT_SMALL
);
404 // Now create state, if one didn't exist already
405 // (wxPropertyGridManager might have created it for us).
408 m_pState
= CreateState();
409 m_pState
->m_pPropGrid
= this;
410 m_iFlags
|= wxPG_FL_CREATEDSTATE
;
413 if ( !(m_windowStyle
& wxPG_SPLITTER_AUTO_CENTER
) )
414 m_pState
->m_dontCenterSplitter
= true;
416 if ( m_windowStyle
& wxPG_HIDE_CATEGORIES
)
418 m_pState
->InitNonCatMode();
420 m_pState
->m_properties
= m_pState
->m_abcArray
;
423 GetClientSize(&m_width
,&m_height
);
425 #ifndef wxPG_ICON_WIDTH
426 // create two bitmap nodes for drawing
427 m_expandbmp
= new wxBitmap(expand_xpm
);
428 m_collbmp
= new wxBitmap(collapse_xpm
);
430 // calculate average font height for bitmap centering
432 m_iconWidth
= m_expandbmp
->GetWidth();
433 m_iconHeight
= m_expandbmp
->GetHeight();
436 m_curcursor
= wxCURSOR_ARROW
;
437 m_cursorSizeWE
= new wxCursor( wxCURSOR_SIZEWE
);
439 // adjust bitmap icon y position so they are centered
440 m_vspacing
= wxPG_DEFAULT_VSPACING
;
442 CalculateFontAndBitmapStuff( wxPG_DEFAULT_VSPACING
);
444 // Allocate cell datas indirectly by calling setter
445 m_propertyDefaultCell
.SetBgCol(*wxBLACK
);
446 m_categoryDefaultCell
.SetBgCol(*wxBLACK
);
450 // This helps with flicker
451 SetBackgroundStyle( wxBG_STYLE_CUSTOM
);
453 // Hook the top-level parent
458 // set virtual size to this window size
459 wxSize wndsize
= GetSize();
460 SetVirtualSize(wndsize
.GetWidth(), wndsize
.GetWidth());
462 m_timeCreated
= ::wxGetLocalTimeMillis();
464 //m_canvas->Create(this, wxID_ANY, wxPoint(0, 0), GetClientSize(),
465 // wxWANTS_CHARS | wxCLIP_CHILDREN);
466 SetBackgroundStyle( wxBG_STYLE_CUSTOM
);
468 m_iFlags
|= wxPG_FL_INITIALIZED
;
470 m_ncWidth
= wndsize
.GetWidth();
472 // Need to call OnResize handler or size given in constructor/Create
474 wxSizeEvent
sizeEvent(wndsize
,0);
478 // -----------------------------------------------------------------------
480 wxPropertyGrid::~wxPropertyGrid()
485 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
489 // Remove grid and property pointers from live wxPropertyGridEvents.
490 for ( i
=0; i
<m_liveEvents
.size(); i
++ )
492 wxPropertyGridEvent
* evt
= m_liveEvents
[i
];
493 evt
->SetPropertyGrid(NULL
);
494 evt
->SetProperty(NULL
);
496 m_liveEvents
.clear();
498 if ( m_processedEvent
)
500 // All right... we are being deleted while wxPropertyGrid event
501 // is being sent. Make sure that event propagates as little
502 // as possible (although usually this is not enough to prevent
504 m_processedEvent
->Skip(false);
505 m_processedEvent
->StopPropagation();
507 // Let's use wxMessageBox to make the message appear more
508 // reliably (and *before* the crash can happen).
509 ::wxMessageBox("wxPropertyGrid was being destroyed in an event "
510 "generated by it. This usually leads to a crash "
511 "so it is recommended to destroy the control "
512 "at idle time instead.");
515 DoSelectProperty(NULL
, wxPG_SEL_NOVALIDATE
|wxPG_SEL_DONT_SEND_EVENT
);
517 // This should do prevent things from going too badly wrong
518 m_iFlags
&= ~(wxPG_FL_INITIALIZED
);
520 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
523 // Call with NULL to disconnect event handling
524 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING
)
528 wxASSERT_MSG( !IsEditorsValueModified(),
529 wxS("Most recent change in property editor was ")
530 wxS("lost!!! (if you don't want this to happen, ")
531 wxS("close your frames and dialogs using ")
532 wxS("Close(false).)") );
535 #if wxPG_DOUBLE_BUFFER
536 if ( m_doubleBuffer
)
537 delete m_doubleBuffer
;
540 if ( m_iFlags
& wxPG_FL_CREATEDSTATE
)
543 delete m_cursorSizeWE
;
545 #ifndef wxPG_ICON_WIDTH
550 // Delete common value records
551 for ( i
=0; i
<m_commonValues
.size(); i
++ )
553 // Use temporary variable to work around possible strange VC6 (asserts because m_size is zero)
554 wxPGCommonValue
* value
= m_commonValues
[i
];
559 // -----------------------------------------------------------------------
561 bool wxPropertyGrid::Destroy()
563 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
566 return wxScrolledWindow::Destroy();
569 // -----------------------------------------------------------------------
571 wxPropertyGridPageState
* wxPropertyGrid::CreateState() const
573 return new wxPropertyGridPageState();
576 // -----------------------------------------------------------------------
577 // wxPropertyGrid overridden wxWindow methods
578 // -----------------------------------------------------------------------
580 void wxPropertyGrid::SetWindowStyleFlag( long style
)
582 long old_style
= m_windowStyle
;
584 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
586 wxASSERT( m_pState
);
588 if ( !(style
& wxPG_HIDE_CATEGORIES
) && (old_style
& wxPG_HIDE_CATEGORIES
) )
591 EnableCategories( true );
593 else if ( (style
& wxPG_HIDE_CATEGORIES
) && !(old_style
& wxPG_HIDE_CATEGORIES
) )
595 // Disable categories
596 EnableCategories( false );
598 if ( !(old_style
& wxPG_AUTO_SORT
) && (style
& wxPG_AUTO_SORT
) )
604 PrepareAfterItemsAdded();
606 m_pState
->m_itemsAdded
= 1;
608 #if wxPG_SUPPORT_TOOLTIPS
609 if ( !(old_style
& wxPG_TOOLTIPS
) && (style
& wxPG_TOOLTIPS
) )
615 wxToolTip* tooltip = new wxToolTip ( wxEmptyString );
616 SetToolTip ( tooltip );
617 tooltip->SetDelay ( wxPG_TOOLTIP_DELAY );
620 else if ( (old_style
& wxPG_TOOLTIPS
) && !(style
& wxPG_TOOLTIPS
) )
625 wxScrolledWindow::SetToolTip( NULL
);
630 wxScrolledWindow::SetWindowStyleFlag ( style
);
632 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
634 if ( (old_style
& wxPG_HIDE_MARGIN
) != (style
& wxPG_HIDE_MARGIN
) )
636 CalculateFontAndBitmapStuff( m_vspacing
);
642 // -----------------------------------------------------------------------
644 void wxPropertyGrid::Freeze()
648 wxScrolledWindow::Freeze();
653 // -----------------------------------------------------------------------
655 void wxPropertyGrid::Thaw()
661 wxScrolledWindow::Thaw();
662 RecalculateVirtualSize();
663 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
667 // Force property re-selection
668 // NB: We must copy the selection.
669 wxArrayPGProperty selection
= m_pState
->m_selection
;
670 DoSetSelection(selection
, wxPG_SEL_FORCE
| wxPG_SEL_NONVISIBLE
);
674 // -----------------------------------------------------------------------
676 bool wxPropertyGrid::DoAddToSelection( wxPGProperty
* prop
, int selFlags
)
678 wxCHECK( prop
, false );
680 if ( !(GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
) )
681 return DoSelectProperty(prop
, selFlags
);
683 wxArrayPGProperty
& selection
= m_pState
->m_selection
;
685 if ( !selection
.size() )
687 return DoSelectProperty(prop
, selFlags
);
691 // For categories, only one can be selected at a time
692 if ( prop
->IsCategory() || selection
[0]->IsCategory() )
695 selection
.push_back(prop
);
697 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
699 SendEvent( wxEVT_PG_SELECTED
, prop
, NULL
);
708 // -----------------------------------------------------------------------
710 bool wxPropertyGrid::DoRemoveFromSelection( wxPGProperty
* prop
, int selFlags
)
712 wxCHECK( prop
, false );
715 wxArrayPGProperty
& selection
= m_pState
->m_selection
;
716 if ( selection
.size() <= 1 )
718 res
= DoSelectProperty(NULL
, selFlags
);
722 m_pState
->DoRemoveFromSelection(prop
);
730 // -----------------------------------------------------------------------
732 bool wxPropertyGrid::DoSelectAndEdit( wxPGProperty
* prop
,
733 unsigned int colIndex
,
734 unsigned int selFlags
)
737 // NB: Enable following if label editor background colour is
738 // ever changed to any other than m_colSelBack.
740 // We use this workaround to prevent visible flicker when editing
741 // a cell. Atleast on wxMSW, there is a difficult to find
742 // (and perhaps prevent) redraw somewhere between making property
743 // selected and enabling label editing.
745 //wxColour prevColSelBack = m_colSelBack;
746 //m_colSelBack = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
752 res
= DoSelectProperty(prop
, selFlags
);
757 DoClearSelection(false, wxPG_SEL_NO_REFRESH
);
759 if ( m_pState
->m_editableColumns
.Index(colIndex
) == wxNOT_FOUND
)
761 res
= DoAddToSelection(prop
, selFlags
);
765 res
= DoAddToSelection(prop
, selFlags
|wxPG_SEL_NO_REFRESH
);
767 DoBeginLabelEdit(colIndex
, selFlags
);
771 //m_colSelBack = prevColSelBack;
775 // -----------------------------------------------------------------------
777 bool wxPropertyGrid::AddToSelectionFromInputEvent( wxPGProperty
* prop
,
778 unsigned int colIndex
,
779 wxMouseEvent
* mouseEvent
,
782 bool alreadySelected
= m_pState
->DoIsPropertySelected(prop
);
784 bool addToExistingSelection
;
786 if ( GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
)
790 if ( mouseEvent
->GetEventType() == wxEVT_RIGHT_DOWN
||
791 mouseEvent
->GetEventType() == wxEVT_RIGHT_UP
)
793 // Allow right-click for context menu without
794 // disturbing the selection.
795 if ( GetSelectedProperties().size() <= 1 ||
797 return DoSelectAndEdit(prop
, colIndex
, selFlags
);
802 addToExistingSelection
= mouseEvent
->ShiftDown();
807 addToExistingSelection
= false;
812 addToExistingSelection
= false;
815 if ( addToExistingSelection
)
817 if ( !alreadySelected
)
819 res
= DoAddToSelection(prop
, selFlags
);
821 else if ( GetSelectedProperties().size() > 1 )
823 res
= DoRemoveFromSelection(prop
, selFlags
);
828 res
= DoSelectAndEdit(prop
, colIndex
, selFlags
);
834 // -----------------------------------------------------------------------
836 void wxPropertyGrid::DoSetSelection( const wxArrayPGProperty
& newSelection
,
839 if ( newSelection
.size() > 0 )
841 if ( !DoSelectProperty(newSelection
[0], selFlags
) )
846 DoClearSelection(false, selFlags
);
849 for ( unsigned int i
= 1; i
< newSelection
.size(); i
++ )
851 DoAddToSelection(newSelection
[i
], selFlags
);
857 // -----------------------------------------------------------------------
859 void wxPropertyGrid::MakeColumnEditable( unsigned int column
,
862 wxASSERT( column
!= 1 );
864 wxArrayInt
& cols
= m_pState
->m_editableColumns
;
868 cols
.push_back(column
);
872 for ( int i
= cols
.size() - 1; i
> 0; i
-- )
874 if ( cols
[i
] == (int)column
)
875 cols
.erase( cols
.begin() + i
);
880 // -----------------------------------------------------------------------
882 void wxPropertyGrid::DoBeginLabelEdit( unsigned int colIndex
,
885 wxPGProperty
* selected
= GetSelection();
886 wxCHECK_RET(selected
, wxT("No property selected"));
887 wxCHECK_RET(colIndex
!= 1, wxT("Do not use this for column 1"));
889 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
891 if ( SendEvent( wxEVT_PG_LABEL_EDIT_BEGIN
,
898 const wxPGCell
* cell
= NULL
;
899 if ( selected
->HasCell(colIndex
) )
901 cell
= &selected
->GetCell(colIndex
);
902 if ( !cell
->HasText() && colIndex
== 0 )
903 text
= selected
->GetLabel();
909 text
= selected
->GetLabel();
911 cell
= &selected
->GetOrCreateCell(colIndex
);
914 if ( cell
&& cell
->HasText() )
915 text
= cell
->GetText();
917 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
); // send event
919 m_selColumn
= colIndex
;
921 wxRect r
= GetEditorWidgetRect(selected
, m_selColumn
);
923 wxWindow
* tc
= GenerateEditorTextCtrl(r
.GetPosition(),
931 wxWindowID id
= tc
->GetId();
932 tc
->Connect(id
, wxEVT_COMMAND_TEXT_ENTER
,
933 wxCommandEventHandler(wxPropertyGrid::OnLabelEditorEnterPress
),
935 tc
->Connect(id
, wxEVT_KEY_DOWN
,
936 wxKeyEventHandler(wxPropertyGrid::OnLabelEditorKeyPress
),
941 m_labelEditor
= wxStaticCast(tc
, wxTextCtrl
);
942 m_labelEditorProperty
= selected
;
945 // -----------------------------------------------------------------------
948 wxPropertyGrid::OnLabelEditorEnterPress( wxCommandEvent
& WXUNUSED(event
) )
950 DoEndLabelEdit(true);
953 // -----------------------------------------------------------------------
955 void wxPropertyGrid::OnLabelEditorKeyPress( wxKeyEvent
& event
)
957 int keycode
= event
.GetKeyCode();
959 if ( keycode
== WXK_ESCAPE
)
961 DoEndLabelEdit(false);
969 // -----------------------------------------------------------------------
971 void wxPropertyGrid::DoEndLabelEdit( bool commit
, int selFlags
)
973 if ( !m_labelEditor
)
976 wxPGProperty
* prop
= m_labelEditorProperty
;
981 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
983 // wxPG_SEL_NOVALIDATE is passed correctly in selFlags
984 if ( SendEvent( wxEVT_PG_LABEL_EDIT_ENDING
,
985 prop
, NULL
, selFlags
,
990 wxString text
= m_labelEditor
->GetValue();
991 wxPGCell
* cell
= NULL
;
992 if ( prop
->HasCell(m_selColumn
) )
994 cell
= &prop
->GetCell(m_selColumn
);
998 if ( m_selColumn
== 0 )
999 prop
->SetLabel(text
);
1001 cell
= &prop
->GetOrCreateCell(m_selColumn
);
1005 cell
->SetText(text
);
1010 DestroyEditorWnd(m_labelEditor
);
1011 m_labelEditor
= NULL
;
1012 m_labelEditorProperty
= NULL
;
1017 // -----------------------------------------------------------------------
1019 void wxPropertyGrid::SetExtraStyle( long exStyle
)
1021 if ( exStyle
& wxPG_EX_ENABLE_TLP_TRACKING
)
1022 OnTLPChanging(::wxGetTopLevelParent(this));
1024 OnTLPChanging(NULL
);
1026 if ( exStyle
& wxPG_EX_NATIVE_DOUBLE_BUFFERING
)
1028 #if defined(__WXMSW__)
1031 // Don't use WS_EX_COMPOSITED just now.
1034 if ( m_iFlags & wxPG_FL_IN_MANAGER )
1035 hWnd = (HWND)GetParent()->GetHWND();
1037 hWnd = (HWND)GetHWND();
1039 ::SetWindowLong( hWnd, GWL_EXSTYLE,
1040 ::GetWindowLong(hWnd, GWL_EXSTYLE) | WS_EX_COMPOSITED );
1043 //#elif defined(__WXGTK20__)
1045 // Only apply wxPG_EX_NATIVE_DOUBLE_BUFFERING if the window
1046 // truly was double-buffered.
1047 if ( !this->IsDoubleBuffered() )
1049 exStyle
&= ~(wxPG_EX_NATIVE_DOUBLE_BUFFERING
);
1053 #if wxPG_DOUBLE_BUFFER
1054 delete m_doubleBuffer
;
1055 m_doubleBuffer
= NULL
;
1060 wxScrolledWindow::SetExtraStyle( exStyle
);
1062 if ( exStyle
& wxPG_EX_INIT_NOCAT
)
1063 m_pState
->InitNonCatMode();
1065 if ( exStyle
& wxPG_EX_HELP_AS_TOOLTIPS
)
1066 m_windowStyle
|= wxPG_TOOLTIPS
;
1069 wxPGGlobalVars
->m_extraStyle
= exStyle
;
1072 // -----------------------------------------------------------------------
1074 // returns the best acceptable minimal size
1075 wxSize
wxPropertyGrid::DoGetBestSize() const
1077 int lineHeight
= wxMax(15, m_lineHeight
);
1079 // don't make the grid too tall (limit height to 10 items) but don't
1080 // make it too small neither
1081 int numLines
= wxMin
1083 wxMax(m_pState
->m_properties
->GetChildCount(), 3),
1087 wxClientDC
dc(const_cast<wxPropertyGrid
*>(this));
1088 int width
= m_marginWidth
;
1089 for ( unsigned int i
= 0; i
< m_pState
->m_colWidths
.size(); i
++ )
1091 width
+= m_pState
->GetColumnFitWidth(dc
, m_pState
->DoGetRoot(), i
, true);
1094 const wxSize sz
= wxSize(width
, lineHeight
*numLines
+ 40);
1100 // -----------------------------------------------------------------------
1102 void wxPropertyGrid::OnTLPChanging( wxWindow
* newTLP
)
1104 if ( newTLP
== m_tlp
)
1107 wxLongLong currentTime
= ::wxGetLocalTimeMillis();
1110 // Parent changed so let's redetermine and re-hook the
1111 // correct top-level window.
1114 m_tlp
->Disconnect( wxEVT_CLOSE_WINDOW
,
1115 wxCloseEventHandler(wxPropertyGrid::OnTLPClose
),
1117 m_tlpClosed
= m_tlp
;
1118 m_tlpClosedTime
= currentTime
;
1123 // Only accept new tlp if same one was not just dismissed.
1124 if ( newTLP
!= m_tlpClosed
||
1125 m_tlpClosedTime
+250 < currentTime
)
1127 newTLP
->Connect( wxEVT_CLOSE_WINDOW
,
1128 wxCloseEventHandler(wxPropertyGrid::OnTLPClose
),
1141 // -----------------------------------------------------------------------
1143 void wxPropertyGrid::OnTLPClose( wxCloseEvent
& event
)
1145 // ClearSelection forces value validation/commit.
1146 if ( event
.CanVeto() && !DoClearSelection() )
1152 // Ok, it can close, set tlp pointer to NULL. Some other event
1153 // handler can of course veto the close, but our OnIdle() should
1154 // then be able to regain the tlp pointer.
1155 OnTLPChanging(NULL
);
1160 // -----------------------------------------------------------------------
1162 bool wxPropertyGrid::Reparent( wxWindowBase
*newParent
)
1164 OnTLPChanging((wxWindow
*)newParent
);
1166 bool res
= wxScrolledWindow::Reparent(newParent
);
1171 // -----------------------------------------------------------------------
1172 // wxPropertyGrid Font and Colour Methods
1173 // -----------------------------------------------------------------------
1175 void wxPropertyGrid::CalculateFontAndBitmapStuff( int vspacing
)
1179 m_captionFont
= wxScrolledWindow::GetFont();
1181 GetTextExtent(wxS("jG"), &x
, &y
, 0, 0, &m_captionFont
);
1182 m_subgroup_extramargin
= x
+ (x
/2);
1185 #if wxPG_USE_RENDERER_NATIVE
1186 m_iconWidth
= wxPG_ICON_WIDTH
;
1187 #elif wxPG_ICON_WIDTH
1189 m_iconWidth
= (m_fontHeight
* wxPG_ICON_WIDTH
) / 13;
1190 if ( m_iconWidth
< 5 ) m_iconWidth
= 5;
1191 else if ( !(m_iconWidth
& 0x01) ) m_iconWidth
++; // must be odd
1195 m_gutterWidth
= m_iconWidth
/ wxPG_GUTTER_DIV
;
1196 if ( m_gutterWidth
< wxPG_GUTTER_MIN
)
1197 m_gutterWidth
= wxPG_GUTTER_MIN
;
1200 if ( vspacing
<= 1 ) vdiv
= 12;
1201 else if ( vspacing
>= 3 ) vdiv
= 3;
1203 m_spacingy
= m_fontHeight
/ vdiv
;
1204 if ( m_spacingy
< wxPG_YSPACING_MIN
)
1205 m_spacingy
= wxPG_YSPACING_MIN
;
1208 if ( !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
1209 m_marginWidth
= m_gutterWidth
*2 + m_iconWidth
;
1211 m_captionFont
.SetWeight(wxBOLD
);
1212 GetTextExtent(wxS("jG"), &x
, &y
, 0, 0, &m_captionFont
);
1214 m_lineHeight
= m_fontHeight
+(2*m_spacingy
)+1;
1217 m_buttonSpacingY
= (m_lineHeight
- m_iconHeight
) / 2;
1218 if ( m_buttonSpacingY
< 0 ) m_buttonSpacingY
= 0;
1221 m_pState
->CalculateFontAndBitmapStuff(vspacing
);
1223 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
1224 RecalculateVirtualSize();
1226 InvalidateBestSize();
1229 // -----------------------------------------------------------------------
1231 void wxPropertyGrid::OnSysColourChanged( wxSysColourChangedEvent
&WXUNUSED(event
) )
1237 // -----------------------------------------------------------------------
1239 static wxColour
wxPGAdjustColour(const wxColour
& src
, int ra
,
1240 int ga
= 1000, int ba
= 1000,
1241 bool forceDifferent
= false)
1248 // Recursion guard (allow 2 max)
1249 static int isinside
= 0;
1251 wxCHECK_MSG( isinside
< 3,
1253 wxT("wxPGAdjustColour should not be recursively called more than once") );
1258 int g
= src
.Green();
1261 if ( r2
>255 ) r2
= 255;
1262 else if ( r2
<0) r2
= 0;
1264 if ( g2
>255 ) g2
= 255;
1265 else if ( g2
<0) g2
= 0;
1267 if ( b2
>255 ) b2
= 255;
1268 else if ( b2
<0) b2
= 0;
1270 // Make sure they are somewhat different
1271 if ( forceDifferent
&& (abs((r
+g
+b
)-(r2
+g2
+b2
)) < abs(ra
/2)) )
1272 dst
= wxPGAdjustColour(src
,-(ra
*2));
1274 dst
= wxColour(r2
,g2
,b2
);
1276 // Recursion guard (allow 2 max)
1283 static int wxPGGetColAvg( const wxColour
& col
)
1285 return (col
.Red() + col
.Green() + col
.Blue()) / 3;
1289 void wxPropertyGrid::RegainColours()
1291 if ( !(m_coloursCustomized
& 0x0002) )
1293 wxColour col
= wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE
);
1295 // Make sure colour is dark enough
1297 int colDec
= wxPGGetColAvg(col
) - 230;
1299 int colDec
= wxPGGetColAvg(col
) - 200;
1302 m_colCapBack
= wxPGAdjustColour(col
,-colDec
);
1305 m_categoryDefaultCell
.GetData()->SetBgCol(m_colCapBack
);
1308 if ( !(m_coloursCustomized
& 0x0001) )
1309 m_colMargin
= m_colCapBack
;
1311 if ( !(m_coloursCustomized
& 0x0004) )
1318 wxColour capForeCol
= wxPGAdjustColour(m_colCapBack
,colDec
,5000,5000,true);
1319 m_colCapFore
= capForeCol
;
1320 m_categoryDefaultCell
.GetData()->SetFgCol(capForeCol
);
1323 if ( !(m_coloursCustomized
& 0x0008) )
1325 wxColour bgCol
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW
);
1326 m_colPropBack
= bgCol
;
1327 m_propertyDefaultCell
.GetData()->SetBgCol(bgCol
);
1330 if ( !(m_coloursCustomized
& 0x0010) )
1332 wxColour fgCol
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT
);
1333 m_colPropFore
= fgCol
;
1334 m_propertyDefaultCell
.GetData()->SetFgCol(fgCol
);
1337 if ( !(m_coloursCustomized
& 0x0020) )
1338 m_colSelBack
= wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT
);
1340 if ( !(m_coloursCustomized
& 0x0040) )
1341 m_colSelFore
= wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHTTEXT
);
1343 if ( !(m_coloursCustomized
& 0x0080) )
1344 m_colLine
= m_colCapBack
;
1346 if ( !(m_coloursCustomized
& 0x0100) )
1347 m_colDisPropFore
= m_colCapFore
;
1349 m_colEmptySpace
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW
);
1352 // -----------------------------------------------------------------------
1354 void wxPropertyGrid::ResetColours()
1356 m_coloursCustomized
= 0;
1363 // -----------------------------------------------------------------------
1365 bool wxPropertyGrid::SetFont( const wxFont
& font
)
1367 // Must disable active editor.
1370 bool res
= wxScrolledWindow::SetFont( font
);
1371 if ( res
&& GetParent()) // may not have been Create()ed yet if SetFont called from SetWindowVariant
1373 CalculateFontAndBitmapStuff( m_vspacing
);
1380 // -----------------------------------------------------------------------
1382 void wxPropertyGrid::SetLineColour( const wxColour
& col
)
1385 m_coloursCustomized
|= 0x80;
1389 // -----------------------------------------------------------------------
1391 void wxPropertyGrid::SetMarginColour( const wxColour
& col
)
1394 m_coloursCustomized
|= 0x01;
1398 // -----------------------------------------------------------------------
1400 void wxPropertyGrid::SetCellBackgroundColour( const wxColour
& col
)
1402 m_colPropBack
= col
;
1403 m_coloursCustomized
|= 0x08;
1405 m_propertyDefaultCell
.GetData()->SetBgCol(col
);
1410 // -----------------------------------------------------------------------
1412 void wxPropertyGrid::SetCellTextColour( const wxColour
& col
)
1414 m_colPropFore
= col
;
1415 m_coloursCustomized
|= 0x10;
1417 m_propertyDefaultCell
.GetData()->SetFgCol(col
);
1422 // -----------------------------------------------------------------------
1424 void wxPropertyGrid::SetEmptySpaceColour( const wxColour
& col
)
1426 m_colEmptySpace
= col
;
1431 // -----------------------------------------------------------------------
1433 void wxPropertyGrid::SetCellDisabledTextColour( const wxColour
& col
)
1435 m_colDisPropFore
= col
;
1436 m_coloursCustomized
|= 0x100;
1440 // -----------------------------------------------------------------------
1442 void wxPropertyGrid::SetSelectionBackgroundColour( const wxColour
& col
)
1445 m_coloursCustomized
|= 0x20;
1449 // -----------------------------------------------------------------------
1451 void wxPropertyGrid::SetSelectionTextColour( const wxColour
& col
)
1454 m_coloursCustomized
|= 0x40;
1458 // -----------------------------------------------------------------------
1460 void wxPropertyGrid::SetCaptionBackgroundColour( const wxColour
& col
)
1463 m_coloursCustomized
|= 0x02;
1465 m_categoryDefaultCell
.GetData()->SetBgCol(col
);
1470 // -----------------------------------------------------------------------
1472 void wxPropertyGrid::SetCaptionTextColour( const wxColour
& col
)
1475 m_coloursCustomized
|= 0x04;
1477 m_categoryDefaultCell
.GetData()->SetFgCol(col
);
1482 // -----------------------------------------------------------------------
1483 // wxPropertyGrid property adding and removal
1484 // -----------------------------------------------------------------------
1486 void wxPropertyGrid::PrepareAfterItemsAdded()
1488 if ( !m_pState
|| !m_pState
->m_itemsAdded
) return;
1490 m_pState
->m_itemsAdded
= 0;
1492 if ( m_windowStyle
& wxPG_AUTO_SORT
)
1493 Sort(wxPG_SORT_TOP_LEVEL_ONLY
);
1495 RecalculateVirtualSize();
1498 // -----------------------------------------------------------------------
1499 // wxPropertyGrid property operations
1500 // -----------------------------------------------------------------------
1502 bool wxPropertyGrid::EnsureVisible( wxPGPropArg id
)
1504 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
1508 bool changed
= false;
1510 // Is it inside collapsed section?
1511 if ( !p
->IsVisible() )
1514 wxPGProperty
* parent
= p
->GetParent();
1515 wxPGProperty
* grandparent
= parent
->GetParent();
1517 if ( grandparent
&& grandparent
!= m_pState
->m_properties
)
1518 Expand( grandparent
);
1526 GetViewStart(&vx
,&vy
);
1527 vy
*=wxPG_PIXELS_PER_UNIT
;
1533 Scroll(vx
, y
/wxPG_PIXELS_PER_UNIT
);
1534 m_iFlags
|= wxPG_FL_SCROLLED
;
1537 else if ( (y
+m_lineHeight
) > (vy
+m_height
) )
1539 Scroll(vx
, (y
-m_height
+(m_lineHeight
*2))/wxPG_PIXELS_PER_UNIT
);
1540 m_iFlags
|= wxPG_FL_SCROLLED
;
1550 // -----------------------------------------------------------------------
1551 // wxPropertyGrid helper methods called by properties
1552 // -----------------------------------------------------------------------
1554 // Control font changer helper.
1555 void wxPropertyGrid::SetCurControlBoldFont()
1557 wxASSERT( m_wndEditor
);
1558 m_wndEditor
->SetFont( m_captionFont
);
1561 // -----------------------------------------------------------------------
1563 wxPoint
wxPropertyGrid::GetGoodEditorDialogPosition( wxPGProperty
* p
,
1566 #if wxPG_SMALL_SCREEN
1567 // On small-screen devices, always show dialogs with default position and size.
1568 return wxDefaultPosition
;
1570 int splitterX
= GetSplitterPosition();
1574 wxCHECK_MSG( y
>= 0, wxPoint(-1,-1), wxT("invalid y?") );
1576 ImprovedClientToScreen( &x
, &y
);
1578 int sw
= wxSystemSettings::GetMetric( ::wxSYS_SCREEN_X
);
1579 int sh
= wxSystemSettings::GetMetric( ::wxSYS_SCREEN_Y
);
1586 new_x
= x
+ (m_width
-splitterX
) - sz
.x
;
1596 new_y
= y
+ m_lineHeight
;
1598 return wxPoint(new_x
,new_y
);
1602 // -----------------------------------------------------------------------
1604 wxString
& wxPropertyGrid::ExpandEscapeSequences( wxString
& dst_str
, wxString
& src_str
)
1606 if ( src_str
.length() == 0 )
1612 bool prev_is_slash
= false;
1614 wxString::const_iterator i
= src_str
.begin();
1618 for ( ; i
!= src_str
.end(); ++i
)
1622 if ( a
!= wxS('\\') )
1624 if ( !prev_is_slash
)
1630 if ( a
== wxS('n') )
1633 dst_str
<< wxS('\n');
1635 dst_str
<< wxS('\n');
1638 else if ( a
== wxS('t') )
1639 dst_str
<< wxS('\t');
1643 prev_is_slash
= false;
1647 if ( prev_is_slash
)
1649 dst_str
<< wxS('\\');
1650 prev_is_slash
= false;
1654 prev_is_slash
= true;
1661 // -----------------------------------------------------------------------
1663 wxString
& wxPropertyGrid::CreateEscapeSequences( wxString
& dst_str
, wxString
& src_str
)
1665 if ( src_str
.length() == 0 )
1671 wxString::const_iterator i
= src_str
.begin();
1672 wxUniChar prev_a
= wxS('\0');
1676 for ( ; i
!= src_str
.end(); ++i
)
1680 if ( a
>= wxS(' ') )
1682 // This surely is not something that requires an escape sequence.
1687 // This might need...
1688 if ( a
== wxS('\r') )
1690 // DOS style line end.
1691 // Already taken care below
1693 else if ( a
== wxS('\n') )
1694 // UNIX style line end.
1695 dst_str
<< wxS("\\n");
1696 else if ( a
== wxS('\t') )
1698 dst_str
<< wxS('\t');
1701 //wxLogDebug(wxT("WARNING: Could not create escape sequence for character #%i"),(int)a);
1711 // -----------------------------------------------------------------------
1713 wxPGProperty
* wxPropertyGrid::DoGetItemAtY( int y
) const
1720 return m_pState
->m_properties
->GetItemAtY(y
, m_lineHeight
, &a
);
1723 // -----------------------------------------------------------------------
1724 // wxPropertyGrid graphics related methods
1725 // -----------------------------------------------------------------------
1727 void wxPropertyGrid::OnPaint( wxPaintEvent
& WXUNUSED(event
) )
1732 // Don't paint after destruction has begun
1733 if ( !HasInternalFlag(wxPG_FL_INITIALIZED
) )
1736 // Find out where the window is scrolled to
1737 int vx
,vy
; // Top left corner of client
1738 GetViewStart(&vx
,&vy
);
1739 vy
*= wxPG_PIXELS_PER_UNIT
;
1741 // Update everything inside the box
1742 wxRect r
= GetUpdateRegion().GetBox();
1746 // FIXME: This is just a workaround for a bug that causes splitters not
1747 // to paint when other windows are being dragged over the grid.
1749 r
.width
= GetClientSize().x
;
1751 // Repaint this rectangle
1752 DrawItems( dc
, r
.y
, r
.y
+ r
.height
, &r
);
1754 // We assume that the size set when grid is shown
1755 // is what is desired.
1756 SetInternalFlag(wxPG_FL_GOOD_SIZE_SET
);
1759 // -----------------------------------------------------------------------
1761 void wxPropertyGrid::DrawExpanderButton( wxDC
& dc
, const wxRect
& rect
,
1762 wxPGProperty
* property
) const
1764 // Prepare rectangle to be used
1766 r
.x
+= m_gutterWidth
; r
.y
+= m_buttonSpacingY
;
1767 r
.width
= m_iconWidth
; r
.height
= m_iconHeight
;
1769 #if (wxPG_USE_RENDERER_NATIVE)
1771 #elif wxPG_ICON_WIDTH
1772 // Drawing expand/collapse button manually
1773 dc
.SetPen(m_colPropFore
);
1774 if ( property
->IsCategory() )
1775 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
1777 dc
.SetBrush(m_colPropBack
);
1779 dc
.DrawRectangle( r
);
1780 int _y
= r
.y
+(m_iconWidth
/2);
1781 dc
.DrawLine(r
.x
+2,_y
,r
.x
+m_iconWidth
-2,_y
);
1786 if ( property
->IsExpanded() )
1788 // wxRenderer functions are non-mutating in nature, so it
1789 // should be safe to cast "const wxPropertyGrid*" to "wxWindow*".
1790 // Hopefully this does not cause problems.
1791 #if (wxPG_USE_RENDERER_NATIVE)
1792 wxRendererNative::Get().DrawTreeItemButton(
1798 #elif wxPG_ICON_WIDTH
1807 #if (wxPG_USE_RENDERER_NATIVE)
1808 wxRendererNative::Get().DrawTreeItemButton(
1814 #elif wxPG_ICON_WIDTH
1815 int _x
= r
.x
+(m_iconWidth
/2);
1816 dc
.DrawLine(_x
,r
.y
+2,_x
,r
.y
+m_iconWidth
-2);
1822 #if (wxPG_USE_RENDERER_NATIVE)
1824 #elif wxPG_ICON_WIDTH
1827 dc
.DrawBitmap( *bmp
, r
.x
, r
.y
, true );
1831 // -----------------------------------------------------------------------
1834 // This is the one called by OnPaint event handler and others.
1835 // topy and bottomy are already unscrolled (ie. physical)
1837 void wxPropertyGrid::DrawItems( wxDC
& dc
,
1838 unsigned int topItemY
,
1839 unsigned int bottomItemY
,
1840 const wxRect
* drawRect
)
1844 bottomItemY
< topItemY
||
1848 m_pState
->EnsureVirtualHeight();
1850 wxRect tempDrawRect
;
1853 tempDrawRect
= wxRect(0, topItemY
,
1856 drawRect
= &tempDrawRect
;
1859 // items added check
1860 if ( m_pState
->m_itemsAdded
) PrepareAfterItemsAdded();
1862 int paintFinishY
= 0;
1864 if ( m_pState
->m_properties
->GetChildCount() > 0 )
1867 bool isBuffered
= false;
1869 #if wxPG_DOUBLE_BUFFER
1870 wxMemoryDC
* bufferDC
= NULL
;
1872 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING
) )
1874 if ( !m_doubleBuffer
)
1876 paintFinishY
= drawRect
->y
;
1881 bufferDC
= new wxMemoryDC();
1883 // If nothing was changed, then just copy from double-buffer
1884 bufferDC
->SelectObject( *m_doubleBuffer
);
1894 dc
.SetClippingRegion( *drawRect
);
1895 paintFinishY
= DoDrawItems( *dcPtr
, drawRect
, isBuffered
);
1896 int drawBottomY
= drawRect
->y
+ drawRect
->height
;
1898 // Clear area beyond last painted property
1899 if ( paintFinishY
< drawBottomY
)
1901 dcPtr
->SetPen(m_colEmptySpace
);
1902 dcPtr
->SetBrush(m_colEmptySpace
);
1903 dcPtr
->DrawRectangle(0, paintFinishY
,
1908 dc
.DestroyClippingRegion();
1911 #if wxPG_DOUBLE_BUFFER
1914 dc
.Blit( drawRect
->x
, drawRect
->y
, drawRect
->width
,
1916 bufferDC
, 0, 0, wxCOPY
);
1923 // Just clear the area
1924 dc
.SetPen(m_colEmptySpace
);
1925 dc
.SetBrush(m_colEmptySpace
);
1926 dc
.DrawRectangle(*drawRect
);
1930 // -----------------------------------------------------------------------
1932 int wxPropertyGrid::DoDrawItems( wxDC
& dc
,
1933 const wxRect
* drawRect
,
1934 bool isBuffered
) const
1936 const wxPGProperty
* firstItem
;
1937 const wxPGProperty
* lastItem
;
1939 firstItem
= DoGetItemAtY(drawRect
->y
);
1940 lastItem
= DoGetItemAtY(drawRect
->y
+drawRect
->height
-1);
1943 lastItem
= GetLastItem( wxPG_ITERATE_VISIBLE
);
1945 if ( m_frozen
|| m_height
< 1 || firstItem
== NULL
)
1948 wxCHECK_MSG( !m_pState
->m_itemsAdded
, drawRect
->y
,
1950 wxASSERT( m_pState
->m_properties
->GetChildCount() );
1952 int lh
= m_lineHeight
;
1955 int lastItemBottomY
;
1957 firstItemTopY
= drawRect
->y
;
1958 lastItemBottomY
= drawRect
->y
+ drawRect
->height
;
1960 // Align y coordinates to item boundaries
1961 firstItemTopY
-= firstItemTopY
% lh
;
1962 lastItemBottomY
+= lh
- (lastItemBottomY
% lh
);
1963 lastItemBottomY
-= 1;
1965 // Entire range outside scrolled, visible area?
1966 if ( firstItemTopY
>= (int)m_pState
->GetVirtualHeight() ||
1967 lastItemBottomY
<= 0 )
1970 wxCHECK_MSG( firstItemTopY
< lastItemBottomY
,
1972 "invalid y values" );
1975 wxLogDebug(" -> DoDrawItems ( \"%s\" -> \"%s\"
1976 "height=%i (ch=%i), drawRect = 0x%lX )",
1977 firstItem->GetLabel().c_str(),
1978 lastItem->GetLabel().c_str(),
1979 (int)(lastItemBottomY - firstItemTopY),
1981 (unsigned long)drawRect );
1986 long windowStyle
= m_windowStyle
;
1991 // With wxPG_DOUBLE_BUFFER, do double buffering
1992 // - buffer's y = 0, so align drawRect and coordinates to that
1994 #if wxPG_DOUBLE_BUFFER
2001 xRelMod
= drawRect
->x
;
2002 yRelMod
= drawRect
->y
;
2005 // drawRect conversion
2010 firstItemTopY
-= yRelMod
;
2011 lastItemBottomY
-= yRelMod
;
2014 wxUnusedVar(isBuffered
);
2017 int x
= m_marginWidth
- xRelMod
;
2019 wxFont normalFont
= GetFont();
2021 bool reallyFocused
= (m_iFlags
& wxPG_FL_FOCUSED
) != 0;
2023 bool isPgEnabled
= IsEnabled();
2026 // Prepare some pens and brushes that are often changed to.
2029 wxBrush
marginBrush(m_colMargin
);
2030 wxPen
marginPen(m_colMargin
);
2031 wxBrush
capbgbrush(m_colCapBack
,wxSOLID
);
2032 wxPen
linepen(m_colLine
,1,wxSOLID
);
2034 wxColour selBackCol
;
2036 selBackCol
= m_colSelBack
;
2038 selBackCol
= m_colMargin
;
2040 // pen that has same colour as text
2041 wxPen
outlinepen(m_colPropFore
,1,wxSOLID
);
2044 // Clear margin with background colour
2046 dc
.SetBrush( marginBrush
);
2047 if ( !(windowStyle
& wxPG_HIDE_MARGIN
) )
2049 dc
.SetPen( *wxTRANSPARENT_PEN
);
2050 dc
.DrawRectangle(-1-xRelMod
,firstItemTopY
-1,x
+2,lastItemBottomY
-firstItemTopY
+2);
2053 const wxPGProperty
* firstSelected
= GetSelection();
2054 const wxPropertyGridPageState
* state
= m_pState
;
2056 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2057 bool wasSelectedPainted
= false;
2060 // TODO: Only render columns that are within clipping region.
2062 dc
.SetFont(normalFont
);
2064 wxPropertyGridConstIterator
it( state
, wxPG_ITERATE_VISIBLE
, firstItem
);
2065 int endScanBottomY
= lastItemBottomY
+ lh
;
2066 int y
= firstItemTopY
;
2069 // Pregenerate list of visible properties.
2070 wxArrayPGProperty visPropArray
;
2071 visPropArray
.reserve((m_height
/m_lineHeight
)+6);
2073 for ( ; !it
.AtEnd(); it
.Next() )
2075 const wxPGProperty
* p
= *it
;
2077 if ( !p
->HasFlag(wxPG_PROP_HIDDEN
) )
2079 visPropArray
.push_back((wxPGProperty
*)p
);
2081 if ( y
> endScanBottomY
)
2088 visPropArray
.push_back(NULL
);
2090 wxPGProperty
* nextP
= visPropArray
[0];
2092 int gridWidth
= state
->m_width
;
2095 for ( unsigned int arrInd
=1;
2096 nextP
&& y
<= lastItemBottomY
;
2099 wxPGProperty
* p
= nextP
;
2100 nextP
= visPropArray
[arrInd
];
2102 int rowHeight
= m_fontHeight
+(m_spacingy
*2)+1;
2103 int textMarginHere
= x
;
2104 int renderFlags
= 0;
2106 int greyDepth
= m_marginWidth
;
2107 if ( !(windowStyle
& wxPG_HIDE_CATEGORIES
) )
2108 greyDepth
= (((int)p
->m_depthBgCol
)-1) * m_subgroup_extramargin
+ m_marginWidth
;
2110 int greyDepthX
= greyDepth
- xRelMod
;
2112 // Use basic depth if in non-categoric mode and parent is base array.
2113 if ( !(windowStyle
& wxPG_HIDE_CATEGORIES
) || p
->GetParent() != m_pState
->m_properties
)
2115 textMarginHere
+= ((unsigned int)((p
->m_depth
-1)*m_subgroup_extramargin
));
2118 // Paint margin area
2119 dc
.SetBrush(marginBrush
);
2120 dc
.SetPen(marginPen
);
2121 dc
.DrawRectangle( -xRelMod
, y
, greyDepth
, lh
);
2123 dc
.SetPen( linepen
);
2129 // Modified by JACS to not draw a margin if wxPG_HIDE_MARGIN is specified, since it
2130 // looks better, at least under Windows when we have a themed border (the themed-window-specific
2131 // whitespace between the real border and the propgrid margin exacerbates the double-border look).
2133 // Is this or its parent themed?
2134 bool suppressMarginEdge
= (GetWindowStyle() & wxPG_HIDE_MARGIN
) &&
2135 (((GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_THEME
) ||
2136 (((GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_NONE
) && ((GetParent()->GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_THEME
)));
2138 bool suppressMarginEdge
= false;
2140 if (!suppressMarginEdge
)
2141 dc
.DrawLine( greyDepthX
, y
, greyDepthX
, y2
);
2144 // Blank out the margin edge
2145 dc
.SetPen(wxPen(GetBackgroundColour()));
2146 dc
.DrawLine( greyDepthX
, y
, greyDepthX
, y2
);
2147 dc
.SetPen( linepen
);
2154 for ( si
=0; si
<state
->m_colWidths
.size(); si
++ )
2156 sx
+= state
->m_colWidths
[si
];
2157 dc
.DrawLine( sx
, y
, sx
, y2
);
2160 // Horizontal Line, below
2161 // (not if both this and next is category caption)
2162 if ( p
->IsCategory() &&
2163 nextP
&& nextP
->IsCategory() )
2164 dc
.SetPen(m_colCapBack
);
2166 dc
.DrawLine( greyDepthX
, y2
-1, gridWidth
-xRelMod
, y2
-1 );
2169 // Need to override row colours?
2173 bool isSelected
= state
->DoIsPropertySelected(p
);
2177 // Disabled may get different colour.
2178 if ( !p
->IsEnabled() )
2180 renderFlags
|= wxPGCellRenderer::Disabled
|
2181 wxPGCellRenderer::DontUseCellFgCol
;
2182 rowFgCol
= m_colDisPropFore
;
2187 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2188 if ( p
== firstSelected
)
2189 wasSelectedPainted
= true;
2192 renderFlags
|= wxPGCellRenderer::Selected
;
2194 if ( !p
->IsCategory() )
2196 renderFlags
|= wxPGCellRenderer::DontUseCellFgCol
|
2197 wxPGCellRenderer::DontUseCellBgCol
;
2199 if ( reallyFocused
&& p
== firstSelected
)
2201 rowFgCol
= m_colSelFore
;
2202 rowBgCol
= selBackCol
;
2204 else if ( isPgEnabled
)
2206 rowFgCol
= m_colPropFore
;
2207 if ( p
== firstSelected
)
2208 rowBgCol
= m_colMargin
;
2210 rowBgCol
= selBackCol
;
2214 rowFgCol
= m_colDisPropFore
;
2215 rowBgCol
= selBackCol
;
2222 if ( rowBgCol
.IsOk() )
2223 rowBgBrush
= wxBrush(rowBgCol
);
2225 if ( HasInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
) )
2226 renderFlags
= renderFlags
& ~wxPGCellRenderer::DontUseCellColours
;
2229 // Fill additional margin area with background colour of first cell
2230 if ( greyDepthX
< textMarginHere
)
2232 if ( !(renderFlags
& wxPGCellRenderer::DontUseCellBgCol
) )
2234 wxPGCell
& cell
= p
->GetCell(0);
2235 rowBgCol
= cell
.GetBgCol();
2236 rowBgBrush
= wxBrush(rowBgCol
);
2238 dc
.SetBrush(rowBgBrush
);
2239 dc
.SetPen(rowBgCol
);
2240 dc
.DrawRectangle(greyDepthX
+1, y
,
2241 textMarginHere
-greyDepthX
, lh
-1);
2244 bool fontChanged
= false;
2246 // Expander button rectangle
2247 wxRect
butRect( ((p
->m_depth
- 1) * m_subgroup_extramargin
) - xRelMod
,
2252 if ( p
->IsCategory() )
2254 // Captions have their cell areas merged as one
2255 dc
.SetFont(m_captionFont
);
2257 wxRect
cellRect(greyDepthX
, y
, gridWidth
- greyDepth
+ 2, rowHeight
-1 );
2259 if ( renderFlags
& wxPGCellRenderer::DontUseCellBgCol
)
2261 dc
.SetBrush(rowBgBrush
);
2262 dc
.SetPen(rowBgCol
);
2265 if ( renderFlags
& wxPGCellRenderer::DontUseCellFgCol
)
2267 dc
.SetTextForeground(rowFgCol
);
2270 wxPGCellRenderer
* renderer
= p
->GetCellRenderer(0);
2271 renderer
->Render( dc
, cellRect
, this, p
, 0, -1, renderFlags
);
2274 if ( !HasFlag(wxPG_HIDE_MARGIN
) && p
->HasVisibleChildren() )
2275 DrawExpanderButton( dc
, butRect
, p
);
2279 // Fine tune button rectangle to actually fit the cell
2280 if ( butRect
.x
> 0 )
2281 butRect
.x
+= IN_CELL_EXPANDER_BUTTON_X_ADJUST
;
2283 if ( p
->m_flags
& wxPG_PROP_MODIFIED
&& (windowStyle
& wxPG_BOLD_MODIFIED
) )
2285 dc
.SetFont(m_captionFont
);
2291 int nextCellWidth
= state
->m_colWidths
[0] -
2292 (greyDepthX
- m_marginWidth
);
2293 wxRect
cellRect(greyDepthX
+1, y
, 0, rowHeight
-1);
2294 int textXAdd
= textMarginHere
- greyDepthX
;
2296 for ( ci
=0; ci
<state
->m_colWidths
.size(); ci
++ )
2298 cellRect
.width
= nextCellWidth
- 1;
2300 wxWindow
* cellEditor
= NULL
;
2301 int cellRenderFlags
= renderFlags
;
2303 // Tree Item Button (must be drawn before clipping is set up)
2304 if ( ci
== 0 && !HasFlag(wxPG_HIDE_MARGIN
) && p
->HasVisibleChildren() )
2305 DrawExpanderButton( dc
, butRect
, p
);
2308 if ( isSelected
&& (ci
== 1 || ci
== m_selColumn
) )
2310 if ( p
== firstSelected
)
2312 if ( ci
== 1 && m_wndEditor
)
2313 cellEditor
= m_wndEditor
;
2314 else if ( ci
== m_selColumn
&& m_labelEditor
)
2315 cellEditor
= m_labelEditor
;
2320 wxColour editorBgCol
=
2321 cellEditor
->GetBackgroundColour();
2322 dc
.SetBrush(editorBgCol
);
2323 dc
.SetPen(editorBgCol
);
2324 dc
.SetTextForeground(m_colPropFore
);
2325 dc
.DrawRectangle(cellRect
);
2327 if ( m_dragStatus
!= 0 ||
2328 (m_iFlags
& wxPG_FL_CUR_USES_CUSTOM_IMAGE
) )
2333 dc
.SetBrush(m_colPropBack
);
2334 dc
.SetPen(m_colPropBack
);
2335 dc
.SetTextForeground(m_colDisPropFore
);
2336 if ( p
->IsEnabled() )
2337 dc
.SetTextForeground(rowFgCol
);
2339 dc
.SetTextForeground(m_colDisPropFore
);
2344 if ( renderFlags
& wxPGCellRenderer::DontUseCellBgCol
)
2346 dc
.SetBrush(rowBgBrush
);
2347 dc
.SetPen(rowBgCol
);
2350 if ( renderFlags
& wxPGCellRenderer::DontUseCellFgCol
)
2352 dc
.SetTextForeground(rowFgCol
);
2356 dc
.SetClippingRegion(cellRect
);
2358 cellRect
.x
+= textXAdd
;
2359 cellRect
.width
-= textXAdd
;
2364 wxPGCellRenderer
* renderer
;
2365 int cmnVal
= p
->GetCommonValue();
2366 if ( cmnVal
== -1 || ci
!= 1 )
2368 renderer
= p
->GetCellRenderer(ci
);
2369 renderer
->Render( dc
, cellRect
, this, p
, ci
, -1,
2374 renderer
= GetCommonValue(cmnVal
)->GetRenderer();
2375 renderer
->Render( dc
, cellRect
, this, p
, ci
, -1,
2380 cellX
+= state
->m_colWidths
[ci
];
2381 if ( ci
< (state
->m_colWidths
.size()-1) )
2382 nextCellWidth
= state
->m_colWidths
[ci
+1];
2384 dc
.DestroyClippingRegion(); // Is this really necessary?
2390 dc
.SetFont(normalFont
);
2395 // Refresh editor controls (seems not needed on msw)
2396 // NOTE: This code is mandatory for GTK!
2397 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2398 if ( wasSelectedPainted
)
2401 m_wndEditor
->Refresh();
2403 m_wndEditor2
->Refresh();
2410 // -----------------------------------------------------------------------
2412 wxRect
wxPropertyGrid::GetPropertyRect( const wxPGProperty
* p1
, const wxPGProperty
* p2
) const
2416 if ( m_width
< 10 || m_height
< 10 ||
2417 !m_pState
->m_properties
->GetChildCount() ||
2419 return wxRect(0,0,0,0);
2424 // Return rect which encloses the given property range
2426 int visTop
= p1
->GetY();
2429 visBottom
= p2
->GetY() + m_lineHeight
;
2431 visBottom
= m_height
+ visTop
;
2433 // If seleced property is inside the range, we'll extend the range to include
2435 wxPGProperty
* selected
= GetSelection();
2438 int selectedY
= selected
->GetY();
2439 if ( selectedY
>= visTop
&& selectedY
< visBottom
)
2441 wxWindow
* editor
= GetEditorControl();
2444 int visBottom2
= selectedY
+ editor
->GetSize().y
;
2445 if ( visBottom2
> visBottom
)
2446 visBottom
= visBottom2
;
2451 return wxRect(0,visTop
-vy
,m_pState
->m_width
,visBottom
-visTop
);
2454 // -----------------------------------------------------------------------
2456 void wxPropertyGrid::DrawItems( const wxPGProperty
* p1
, const wxPGProperty
* p2
)
2461 if ( m_pState
->m_itemsAdded
)
2462 PrepareAfterItemsAdded();
2464 wxRect r
= GetPropertyRect(p1
, p2
);
2471 // -----------------------------------------------------------------------
2473 void wxPropertyGrid::RefreshProperty( wxPGProperty
* p
)
2475 if ( m_pState
->DoIsPropertySelected(p
) )
2477 // NB: We must copy the selection.
2478 wxArrayPGProperty selection
= m_pState
->m_selection
;
2479 DoSetSelection(selection
, wxPG_SEL_FORCE
);
2482 DrawItemAndChildren(p
);
2485 // -----------------------------------------------------------------------
2487 void wxPropertyGrid::DrawItemAndValueRelated( wxPGProperty
* p
)
2492 // Draw item, children, and parent too, if it is not category
2493 wxPGProperty
* parent
= p
->GetParent();
2496 !parent
->IsCategory() &&
2497 parent
->GetParent() )
2500 parent
= parent
->GetParent();
2503 DrawItemAndChildren(p
);
2506 void wxPropertyGrid::DrawItemAndChildren( wxPGProperty
* p
)
2508 wxCHECK_RET( p
, wxT("invalid property id") );
2510 // Do not draw if in non-visible page
2511 if ( p
->GetParentState() != m_pState
)
2514 // do not draw a single item if multiple pending
2515 if ( m_pState
->m_itemsAdded
|| m_frozen
)
2518 // Update child control.
2519 wxPGProperty
* selected
= GetSelection();
2520 if ( selected
&& selected
->GetParent() == p
)
2523 const wxPGProperty
* lastDrawn
= p
->GetLastVisibleSubItem();
2525 DrawItems(p
, lastDrawn
);
2528 // -----------------------------------------------------------------------
2530 void wxPropertyGrid::Refresh( bool WXUNUSED(eraseBackground
),
2531 const wxRect
*rect
)
2533 PrepareAfterItemsAdded();
2535 wxWindow::Refresh(false, rect
);
2537 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2538 // I think this really helps only GTK+1.2
2539 if ( m_wndEditor
) m_wndEditor
->Refresh();
2540 if ( m_wndEditor2
) m_wndEditor2
->Refresh();
2544 // -----------------------------------------------------------------------
2545 // wxPropertyGrid global operations
2546 // -----------------------------------------------------------------------
2548 void wxPropertyGrid::Clear()
2550 m_pState
->DoClear();
2556 RecalculateVirtualSize();
2558 // Need to clear some area at the end
2560 RefreshRect(wxRect(0, 0, m_width
, m_height
));
2563 // -----------------------------------------------------------------------
2565 bool wxPropertyGrid::EnableCategories( bool enable
)
2572 // Enable categories
2575 m_windowStyle
&= ~(wxPG_HIDE_CATEGORIES
);
2580 // Disable categories
2582 m_windowStyle
|= wxPG_HIDE_CATEGORIES
;
2585 if ( !m_pState
->EnableCategories(enable
) )
2590 if ( m_windowStyle
& wxPG_AUTO_SORT
)
2592 m_pState
->m_itemsAdded
= 1; // force
2593 PrepareAfterItemsAdded();
2597 m_pState
->m_itemsAdded
= 1;
2599 // No need for RecalculateVirtualSize() here - it is already called in
2600 // wxPropertyGridPageState method above.
2607 // -----------------------------------------------------------------------
2609 void wxPropertyGrid::SwitchState( wxPropertyGridPageState
* pNewState
)
2611 wxASSERT( pNewState
);
2612 wxASSERT( pNewState
->GetGrid() );
2614 if ( pNewState
== m_pState
)
2617 wxArrayPGProperty oldSelection
= m_pState
->m_selection
;
2619 // Call ClearSelection() instead of DoClearSelection()
2620 // so that selection clear events are not sent.
2623 m_pState
->m_selection
= oldSelection
;
2625 bool orig_mode
= m_pState
->IsInNonCatMode();
2626 bool new_state_mode
= pNewState
->IsInNonCatMode();
2628 m_pState
= pNewState
;
2631 int pgWidth
= GetClientSize().x
;
2632 if ( HasVirtualWidth() )
2634 int minWidth
= pgWidth
;
2635 if ( pNewState
->m_width
< minWidth
)
2637 pNewState
->m_width
= minWidth
;
2638 pNewState
->CheckColumnWidths();
2644 // Just in case, fully re-center splitter
2645 //if ( HasFlag( wxPG_SPLITTER_AUTO_CENTER ) )
2646 // pNewState->m_fSplitterX = -1.0;
2648 pNewState
->OnClientWidthChange(pgWidth
,
2649 pgWidth
- pNewState
->m_width
);
2654 // If necessary, convert state to correct mode.
2655 if ( orig_mode
!= new_state_mode
)
2657 // This should refresh as well.
2658 EnableCategories( orig_mode
?false:true );
2660 else if ( !m_frozen
)
2662 // Refresh, if not frozen.
2663 m_pState
->PrepareAfterItemsAdded();
2665 // Reselect (Use SetSelection() instead of Do-variant so that
2666 // events won't be sent).
2667 SetSelection(m_pState
->m_selection
);
2669 RecalculateVirtualSize(0);
2673 m_pState
->m_itemsAdded
= 1;
2676 // -----------------------------------------------------------------------
2678 // Call to SetSplitterPosition will always disable splitter auto-centering
2679 // if parent window is shown.
2680 void wxPropertyGrid::DoSetSplitterPosition_( int newxpos
, bool refresh
,
2684 if ( ( newxpos
< wxPG_DRAG_MARGIN
) )
2687 wxPropertyGridPageState
* state
= m_pState
;
2689 state
->DoSetSplitterPosition( newxpos
, splitterIndex
, allPages
);
2693 if ( GetSelection() )
2694 CorrectEditorWidgetSizeX();
2700 // -----------------------------------------------------------------------
2702 void wxPropertyGrid::CenterSplitter( bool enableAutoCentering
)
2704 SetSplitterPosition( m_width
/2 );
2705 if ( enableAutoCentering
&& HasFlag(wxPG_SPLITTER_AUTO_CENTER
) )
2706 m_pState
->m_dontCenterSplitter
= false;
2709 // -----------------------------------------------------------------------
2710 // wxPropertyGrid item iteration (GetNextProperty etc.) methods
2711 // -----------------------------------------------------------------------
2713 // Returns nearest paint visible property (such that will be painted unless
2714 // window is scrolled or resized). If given property is paint visible, then
2715 // it itself will be returned
2716 wxPGProperty
* wxPropertyGrid::GetNearestPaintVisible( wxPGProperty
* p
) const
2718 int vx
,vy1
;// Top left corner of client
2719 GetViewStart(&vx
,&vy1
);
2720 vy1
*= wxPG_PIXELS_PER_UNIT
;
2722 int vy2
= vy1
+ m_height
;
2723 int propY
= p
->GetY2(m_lineHeight
);
2725 if ( (propY
+ m_lineHeight
) < vy1
)
2728 return DoGetItemAtY( vy1
);
2730 else if ( propY
> vy2
)
2733 return DoGetItemAtY( vy2
);
2736 // Itself paint visible
2741 // -----------------------------------------------------------------------
2742 // Methods related to change in value, value modification and sending events
2743 // -----------------------------------------------------------------------
2745 // commits any changes in editor of selected property
2746 // return true if validation did not fail
2747 // flags are same as with DoSelectProperty
2748 bool wxPropertyGrid::CommitChangesFromEditor( wxUint32 flags
)
2750 // Committing already?
2751 if ( m_inCommitChangesFromEditor
)
2754 // Don't do this if already processing editor event. It might
2755 // induce recursive dialogs and crap like that.
2756 if ( m_iFlags
& wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
)
2758 if ( m_inDoPropertyChanged
)
2764 wxPGProperty
* selected
= GetSelection();
2767 IsEditorsValueModified() &&
2768 (m_iFlags
& wxPG_FL_INITIALIZED
) &&
2771 m_inCommitChangesFromEditor
= 1;
2773 wxVariant
variant(selected
->GetValueRef());
2774 bool valueIsPending
= false;
2776 // JACS - necessary to avoid new focus being found spuriously within OnIdle
2777 // due to another window getting focus
2778 wxWindow
* oldFocus
= m_curFocused
;
2780 bool validationFailure
= false;
2781 bool forceSuccess
= (flags
& (wxPG_SEL_NOVALIDATE
|wxPG_SEL_FORCE
)) ? true : false;
2783 m_chgInfo_changedProperty
= NULL
;
2785 // If truly modified, schedule value as pending.
2786 if ( selected
->GetEditorClass()->
2787 GetValueFromControl( variant
,
2789 GetEditorControl() ) )
2791 if ( DoEditorValidate() &&
2792 PerformValidation(selected
, variant
) )
2794 valueIsPending
= true;
2798 validationFailure
= true;
2803 EditorsValueWasNotModified();
2808 m_inCommitChangesFromEditor
= 0;
2810 if ( validationFailure
&& !forceSuccess
)
2814 oldFocus
->SetFocus();
2815 m_curFocused
= oldFocus
;
2818 res
= OnValidationFailure(selected
, variant
);
2820 // Now prevent further validation failure messages
2823 EditorsValueWasNotModified();
2824 OnValidationFailureReset(selected
);
2827 else if ( valueIsPending
)
2829 DoPropertyChanged( selected
, flags
);
2830 EditorsValueWasNotModified();
2839 // -----------------------------------------------------------------------
2841 bool wxPropertyGrid::PerformValidation( wxPGProperty
* p
, wxVariant
& pendingValue
,
2845 // Runs all validation functionality.
2846 // Returns true if value passes all tests.
2849 m_validationInfo
.m_failureBehavior
= m_permanentValidationFailureBehavior
;
2852 // Variant list a special value that cannot be validated
2854 if ( pendingValue
.GetType() != wxPG_VARIANT_TYPE_LIST
)
2856 if ( !p
->ValidateValue(pendingValue
, m_validationInfo
) )
2861 // Adapt list to child values, if necessary
2862 wxVariant listValue
= pendingValue
;
2863 wxVariant
* pPendingValue
= &pendingValue
;
2864 wxVariant
* pList
= NULL
;
2866 // If parent has wxPG_PROP_AGGREGATE flag, or uses composite
2867 // string value, then we need treat as it was changed instead
2868 // (or, in addition, as is the case with composite string parent).
2869 // This includes creating list variant for child values.
2871 wxPGProperty
* pwc
= p
->GetParent();
2872 wxPGProperty
* changedProperty
= p
;
2873 wxPGProperty
* baseChangedProperty
= changedProperty
;
2874 wxVariant bcpPendingList
;
2876 listValue
= pendingValue
;
2877 listValue
.SetName(p
->GetBaseName());
2880 (pwc
->HasFlag(wxPG_PROP_AGGREGATE
) || pwc
->HasFlag(wxPG_PROP_COMPOSED_VALUE
)) )
2882 wxVariantList tempList
;
2883 wxVariant
lv(tempList
, pwc
->GetBaseName());
2884 lv
.Append(listValue
);
2886 pPendingValue
= &listValue
;
2888 if ( pwc
->HasFlag(wxPG_PROP_AGGREGATE
) )
2890 baseChangedProperty
= pwc
;
2891 bcpPendingList
= lv
;
2894 changedProperty
= pwc
;
2895 pwc
= pwc
->GetParent();
2899 wxPGProperty
* evtChangingProperty
= changedProperty
;
2901 if ( pPendingValue
->GetType() != wxPG_VARIANT_TYPE_LIST
)
2903 value
= *pPendingValue
;
2907 // Convert list to child values
2908 pList
= pPendingValue
;
2909 changedProperty
->AdaptListToValue( *pPendingValue
, &value
);
2912 wxVariant evtChangingValue
= value
;
2914 if ( flags
& SendEvtChanging
)
2916 // FIXME: After proper ValueToString()s added, remove
2917 // this. It is just a temporary fix, as evt_changing
2918 // will simply not work for wxPG_PROP_COMPOSED_VALUE
2919 // (unless it is selected, and textctrl editor is open).
2920 if ( changedProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
2922 evtChangingProperty
= baseChangedProperty
;
2923 if ( evtChangingProperty
!= p
)
2925 evtChangingProperty
->AdaptListToValue( bcpPendingList
, &evtChangingValue
);
2929 evtChangingValue
= pendingValue
;
2933 if ( evtChangingProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
2935 if ( changedProperty
== GetSelection() )
2937 wxWindow
* editor
= GetEditorControl();
2938 wxASSERT( editor
->IsKindOf(CLASSINFO(wxTextCtrl
)) );
2939 evtChangingValue
= wxStaticCast(editor
, wxTextCtrl
)->GetValue();
2943 wxLogDebug(wxT("WARNING: wxEVT_PG_CHANGING is about to happen with old value."));
2948 wxASSERT( m_chgInfo_changedProperty
== NULL
);
2949 m_chgInfo_changedProperty
= changedProperty
;
2950 m_chgInfo_baseChangedProperty
= baseChangedProperty
;
2951 m_chgInfo_pendingValue
= value
;
2954 m_chgInfo_valueList
= *pList
;
2956 m_chgInfo_valueList
.MakeNull();
2958 // If changedProperty is not property which value was edited,
2959 // then call wxPGProperty::ValidateValue() for that as well.
2960 if ( p
!= changedProperty
&& value
.GetType() != wxPG_VARIANT_TYPE_LIST
)
2962 if ( !changedProperty
->ValidateValue(value
, m_validationInfo
) )
2966 if ( flags
& SendEvtChanging
)
2968 // SendEvent returns true if event was vetoed
2969 if ( SendEvent( wxEVT_PG_CHANGING
, evtChangingProperty
,
2970 &evtChangingValue
) )
2974 if ( flags
& IsStandaloneValidation
)
2976 // If called in 'generic' context, we need to reset
2977 // m_chgInfo_changedProperty and write back translated value.
2978 m_chgInfo_changedProperty
= NULL
;
2979 pendingValue
= value
;
2985 // -----------------------------------------------------------------------
2987 void wxPropertyGrid::DoShowPropertyError( wxPGProperty
* WXUNUSED(property
), const wxString
& msg
)
2989 if ( !msg
.length() )
2993 if ( !wxPGGlobalVars
->m_offline
)
2995 wxWindow
* topWnd
= ::wxGetTopLevelParent(this);
2998 wxFrame
* pFrame
= wxDynamicCast(topWnd
, wxFrame
);
3001 wxStatusBar
* pStatusBar
= pFrame
->GetStatusBar();
3004 pStatusBar
->SetStatusText(msg
);
3012 ::wxMessageBox(msg
, wxT("Property Error"));
3015 // -----------------------------------------------------------------------
3017 bool wxPropertyGrid::OnValidationFailure( wxPGProperty
* property
,
3018 wxVariant
& invalidValue
)
3020 wxWindow
* editor
= GetEditorControl();
3022 // First call property's handler
3023 property
->OnValidationFailure(invalidValue
);
3025 bool res
= DoOnValidationFailure(property
, invalidValue
);
3028 // For non-wxTextCtrl editors, we do need to revert the value
3029 if ( !editor
->IsKindOf(CLASSINFO(wxTextCtrl
)) &&
3030 property
== GetSelection() )
3032 property
->GetEditorClass()->UpdateControl(property
, editor
);
3035 property
->SetFlag(wxPG_PROP_INVALID_VALUE
);
3040 bool wxPropertyGrid::DoOnValidationFailure( wxPGProperty
* property
, wxVariant
& WXUNUSED(invalidValue
) )
3042 int vfb
= m_validationInfo
.m_failureBehavior
;
3044 if ( vfb
& wxPG_VFB_BEEP
)
3047 if ( (vfb
& wxPG_VFB_MARK_CELL
) &&
3048 !property
->HasFlag(wxPG_PROP_INVALID_VALUE
) )
3050 unsigned int colCount
= m_pState
->GetColumnCount();
3052 // We need backup marked property's cells
3053 m_propCellsBackup
= property
->m_cells
;
3055 wxColour vfbFg
= *wxWHITE
;
3056 wxColour vfbBg
= *wxRED
;
3058 property
->EnsureCells(colCount
);
3060 for ( unsigned int i
=0; i
<colCount
; i
++ )
3062 wxPGCell
& cell
= property
->m_cells
[i
];
3063 cell
.SetFgCol(vfbFg
);
3064 cell
.SetBgCol(vfbBg
);
3067 DrawItemAndChildren(property
);
3069 if ( property
== GetSelection() )
3071 SetInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
);
3073 wxWindow
* editor
= GetEditorControl();
3076 editor
->SetForegroundColour(vfbFg
);
3077 editor
->SetBackgroundColour(vfbBg
);
3082 if ( vfb
& wxPG_VFB_SHOW_MESSAGE
)
3084 wxString msg
= m_validationInfo
.m_failureMessage
;
3086 if ( !msg
.length() )
3087 msg
= wxT("You have entered invalid value. Press ESC to cancel editing.");
3089 DoShowPropertyError(property
, msg
);
3092 return (vfb
& wxPG_VFB_STAY_IN_PROPERTY
) ? false : true;
3095 // -----------------------------------------------------------------------
3097 void wxPropertyGrid::DoOnValidationFailureReset( wxPGProperty
* property
)
3099 int vfb
= m_validationInfo
.m_failureBehavior
;
3101 if ( vfb
& wxPG_VFB_MARK_CELL
)
3104 property
->m_cells
= m_propCellsBackup
;
3106 ClearInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
);
3108 if ( property
== GetSelection() && GetEditorControl() )
3110 // Calling this will recreate the control, thus resetting its colour
3111 RefreshProperty(property
);
3115 DrawItemAndChildren(property
);
3120 // -----------------------------------------------------------------------
3122 // flags are same as with DoSelectProperty
3123 bool wxPropertyGrid::DoPropertyChanged( wxPGProperty
* p
, unsigned int selFlags
)
3125 if ( m_inDoPropertyChanged
)
3128 wxWindow
* editor
= GetEditorControl();
3129 wxPGProperty
* selected
= GetSelection();
3131 m_pState
->m_anyModified
= 1;
3133 m_inDoPropertyChanged
= 1;
3135 // Maybe need to update control
3136 wxASSERT( m_chgInfo_changedProperty
!= NULL
);
3138 // These values were calculated in PerformValidation()
3139 wxPGProperty
* changedProperty
= m_chgInfo_changedProperty
;
3140 wxVariant value
= m_chgInfo_pendingValue
;
3142 wxPGProperty
* topPaintedProperty
= changedProperty
;
3144 while ( !topPaintedProperty
->IsCategory() &&
3145 !topPaintedProperty
->IsRoot() )
3147 topPaintedProperty
= topPaintedProperty
->GetParent();
3150 changedProperty
->SetValue(value
, &m_chgInfo_valueList
, wxPG_SETVAL_BY_USER
);
3152 // Set as Modified (not if dragging just began)
3153 if ( !(p
->m_flags
& wxPG_PROP_MODIFIED
) )
3155 p
->m_flags
|= wxPG_PROP_MODIFIED
;
3156 if ( p
== selected
&& (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3159 SetCurControlBoldFont();
3165 // Propagate updates to parent(s)
3167 wxPGProperty
* prevPwc
= NULL
;
3169 while ( prevPwc
!= topPaintedProperty
)
3171 pwc
->m_flags
|= wxPG_PROP_MODIFIED
;
3173 if ( pwc
== selected
&& (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3176 SetCurControlBoldFont();
3180 pwc
= pwc
->GetParent();
3183 // Draw the actual property
3184 DrawItemAndChildren( topPaintedProperty
);
3187 // If value was set by wxPGProperty::OnEvent, then update the editor
3189 if ( selFlags
& wxPG_SEL_DIALOGVAL
)
3195 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
3196 if ( m_wndEditor
) m_wndEditor
->Refresh();
3197 if ( m_wndEditor2
) m_wndEditor2
->Refresh();
3202 wxASSERT( !changedProperty
->GetParent()->HasFlag(wxPG_PROP_AGGREGATE
) );
3204 // If top parent has composite string value, then send to child parents,
3205 // starting from baseChangedProperty.
3206 if ( changedProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
3208 pwc
= m_chgInfo_baseChangedProperty
;
3210 while ( pwc
!= changedProperty
)
3212 SendEvent( wxEVT_PG_CHANGED
, pwc
, NULL
);
3213 pwc
= pwc
->GetParent();
3217 SendEvent( wxEVT_PG_CHANGED
, changedProperty
, NULL
);
3219 m_inDoPropertyChanged
= 0;
3224 // -----------------------------------------------------------------------
3226 bool wxPropertyGrid::ChangePropertyValue( wxPGPropArg id
, wxVariant newValue
)
3228 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
3230 m_chgInfo_changedProperty
= NULL
;
3232 if ( PerformValidation(p
, newValue
) )
3234 DoPropertyChanged(p
);
3239 OnValidationFailure(p
, newValue
);
3245 // -----------------------------------------------------------------------
3247 wxVariant
wxPropertyGrid::GetUncommittedPropertyValue()
3249 wxPGProperty
* prop
= GetSelectedProperty();
3252 return wxNullVariant
;
3254 wxTextCtrl
* tc
= GetEditorTextCtrl();
3255 wxVariant value
= prop
->GetValue();
3257 if ( !tc
|| !IsEditorsValueModified() )
3260 if ( !prop
->StringToValue(value
, tc
->GetValue()) )
3263 if ( !PerformValidation(prop
, value
, IsStandaloneValidation
) )
3264 return prop
->GetValue();
3269 // -----------------------------------------------------------------------
3271 // Runs wxValidator for the selected property
3272 bool wxPropertyGrid::DoEditorValidate()
3277 // -----------------------------------------------------------------------
3279 void wxPropertyGrid::HandleCustomEditorEvent( wxEvent
&event
)
3281 wxPGProperty
* selected
= GetSelection();
3283 // Somehow, event is handled after property has been deselected.
3284 // Possibly, but very rare.
3286 selected
->HasFlag(wxPG_PROP_BEING_DELETED
) ||
3287 // Also don't handle editor event if wxEVT_PG_CHANGED or
3288 // similar is currently doing something (showing a
3289 // message box, for instance).
3293 if ( m_iFlags
& wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
)
3296 wxVariant
pendingValue(selected
->GetValueRef());
3297 wxWindow
* wnd
= GetEditorControl();
3298 wxWindow
* editorWnd
= wxDynamicCast(event
.GetEventObject(), wxWindow
);
3300 bool wasUnspecified
= selected
->IsValueUnspecified();
3301 int usesAutoUnspecified
= selected
->UsesAutoUnspecified();
3302 bool valueIsPending
= false;
3304 m_chgInfo_changedProperty
= NULL
;
3306 m_iFlags
&= ~(wxPG_FL_VALIDATION_FAILED
|wxPG_FL_VALUE_CHANGE_IN_EVENT
);
3309 // Filter out excess wxTextCtrl modified events
3310 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_UPDATED
&&
3312 wnd
->IsKindOf(CLASSINFO(wxTextCtrl
)) )
3314 wxTextCtrl
* tc
= (wxTextCtrl
*) wnd
;
3316 wxString newTcValue
= tc
->GetValue();
3317 if ( m_prevTcValue
== newTcValue
)
3320 m_prevTcValue
= newTcValue
;
3323 SetInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
);
3325 bool validationFailure
= false;
3326 bool buttonWasHandled
= false;
3329 // Try common button handling
3330 if ( m_wndEditor2
&& event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
3332 wxPGEditorDialogAdapter
* adapter
= selected
->GetEditorDialog();
3336 buttonWasHandled
= true;
3337 // Store as res2, as previously (and still currently alternatively)
3338 // dialogs can be shown by handling wxEVT_COMMAND_BUTTON_CLICKED
3339 // in wxPGProperty::OnEvent().
3340 adapter
->ShowDialog( this, selected
);
3345 if ( !buttonWasHandled
)
3347 if ( wnd
|| m_wndEditor2
)
3349 // First call editor class' event handler.
3350 const wxPGEditor
* editor
= selected
->GetEditorClass();
3352 if ( editor
->OnEvent( this, selected
, editorWnd
, event
) )
3354 // If changes, validate them
3355 if ( DoEditorValidate() )
3357 if ( editor
->GetValueFromControl( pendingValue
,
3360 valueIsPending
= true;
3364 validationFailure
= true;
3369 // Then the property's custom handler (must be always called, unless
3370 // validation failed).
3371 if ( !validationFailure
)
3372 buttonWasHandled
= selected
->OnEvent( this, editorWnd
, event
);
3375 // SetValueInEvent(), as called in one of the functions referred above
3376 // overrides editor's value.
3377 if ( m_iFlags
& wxPG_FL_VALUE_CHANGE_IN_EVENT
)
3379 valueIsPending
= true;
3380 pendingValue
= m_changeInEventValue
;
3381 selFlags
|= wxPG_SEL_DIALOGVAL
;
3384 if ( !validationFailure
&& valueIsPending
)
3385 if ( !PerformValidation(selected
, pendingValue
) )
3386 validationFailure
= true;
3388 if ( validationFailure
)
3390 OnValidationFailure(selected
, pendingValue
);
3392 else if ( valueIsPending
)
3394 selFlags
|= ( !wasUnspecified
&& selected
->IsValueUnspecified() && usesAutoUnspecified
) ? wxPG_SEL_SETUNSPEC
: 0;
3396 DoPropertyChanged(selected
, selFlags
);
3397 EditorsValueWasNotModified();
3399 // Regardless of editor type, unfocus editor on
3400 // text-editing related enter press.
3401 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_ENTER
)
3408 // No value after all
3410 // Regardless of editor type, unfocus editor on
3411 // text-editing related enter press.
3412 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_ENTER
)
3417 // Let unhandled button click events go to the parent
3418 if ( !buttonWasHandled
&& event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
3420 wxCommandEvent
evt(wxEVT_COMMAND_BUTTON_CLICKED
,GetId());
3421 GetEventHandler()->AddPendingEvent(evt
);
3425 ClearInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
);
3428 // -----------------------------------------------------------------------
3429 // wxPropertyGrid editor control helper methods
3430 // -----------------------------------------------------------------------
3432 wxRect
wxPropertyGrid::GetEditorWidgetRect( wxPGProperty
* p
, int column
) const
3434 int itemy
= p
->GetY2(m_lineHeight
);
3435 int splitterX
= m_pState
->DoGetSplitterPosition(column
-1);
3436 int colEnd
= splitterX
+ m_pState
->m_colWidths
[column
];
3437 int imageOffset
= 0;
3439 int vx
, vy
; // Top left corner of client
3440 GetViewStart(&vx
, &vy
);
3441 vy
*= wxPG_PIXELS_PER_UNIT
;
3443 // TODO: If custom image detection changes from current, change this.
3444 if ( m_iFlags
& wxPG_FL_CUR_USES_CUSTOM_IMAGE
)
3446 //m_iFlags |= wxPG_FL_CUR_USES_CUSTOM_IMAGE;
3447 int iw
= p
->OnMeasureImage().x
;
3449 iw
= wxPG_CUSTOM_IMAGE_WIDTH
;
3450 imageOffset
= p
->GetImageOffset(iw
);
3455 splitterX
+imageOffset
+wxPG_XBEFOREWIDGET
+wxPG_CONTROL_MARGIN
+1,
3457 colEnd
-splitterX
-wxPG_XBEFOREWIDGET
-wxPG_CONTROL_MARGIN
-imageOffset
-1,
3462 // -----------------------------------------------------------------------
3464 wxRect
wxPropertyGrid::GetImageRect( wxPGProperty
* p
, int item
) const
3466 wxSize sz
= GetImageSize(p
, item
);
3467 return wxRect(wxPG_CONTROL_MARGIN
+ wxCC_CUSTOM_IMAGE_MARGIN1
,
3468 wxPG_CUSTOM_IMAGE_SPACINGY
,
3473 // return size of custom paint image
3474 wxSize
wxPropertyGrid::GetImageSize( wxPGProperty
* p
, int item
) const
3476 // If called with NULL property, then return default image
3477 // size for properties that use image.
3479 return wxSize(wxPG_CUSTOM_IMAGE_WIDTH
,wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight
));
3481 wxSize cis
= p
->OnMeasureImage(item
);
3483 int choiceCount
= p
->m_choices
.GetCount();
3484 int comVals
= p
->GetDisplayedCommonValueCount();
3485 if ( item
>= choiceCount
&& comVals
> 0 )
3487 unsigned int cvi
= item
-choiceCount
;
3488 cis
= GetCommonValue(cvi
)->GetRenderer()->GetImageSize(NULL
, 1, cvi
);
3490 else if ( item
>= 0 && choiceCount
== 0 )
3491 return wxSize(0, 0);
3496 cis
.x
= wxPG_CUSTOM_IMAGE_WIDTH
;
3501 cis
.y
= wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight
);
3508 // -----------------------------------------------------------------------
3510 // takes scrolling into account
3511 void wxPropertyGrid::ImprovedClientToScreen( int* px
, int* py
)
3514 GetViewStart(&vx
,&vy
);
3515 vy
*=wxPG_PIXELS_PER_UNIT
;
3516 vx
*=wxPG_PIXELS_PER_UNIT
;
3519 ClientToScreen( px
, py
);
3522 // -----------------------------------------------------------------------
3524 wxPropertyGridHitTestResult
wxPropertyGrid::HitTest( const wxPoint
& pt
) const
3527 GetViewStart(&pt2
.x
,&pt2
.y
);
3528 pt2
.x
*= wxPG_PIXELS_PER_UNIT
;
3529 pt2
.y
*= wxPG_PIXELS_PER_UNIT
;
3533 return m_pState
->HitTest(pt2
);
3536 // -----------------------------------------------------------------------
3538 // custom set cursor
3539 void wxPropertyGrid::CustomSetCursor( int type
, bool override
)
3541 if ( type
== m_curcursor
&& !override
) return;
3543 wxCursor
* cursor
= &wxPG_DEFAULT_CURSOR
;
3545 if ( type
== wxCURSOR_SIZEWE
)
3546 cursor
= m_cursorSizeWE
;
3548 SetCursor( *cursor
);
3553 // -----------------------------------------------------------------------
3554 // wxPropertyGrid property selection, editor creation
3555 // -----------------------------------------------------------------------
3558 // This class forwards events from property editor controls to wxPropertyGrid.
3559 class wxPropertyGridEditorEventForwarder
: public wxEvtHandler
3562 wxPropertyGridEditorEventForwarder( wxPropertyGrid
* propGrid
)
3563 : wxEvtHandler(), m_propGrid(propGrid
)
3567 virtual ~wxPropertyGridEditorEventForwarder()
3572 bool ProcessEvent( wxEvent
& event
)
3577 m_propGrid
->HandleCustomEditorEvent(event
);
3579 return wxEvtHandler::ProcessEvent(event
);
3582 wxPropertyGrid
* m_propGrid
;
3585 // Setups event handling for child control
3586 void wxPropertyGrid::SetupChildEventHandling( wxWindow
* argWnd
)
3588 wxWindowID id
= argWnd
->GetId();
3590 if ( argWnd
== m_wndEditor
)
3592 argWnd
->Connect(id
, wxEVT_MOTION
,
3593 wxMouseEventHandler(wxPropertyGrid::OnMouseMoveChild
),
3595 argWnd
->Connect(id
, wxEVT_LEFT_UP
,
3596 wxMouseEventHandler(wxPropertyGrid::OnMouseUpChild
),
3598 argWnd
->Connect(id
, wxEVT_LEFT_DOWN
,
3599 wxMouseEventHandler(wxPropertyGrid::OnMouseClickChild
),
3601 argWnd
->Connect(id
, wxEVT_RIGHT_UP
,
3602 wxMouseEventHandler(wxPropertyGrid::OnMouseRightClickChild
),
3604 argWnd
->Connect(id
, wxEVT_ENTER_WINDOW
,
3605 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry
),
3607 argWnd
->Connect(id
, wxEVT_LEAVE_WINDOW
,
3608 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry
),
3612 wxPropertyGridEditorEventForwarder
* forwarder
;
3613 forwarder
= new wxPropertyGridEditorEventForwarder(this);
3614 argWnd
->PushEventHandler(forwarder
);
3616 argWnd
->Connect(id
, wxEVT_KEY_DOWN
,
3617 wxCharEventHandler(wxPropertyGrid::OnChildKeyDown
),
3621 void wxPropertyGrid::DestroyEditorWnd( wxWindow
* wnd
)
3628 // Do not free editors immediately (for sake of processing events)
3629 wxPendingDelete
.Append(wnd
);
3632 void wxPropertyGrid::FreeEditors()
3635 // Return focus back to canvas from children (this is required at least for
3636 // GTK+, which, unlike Windows, clears focus when control is destroyed
3637 // instead of moving it to closest parent).
3638 wxWindow
* focus
= wxWindow::FindFocus();
3641 wxWindow
* parent
= focus
->GetParent();
3644 if ( parent
== this )
3649 parent
= parent
->GetParent();
3653 // Do not free editors immediately if processing events
3656 wxEvtHandler
* handler
= m_wndEditor2
->PopEventHandler(false);
3657 m_wndEditor2
->Hide();
3658 wxPendingDelete
.Append( handler
);
3659 DestroyEditorWnd(m_wndEditor2
);
3660 m_wndEditor2
= NULL
;
3665 wxEvtHandler
* handler
= m_wndEditor
->PopEventHandler(false);
3666 m_wndEditor
->Hide();
3667 wxPendingDelete
.Append( handler
);
3668 DestroyEditorWnd(m_wndEditor
);
3673 // Call with NULL to de-select property
3674 bool wxPropertyGrid::DoSelectProperty( wxPGProperty
* p
, unsigned int flags
)
3679 wxLogDebug(wxT("SelectProperty( %s (%s[%i]) )"),p->m_label.c_str(),
3680 p->m_parent->m_label.c_str(),p->GetIndexInParent());
3684 wxLogDebug(wxT("SelectProperty( NULL, -1 )"));
3688 if ( m_inDoSelectProperty
)
3691 m_inDoSelectProperty
= 1;
3695 m_inDoSelectProperty
= 0;
3699 wxArrayPGProperty prevSelection
= m_pState
->m_selection
;
3700 wxPGProperty
* prevFirstSel
;
3702 if ( prevSelection
.size() > 0 )
3703 prevFirstSel
= prevSelection
[0];
3705 prevFirstSel
= NULL
;
3707 if ( prevFirstSel
&& prevFirstSel
->HasFlag(wxPG_PROP_BEING_DELETED
) )
3708 prevFirstSel
= NULL
;
3710 // Always send event, as this is indirect call
3711 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
);
3715 wxPrintf( "Selected %s\n", prevFirstSel->GetClassInfo()->GetClassName() );
3717 wxPrintf( "None selected\n" );
3720 wxPrintf( "P = %s\n", p->GetClassInfo()->GetClassName() );
3722 wxPrintf( "P = NULL\n" );
3725 // If we are frozen, then just set the values.
3728 m_iFlags
&= ~(wxPG_FL_ABNORMAL_EDITOR
);
3729 m_editorFocused
= 0;
3730 m_pState
->DoSetSelection(p
);
3732 // If frozen, always free controls. But don't worry, as Thaw will
3733 // recall SelectProperty to recreate them.
3736 // Prevent any further selection measures in this call
3742 if ( prevFirstSel
== p
&&
3743 prevSelection
.size() <= 1 &&
3744 !(flags
& wxPG_SEL_FORCE
) )
3746 // Only set focus if not deselecting
3749 if ( flags
& wxPG_SEL_FOCUS
)
3753 m_wndEditor
->SetFocus();
3754 m_editorFocused
= 1;
3763 m_inDoSelectProperty
= 0;
3768 // First, deactivate previous
3771 OnValidationFailureReset(prevFirstSel
);
3773 // Must double-check if this is an selected in case of forceswitch
3774 if ( p
!= prevFirstSel
)
3776 if ( !CommitChangesFromEditor(flags
) )
3778 // Validation has failed, so we can't exit the previous editor
3779 //::wxMessageBox(_("Please correct the value or press ESC to cancel the edit."),
3780 // _("Invalid Value"),wxOK|wxICON_ERROR);
3781 m_inDoSelectProperty
= 0;
3788 m_iFlags
&= ~(wxPG_FL_ABNORMAL_EDITOR
);
3789 EditorsValueWasNotModified();
3792 SetInternalFlag(wxPG_FL_IN_SELECT_PROPERTY
);
3794 m_pState
->DoSetSelection(p
);
3796 // Redraw unselected
3797 for ( unsigned int i
=0; i
<prevSelection
.size(); i
++ )
3799 DrawItem(prevSelection
[i
]);
3803 // Then, activate the one given.
3806 int propY
= p
->GetY2(m_lineHeight
);
3808 int splitterX
= GetSplitterPosition();
3809 m_editorFocused
= 0;
3810 m_iFlags
|= wxPG_FL_PRIMARY_FILLS_ENTIRE
;
3811 if ( p
!= prevFirstSel
)
3812 m_iFlags
&= ~(wxPG_FL_VALIDATION_FAILED
);
3814 wxASSERT( m_wndEditor
== NULL
);
3817 // Only create editor for non-disabled non-caption
3818 if ( !p
->IsCategory() && !(p
->m_flags
& wxPG_PROP_DISABLED
) )
3820 // do this for non-caption items
3824 // Do we need to paint the custom image, if any?
3825 m_iFlags
&= ~(wxPG_FL_CUR_USES_CUSTOM_IMAGE
);
3826 if ( (p
->m_flags
& wxPG_PROP_CUSTOMIMAGE
) &&
3827 !p
->GetEditorClass()->CanContainCustomImage()
3829 m_iFlags
|= wxPG_FL_CUR_USES_CUSTOM_IMAGE
;
3831 wxRect grect
= GetEditorWidgetRect(p
, m_selColumn
);
3832 wxPoint goodPos
= grect
.GetPosition();
3834 const wxPGEditor
* editor
= p
->GetEditorClass();
3835 wxCHECK_MSG(editor
, false,
3836 wxT("NULL editor class not allowed"));
3838 m_iFlags
&= ~wxPG_FL_FIXED_WIDTH_EDITOR
;
3840 wxPGWindowList wndList
=
3841 editor
->CreateControls(this,
3846 m_wndEditor
= wndList
.m_primary
;
3847 m_wndEditor2
= wndList
.m_secondary
;
3848 wxWindow
* primaryCtrl
= GetEditorControl();
3851 // Essentially, primaryCtrl == m_wndEditor
3854 // NOTE: It is allowed for m_wndEditor to be NULL - in this
3855 // case value is drawn as normal, and m_wndEditor2 is
3856 // assumed to be a right-aligned button that triggers
3857 // a separate editorCtrl window.
3861 wxASSERT_MSG( m_wndEditor
->GetParent() == GetPanel(),
3862 "CreateControls must use result of "
3863 "wxPropertyGrid::GetPanel() as parent "
3866 // Set validator, if any
3867 #if wxUSE_VALIDATORS
3868 wxValidator
* validator
= p
->GetValidator();
3870 primaryCtrl
->SetValidator(*validator
);
3873 if ( m_wndEditor
->GetSize().y
> (m_lineHeight
+6) )
3874 m_iFlags
|= wxPG_FL_ABNORMAL_EDITOR
;
3876 // If it has modified status, use bold font
3877 // (must be done before capturing m_ctrlXAdjust)
3878 if ( (p
->m_flags
& wxPG_PROP_MODIFIED
) &&
3879 (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3880 SetCurControlBoldFont();
3882 // Store x relative to splitter (we'll need it).
3883 m_ctrlXAdjust
= m_wndEditor
->GetPosition().x
- splitterX
;
3885 // Check if background clear is not necessary
3886 wxPoint pos
= m_wndEditor
->GetPosition();
3887 if ( pos
.x
> (splitterX
+1) || pos
.y
> propY
)
3889 m_iFlags
&= ~(wxPG_FL_PRIMARY_FILLS_ENTIRE
);
3892 m_wndEditor
->SetSizeHints(3, 3);
3894 SetupChildEventHandling(primaryCtrl
);
3896 // Focus and select all (wxTextCtrl, wxComboBox etc)
3897 if ( flags
& wxPG_SEL_FOCUS
)
3899 primaryCtrl
->SetFocus();
3901 p
->GetEditorClass()->OnFocus(p
, primaryCtrl
);
3907 wxASSERT_MSG( m_wndEditor2
->GetParent() == GetPanel(),
3908 "CreateControls must use result of "
3909 "wxPropertyGrid::GetPanel() as parent "
3912 // Get proper id for wndSecondary
3913 m_wndSecId
= m_wndEditor2
->GetId();
3914 wxWindowList children
= m_wndEditor2
->GetChildren();
3915 wxWindowList::iterator node
= children
.begin();
3916 if ( node
!= children
.end() )
3917 m_wndSecId
= ((wxWindow
*)*node
)->GetId();
3919 m_wndEditor2
->SetSizeHints(3,3);
3921 m_wndEditor2
->Show();
3923 SetupChildEventHandling(m_wndEditor2
);
3925 // If no primary editor, focus to button to allow
3926 // it to interprete ENTER etc.
3927 // NOTE: Due to problems focusing away from it, this
3928 // has been disabled.
3930 if ( (flags & wxPG_SEL_FOCUS) && !m_wndEditor )
3931 m_wndEditor2->SetFocus();
3935 if ( flags
& wxPG_SEL_FOCUS
)
3936 m_editorFocused
= 1;
3941 // Make sure focus is in grid canvas (important for wxGTK,
3946 EditorsValueWasNotModified();
3948 // If it's inside collapsed section, expand parent, scroll, etc.
3949 // Also, if it was partially visible, scroll it into view.
3950 if ( !(flags
& wxPG_SEL_NONVISIBLE
) )
3955 m_wndEditor
->Show(true);
3958 if ( !(flags
& wxPG_SEL_NO_REFRESH
) )
3963 // Make sure focus is in grid canvas
3967 ClearInternalFlag(wxPG_FL_IN_SELECT_PROPERTY
);
3973 // Show help text in status bar.
3974 // (if found and grid not embedded in manager with help box and
3975 // style wxPG_EX_HELP_AS_TOOLTIPS is not used).
3978 if ( !(GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS
) )
3980 wxStatusBar
* statusbar
= NULL
;
3981 if ( !(m_iFlags
& wxPG_FL_NOSTATUSBARHELP
) )
3983 wxFrame
* frame
= wxDynamicCast(::wxGetTopLevelParent(this),wxFrame
);
3985 statusbar
= frame
->GetStatusBar();
3990 const wxString
* pHelpString
= (const wxString
*) NULL
;
3994 pHelpString
= &p
->GetHelpString();
3995 if ( pHelpString
->length() )
3997 // Set help box text.
3998 statusbar
->SetStatusText( *pHelpString
);
3999 m_iFlags
|= wxPG_FL_STRING_IN_STATUSBAR
;
4003 if ( (!pHelpString
|| !pHelpString
->length()) &&
4004 (m_iFlags
& wxPG_FL_STRING_IN_STATUSBAR
) )
4006 // Clear help box - but only if it was written
4007 // by us at previous time.
4008 statusbar
->SetStatusText( m_emptyString
);
4009 m_iFlags
&= ~(wxPG_FL_STRING_IN_STATUSBAR
);
4015 m_inDoSelectProperty
= 0;
4017 // call wx event handler (here so that it also occurs on deselection)
4018 if ( !(flags
& wxPG_SEL_DONT_SEND_EVENT
) )
4019 SendEvent( wxEVT_PG_SELECTED
, p
, NULL
);
4024 // -----------------------------------------------------------------------
4026 bool wxPropertyGrid::UnfocusEditor()
4028 wxPGProperty
* selected
= GetSelection();
4030 if ( !selected
|| !m_wndEditor
|| m_frozen
)
4033 if ( !CommitChangesFromEditor(0) )
4042 // -----------------------------------------------------------------------
4044 void wxPropertyGrid::RefreshEditor()
4046 wxPGProperty
* p
= GetSelection();
4050 wxWindow
* wnd
= GetEditorControl();
4054 // Set editor font boldness - must do this before
4055 // calling UpdateControl().
4056 if ( HasFlag(wxPG_BOLD_MODIFIED
) )
4058 if ( p
->HasFlag(wxPG_PROP_MODIFIED
) )
4059 wnd
->SetFont(GetCaptionFont());
4061 wnd
->SetFont(GetFont());
4064 const wxPGEditor
* editorClass
= p
->GetEditorClass();
4066 editorClass
->UpdateControl(p
, wnd
);
4068 if ( p
->IsValueUnspecified() )
4069 editorClass
->SetValueToUnspecified(p
, wnd
);
4072 // -----------------------------------------------------------------------
4074 bool wxPropertyGrid::SelectProperty( wxPGPropArg id
, bool focus
)
4076 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
4078 int flags
= wxPG_SEL_DONT_SEND_EVENT
;
4080 flags
|= wxPG_SEL_FOCUS
;
4082 return DoSelectProperty(p
, flags
);
4085 // -----------------------------------------------------------------------
4086 // wxPropertyGrid expand/collapse state
4087 // -----------------------------------------------------------------------
4089 bool wxPropertyGrid::DoCollapse( wxPGProperty
* p
, bool sendEvents
)
4091 wxPGProperty
* pwc
= wxStaticCast(p
, wxPGProperty
);
4092 wxPGProperty
* selected
= GetSelection();
4094 // If active editor was inside collapsed section, then disable it
4095 if ( selected
&& selected
->IsSomeParent(p
) )
4100 // Store dont-center-splitter flag 'cause we need to temporarily set it
4101 bool prevDontCenterSplitter
= m_pState
->m_dontCenterSplitter
;
4102 m_pState
->m_dontCenterSplitter
= true;
4104 bool res
= m_pState
->DoCollapse(pwc
);
4109 SendEvent( wxEVT_PG_ITEM_COLLAPSED
, p
);
4111 RecalculateVirtualSize();
4115 m_pState
->m_dontCenterSplitter
= prevDontCenterSplitter
;
4120 // -----------------------------------------------------------------------
4122 bool wxPropertyGrid::DoExpand( wxPGProperty
* p
, bool sendEvents
)
4124 wxCHECK_MSG( p
, false, wxT("invalid property id") );
4126 wxPGProperty
* pwc
= (wxPGProperty
*)p
;
4128 // Store dont-center-splitter flag 'cause we need to temporarily set it
4129 bool prevDontCenterSplitter
= m_pState
->m_dontCenterSplitter
;
4130 m_pState
->m_dontCenterSplitter
= true;
4132 bool res
= m_pState
->DoExpand(pwc
);
4137 SendEvent( wxEVT_PG_ITEM_EXPANDED
, p
);
4139 RecalculateVirtualSize();
4143 m_pState
->m_dontCenterSplitter
= prevDontCenterSplitter
;
4148 // -----------------------------------------------------------------------
4150 bool wxPropertyGrid::DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
)
4153 return m_pState
->DoHideProperty(p
, hide
, flags
);
4155 wxArrayPGProperty selection
= m_pState
->m_selection
; // Must use a copy
4156 int selRemoveCount
= 0;
4157 for ( unsigned int i
=0; i
<selection
.size(); i
++ )
4159 wxPGProperty
* selected
= selection
[i
];
4160 if ( selected
== p
|| selected
->IsSomeParent(p
) )
4162 if ( !DoRemoveFromSelection(p
, flags
) )
4164 selRemoveCount
+= 1;
4168 m_pState
->DoHideProperty(p
, hide
, flags
);
4170 RecalculateVirtualSize();
4177 // -----------------------------------------------------------------------
4178 // wxPropertyGrid size related methods
4179 // -----------------------------------------------------------------------
4181 void wxPropertyGrid::RecalculateVirtualSize( int forceXPos
)
4183 if ( (m_iFlags
& wxPG_FL_RECALCULATING_VIRTUAL_SIZE
) || m_frozen
)
4187 // If virtual height was changed, then recalculate editor control position(s)
4188 if ( m_pState
->m_vhCalcPending
)
4189 CorrectEditorWidgetPosY();
4191 m_pState
->EnsureVirtualHeight();
4193 wxASSERT_LEVEL_2_MSG(
4194 m_pState
->GetVirtualHeight() == m_pState
->GetActualVirtualHeight(),
4195 "VirtualHeight and ActualVirtualHeight should match"
4198 m_iFlags
|= wxPG_FL_RECALCULATING_VIRTUAL_SIZE
;
4200 int x
= m_pState
->m_width
;
4201 int y
= m_pState
->m_virtualHeight
;
4204 GetClientSize(&width
,&height
);
4206 // Now adjust virtual size.
4207 SetVirtualSize(x
, y
);
4213 // Adjust scrollbars
4214 if ( HasVirtualWidth() )
4216 xAmount
= x
/wxPG_PIXELS_PER_UNIT
;
4217 xPos
= GetScrollPos( wxHORIZONTAL
);
4220 if ( forceXPos
!= -1 )
4223 else if ( xPos
> (xAmount
-(width
/wxPG_PIXELS_PER_UNIT
)) )
4226 int yAmount
= y
/ wxPG_PIXELS_PER_UNIT
;
4227 int yPos
= GetScrollPos( wxVERTICAL
);
4229 SetScrollbars( wxPG_PIXELS_PER_UNIT
, wxPG_PIXELS_PER_UNIT
,
4230 xAmount
, yAmount
, xPos
, yPos
, true );
4232 // Must re-get size now
4233 GetClientSize(&width
,&height
);
4235 if ( !HasVirtualWidth() )
4237 m_pState
->SetVirtualWidth(width
);
4244 m_pState
->CheckColumnWidths();
4246 if ( GetSelection() )
4247 CorrectEditorWidgetSizeX();
4249 m_iFlags
&= ~wxPG_FL_RECALCULATING_VIRTUAL_SIZE
;
4252 // -----------------------------------------------------------------------
4254 void wxPropertyGrid::OnResize( wxSizeEvent
& event
)
4256 if ( !(m_iFlags
& wxPG_FL_INITIALIZED
) )
4260 GetClientSize(&width
, &height
);
4265 #if wxPG_DOUBLE_BUFFER
4266 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING
) )
4268 int dblh
= (m_lineHeight
*2);
4269 if ( !m_doubleBuffer
)
4271 // Create double buffer bitmap to draw on, if none
4272 int w
= (width
>250)?width
:250;
4273 int h
= height
+ dblh
;
4275 m_doubleBuffer
= new wxBitmap( w
, h
);
4279 int w
= m_doubleBuffer
->GetWidth();
4280 int h
= m_doubleBuffer
->GetHeight();
4282 // Double buffer must be large enough
4283 if ( w
< width
|| h
< (height
+dblh
) )
4285 if ( w
< width
) w
= width
;
4286 if ( h
< (height
+dblh
) ) h
= height
+ dblh
;
4287 delete m_doubleBuffer
;
4288 m_doubleBuffer
= new wxBitmap( w
, h
);
4295 m_pState
->OnClientWidthChange( width
, event
.GetSize().x
- m_ncWidth
, true );
4296 m_ncWidth
= event
.GetSize().x
;
4300 if ( m_pState
->m_itemsAdded
)
4301 PrepareAfterItemsAdded();
4303 // Without this, virtual size (atleast under wxGTK) will be skewed
4304 RecalculateVirtualSize();
4310 // -----------------------------------------------------------------------
4312 void wxPropertyGrid::SetVirtualWidth( int width
)
4316 // Disable virtual width
4317 width
= GetClientSize().x
;
4318 ClearInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH
);
4322 // Enable virtual width
4323 SetInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH
);
4325 m_pState
->SetVirtualWidth( width
);
4328 void wxPropertyGrid::SetFocusOnCanvas()
4330 SetFocusIgnoringChildren();
4331 m_editorFocused
= 0;
4334 // -----------------------------------------------------------------------
4335 // wxPropertyGrid mouse event handling
4336 // -----------------------------------------------------------------------
4338 // selFlags uses same values DoSelectProperty's flags
4339 // Returns true if event was vetoed.
4340 bool wxPropertyGrid::SendEvent( int eventType
, wxPGProperty
* p
,
4342 unsigned int selFlags
,
4343 unsigned int column
)
4345 // Send property grid event of specific type and with specific property
4346 wxPropertyGridEvent
evt( eventType
, m_eventObject
->GetId() );
4347 evt
.SetPropertyGrid(this);
4348 evt
.SetEventObject(m_eventObject
);
4350 evt
.SetColumn(column
);
4351 if ( eventType
== wxEVT_PG_CHANGING
)
4354 evt
.SetCanVeto(true);
4355 m_validationInfo
.m_pValue
= pValue
;
4356 evt
.SetupValidationInfo();
4361 evt
.SetPropertyValue(p
->GetValue());
4363 if ( !(selFlags
& wxPG_SEL_NOVALIDATE
) )
4364 evt
.SetCanVeto(true);
4367 m_processedEvent
= &evt
;
4368 m_eventObject
->HandleWindowEvent(evt
);
4369 m_processedEvent
= NULL
;
4371 return evt
.WasVetoed();
4374 // -----------------------------------------------------------------------
4376 // Return false if should be skipped
4377 bool wxPropertyGrid::HandleMouseClick( int x
, unsigned int y
, wxMouseEvent
&event
)
4381 // Need to set focus?
4382 if ( !(m_iFlags
& wxPG_FL_FOCUSED
) )
4387 wxPropertyGridPageState
* state
= m_pState
;
4389 int splitterHitOffset
;
4390 int columnHit
= state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4392 wxPGProperty
* p
= DoGetItemAtY(y
);
4396 int depth
= (int)p
->GetDepth() - 1;
4398 int marginEnds
= m_marginWidth
+ ( depth
* m_subgroup_extramargin
);
4400 if ( x
>= marginEnds
)
4404 if ( p
->IsCategory() )
4406 // This is category.
4407 wxPropertyCategory
* pwc
= (wxPropertyCategory
*)p
;
4409 int textX
= m_marginWidth
+ ((unsigned int)((pwc
->m_depth
-1)*m_subgroup_extramargin
));
4411 // Expand, collapse, activate etc. if click on text or left of splitter.
4414 ( x
< (textX
+pwc
->GetTextExtent(this, m_captionFont
)+(wxPG_CAPRECTXMARGIN
*2)) ||
4419 if ( !AddToSelectionFromInputEvent( p
,
4424 // On double-click, expand/collapse.
4425 if ( event
.ButtonDClick() && !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
4427 if ( pwc
->IsExpanded() ) DoCollapse( p
, true );
4428 else DoExpand( p
, true );
4432 else if ( splitterHit
== -1 )
4435 unsigned int selFlag
= 0;
4436 if ( columnHit
== 1 )
4438 m_iFlags
|= wxPG_FL_ACTIVATION_BY_CLICK
;
4439 selFlag
= wxPG_SEL_FOCUS
;
4441 if ( !AddToSelectionFromInputEvent( p
,
4447 m_iFlags
&= ~(wxPG_FL_ACTIVATION_BY_CLICK
);
4449 if ( p
->GetChildCount() && !p
->IsCategory() )
4450 // On double-click, expand/collapse.
4451 if ( event
.ButtonDClick() && !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
4453 wxPGProperty
* pwc
= (wxPGProperty
*)p
;
4454 if ( pwc
->IsExpanded() ) DoCollapse( p
, true );
4455 else DoExpand( p
, true );
4462 // click on splitter
4463 if ( !(m_windowStyle
& wxPG_STATIC_SPLITTER
) )
4465 if ( event
.GetEventType() == wxEVT_LEFT_DCLICK
)
4467 // Double-clicking the splitter causes auto-centering
4468 CenterSplitter( true );
4470 else if ( m_dragStatus
== 0 )
4473 // Begin draggin the splitter
4477 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
);
4481 // Changes must be committed here or the
4482 // value won't be drawn correctly
4483 if ( !CommitChangesFromEditor() )
4486 m_wndEditor
->Show ( false );
4489 if ( !(m_iFlags
& wxPG_FL_MOUSE_CAPTURED
) )
4492 m_iFlags
|= wxPG_FL_MOUSE_CAPTURED
;
4496 m_draggedSplitter
= splitterHit
;
4497 m_dragOffset
= splitterHitOffset
;
4499 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4500 // Fixes button disappearance bug
4502 m_wndEditor2
->Show ( false );
4505 m_startingSplitterX
= x
- splitterHitOffset
;
4513 if ( p
->GetChildCount() )
4515 int nx
= x
+ m_marginWidth
- marginEnds
; // Normalize x.
4517 // Fine tune cell button x
4518 if ( !p
->IsCategory() )
4519 nx
-= IN_CELL_EXPANDER_BUTTON_X_ADJUST
;
4521 if ( (nx
>= m_gutterWidth
&& nx
< (m_gutterWidth
+m_iconWidth
)) )
4523 int y2
= y
% m_lineHeight
;
4524 if ( (y2
>= m_buttonSpacingY
&& y2
< (m_buttonSpacingY
+m_iconHeight
)) )
4526 // On click on expander button, expand/collapse
4527 if ( ((wxPGProperty
*)p
)->IsExpanded() )
4528 DoCollapse( p
, true );
4530 DoExpand( p
, true );
4539 // -----------------------------------------------------------------------
4541 bool wxPropertyGrid::HandleMouseRightClick( int WXUNUSED(x
),
4542 unsigned int WXUNUSED(y
),
4543 wxMouseEvent
& event
)
4547 // Select property here as well
4548 wxPGProperty
* p
= m_propHover
;
4549 AddToSelectionFromInputEvent(p
, m_colHover
, &event
);
4551 // Send right click event.
4552 SendEvent( wxEVT_PG_RIGHT_CLICK
, p
);
4559 // -----------------------------------------------------------------------
4561 bool wxPropertyGrid::HandleMouseDoubleClick( int WXUNUSED(x
),
4562 unsigned int WXUNUSED(y
),
4563 wxMouseEvent
& event
)
4567 // Select property here as well
4568 wxPGProperty
* p
= m_propHover
;
4570 AddToSelectionFromInputEvent(p
, m_colHover
, &event
);
4572 // Send double-click event.
4573 SendEvent( wxEVT_PG_DOUBLE_CLICK
, m_propHover
);
4580 // -----------------------------------------------------------------------
4582 #if wxPG_SUPPORT_TOOLTIPS
4584 void wxPropertyGrid::SetToolTip( const wxString
& tipString
)
4586 if ( tipString
.length() )
4588 wxScrolledWindow::SetToolTip(tipString
);
4592 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4593 wxScrolledWindow::SetToolTip( m_emptyString
);
4595 wxScrolledWindow::SetToolTip( NULL
);
4600 #endif // #if wxPG_SUPPORT_TOOLTIPS
4602 // -----------------------------------------------------------------------
4604 // Return false if should be skipped
4605 bool wxPropertyGrid::HandleMouseMove( int x
, unsigned int y
,
4606 wxMouseEvent
&event
)
4608 // Safety check (needed because mouse capturing may
4609 // otherwise freeze the control)
4610 if ( m_dragStatus
> 0 && !event
.Dragging() )
4612 HandleMouseUp(x
, y
, event
);
4615 wxPropertyGridPageState
* state
= m_pState
;
4617 int splitterHitOffset
;
4618 int columnHit
= state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4619 int splitterX
= x
- splitterHitOffset
;
4621 m_colHover
= columnHit
;
4623 if ( m_dragStatus
> 0 )
4625 if ( x
> (m_marginWidth
+ wxPG_DRAG_MARGIN
) &&
4626 x
< (m_pState
->m_width
- wxPG_DRAG_MARGIN
) )
4629 int newSplitterX
= x
- m_dragOffset
;
4630 int splitterX
= x
- splitterHitOffset
;
4632 // Splitter redraw required?
4633 if ( newSplitterX
!= splitterX
)
4636 state
->m_dontCenterSplitter
= true;
4637 state
->DoSetSplitterPosition(newSplitterX
,
4640 state
->m_fSplitterX
= (float) newSplitterX
;
4642 if ( GetSelection() )
4643 CorrectEditorWidgetSizeX();
4657 int ih
= m_lineHeight
;
4660 #if wxPG_SUPPORT_TOOLTIPS
4661 wxPGProperty
* prevHover
= m_propHover
;
4662 unsigned char prevSide
= m_mouseSide
;
4664 int curPropHoverY
= y
- (y
% ih
);
4666 // On which item it hovers
4669 ( sy
< m_propHoverY
|| sy
>= (m_propHoverY
+ih
) )
4672 // Mouse moves on another property
4674 m_propHover
= DoGetItemAtY(y
);
4675 m_propHoverY
= curPropHoverY
;
4678 SendEvent( wxEVT_PG_HIGHLIGHTED
, m_propHover
);
4681 #if wxPG_SUPPORT_TOOLTIPS
4682 // Store which side we are on
4684 if ( columnHit
== 1 )
4686 else if ( columnHit
== 0 )
4690 // If tooltips are enabled, show label or value as a tip
4691 // in case it doesn't otherwise show in full length.
4693 if ( m_windowStyle
& wxPG_TOOLTIPS
)
4695 wxToolTip
* tooltip
= GetToolTip();
4697 if ( m_propHover
!= prevHover
|| prevSide
!= m_mouseSide
)
4699 if ( m_propHover
&& !m_propHover
->IsCategory() )
4702 if ( GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS
)
4704 // Show help string as a tooltip
4705 wxString tipString
= m_propHover
->GetHelpString();
4707 SetToolTip(tipString
);
4711 // Show cropped value string as a tooltip
4715 if ( m_mouseSide
== 1 )
4717 tipString
= m_propHover
->m_label
;
4718 space
= splitterX
-m_marginWidth
-3;
4720 else if ( m_mouseSide
== 2 )
4722 tipString
= m_propHover
->GetDisplayedString();
4724 space
= m_width
- splitterX
;
4725 if ( m_propHover
->m_flags
& wxPG_PROP_CUSTOMIMAGE
)
4726 space
-= wxPG_CUSTOM_IMAGE_WIDTH
+
4727 wxCC_CUSTOM_IMAGE_MARGIN1
+
4728 wxCC_CUSTOM_IMAGE_MARGIN2
;
4734 GetTextExtent( tipString
, &tw
, &th
, 0, 0 );
4737 SetToolTip( tipString
);
4744 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4745 SetToolTip( m_emptyString
);
4747 wxScrolledWindow::SetToolTip( NULL
);
4758 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4759 SetToolTip( m_emptyString
);
4761 wxScrolledWindow::SetToolTip( NULL
);
4769 if ( splitterHit
== -1 ||
4771 HasFlag(wxPG_STATIC_SPLITTER
) )
4773 // hovering on something else
4774 if ( m_curcursor
!= wxCURSOR_ARROW
)
4775 CustomSetCursor( wxCURSOR_ARROW
);
4779 // Do not allow splitter cursor on caption items.
4780 // (also not if we were dragging and its started
4781 // outside the splitter region)
4783 if ( !m_propHover
->IsCategory() &&
4787 // hovering on splitter
4789 // NB: Condition disabled since MouseLeave event (from the
4790 // editor control) cannot be reliably detected.
4791 //if ( m_curcursor != wxCURSOR_SIZEWE )
4792 CustomSetCursor( wxCURSOR_SIZEWE
, true );
4798 // hovering on something else
4799 if ( m_curcursor
!= wxCURSOR_ARROW
)
4800 CustomSetCursor( wxCURSOR_ARROW
);
4805 // Multi select by dragging
4807 if ( (GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
) &&
4808 event
.LeftIsDown() &&
4812 !state
->DoIsPropertySelected(m_propHover
) )
4814 // Additional requirement is that the hovered property
4815 // is adjacent to edges of selection.
4816 const wxArrayPGProperty
& selection
= GetSelectedProperties();
4818 // Since categories cannot be selected along with 'other'
4819 // properties, exclude them from iterator flags.
4820 int iterFlags
= wxPG_ITERATE_VISIBLE
& (~wxPG_PROP_CATEGORY
);
4822 for ( int i
=(selection
.size()-1); i
>=0; i
-- )
4824 // TODO: This could be optimized by keeping track of
4825 // which properties are at the edges of selection.
4826 wxPGProperty
* selProp
= selection
[i
];
4827 if ( state
->ArePropertiesAdjacent(m_propHover
, selProp
,
4830 DoAddToSelection(m_propHover
);
4839 // -----------------------------------------------------------------------
4841 // Also handles Leaving event
4842 bool wxPropertyGrid::HandleMouseUp( int x
, unsigned int WXUNUSED(y
),
4843 wxMouseEvent
&WXUNUSED(event
) )
4845 wxPropertyGridPageState
* state
= m_pState
;
4849 int splitterHitOffset
;
4850 state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4852 // No event type check - basicly calling this method should
4853 // just stop dragging.
4854 // Left up after dragged?
4855 if ( m_dragStatus
>= 1 )
4858 // End Splitter Dragging
4860 // DO NOT ENABLE FOLLOWING LINE!
4861 // (it is only here as a reminder to not to do it)
4864 // Disable splitter auto-centering
4865 state
->m_dontCenterSplitter
= true;
4867 // This is necessary to return cursor
4868 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
4871 m_iFlags
&= ~(wxPG_FL_MOUSE_CAPTURED
);
4874 // Set back the default cursor, if necessary
4875 if ( splitterHit
== -1 ||
4878 CustomSetCursor( wxCURSOR_ARROW
);
4883 // Control background needs to be cleared
4884 wxPGProperty
* selected
= GetSelection();
4885 if ( !(m_iFlags
& wxPG_FL_PRIMARY_FILLS_ENTIRE
) && selected
)
4886 DrawItem( selected
);
4890 m_wndEditor
->Show ( true );
4893 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4894 // Fixes button disappearance bug
4896 m_wndEditor2
->Show ( true );
4899 // This clears the focus.
4900 m_editorFocused
= 0;
4906 // -----------------------------------------------------------------------
4908 bool wxPropertyGrid::OnMouseCommon( wxMouseEvent
& event
, int* px
, int* py
)
4910 int splitterX
= GetSplitterPosition();
4913 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &ux
, &uy
);
4915 wxWindow
* wnd
= GetEditorControl();
4917 // Hide popup on clicks
4918 if ( event
.GetEventType() != wxEVT_MOTION
)
4919 if ( wnd
&& wnd
->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox
)) )
4921 ((wxOwnerDrawnComboBox
*)wnd
)->HidePopup();
4927 if ( wnd
== NULL
|| m_dragStatus
||
4929 ux
<= (splitterX
+ wxPG_SPLITTERX_DETECTMARGIN2
) ||
4930 ux
>= (r
.x
+r
.width
) ||
4932 event
.m_y
>= (r
.y
+r
.height
)
4942 if ( m_curcursor
!= wxCURSOR_ARROW
) CustomSetCursor ( wxCURSOR_ARROW
);
4947 // -----------------------------------------------------------------------
4949 void wxPropertyGrid::OnMouseClick( wxMouseEvent
&event
)
4952 if ( OnMouseCommon( event
, &x
, &y
) )
4954 HandleMouseClick(x
,y
,event
);
4959 // -----------------------------------------------------------------------
4961 void wxPropertyGrid::OnMouseRightClick( wxMouseEvent
&event
)
4964 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &x
, &y
);
4965 HandleMouseRightClick(x
,y
,event
);
4969 // -----------------------------------------------------------------------
4971 void wxPropertyGrid::OnMouseDoubleClick( wxMouseEvent
&event
)
4973 // Always run standard mouse-down handler as well
4974 OnMouseClick(event
);
4977 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &x
, &y
);
4978 HandleMouseDoubleClick(x
,y
,event
);
4982 // -----------------------------------------------------------------------
4984 void wxPropertyGrid::OnMouseMove( wxMouseEvent
&event
)
4987 if ( OnMouseCommon( event
, &x
, &y
) )
4989 HandleMouseMove(x
,y
,event
);
4994 // -----------------------------------------------------------------------
4996 void wxPropertyGrid::OnMouseUp( wxMouseEvent
&event
)
4999 if ( OnMouseCommon( event
, &x
, &y
) )
5001 HandleMouseUp(x
,y
,event
);
5006 // -----------------------------------------------------------------------
5008 void wxPropertyGrid::OnMouseEntry( wxMouseEvent
&event
)
5010 // This may get called from child control as well, so event's
5011 // mouse position cannot be relied on.
5013 if ( event
.Entering() )
5015 if ( !(m_iFlags
& wxPG_FL_MOUSE_INSIDE
) )
5017 // TODO: Fix this (detect parent and only do
5018 // cursor trick if it is a manager).
5019 wxASSERT( GetParent() );
5020 GetParent()->SetCursor(wxNullCursor
);
5022 m_iFlags
|= wxPG_FL_MOUSE_INSIDE
;
5025 GetParent()->SetCursor(wxNullCursor
);
5027 else if ( event
.Leaving() )
5029 // Without this, wxSpinCtrl editor will sometimes have wrong cursor
5030 SetCursor( wxNullCursor
);
5032 // Get real cursor position
5033 wxPoint pt
= ScreenToClient(::wxGetMousePosition());
5035 if ( ( pt
.x
<= 0 || pt
.y
<= 0 || pt
.x
>= m_width
|| pt
.y
>= m_height
) )
5038 if ( (m_iFlags
& wxPG_FL_MOUSE_INSIDE
) )
5040 m_iFlags
&= ~(wxPG_FL_MOUSE_INSIDE
);
5044 wxPropertyGrid::HandleMouseUp ( -1, 10000, event
);
5052 // -----------------------------------------------------------------------
5054 // Common code used by various OnMouseXXXChild methods.
5055 bool wxPropertyGrid::OnMouseChildCommon( wxMouseEvent
&event
, int* px
, int *py
)
5057 wxWindow
* topCtrlWnd
= (wxWindow
*)event
.GetEventObject();
5058 wxASSERT( topCtrlWnd
);
5060 event
.GetPosition(&x
,&y
);
5062 int splitterX
= GetSplitterPosition();
5064 wxRect r
= topCtrlWnd
->GetRect();
5065 if ( !m_dragStatus
&&
5066 x
> (splitterX
-r
.x
+wxPG_SPLITTERX_DETECTMARGIN2
) &&
5067 y
>= 0 && y
< r
.height \
5070 if ( m_curcursor
!= wxCURSOR_ARROW
) CustomSetCursor ( wxCURSOR_ARROW
);
5075 CalcUnscrolledPosition( event
.m_x
+ r
.x
, event
.m_y
+ r
.y
, \
5082 void wxPropertyGrid::OnMouseClickChild( wxMouseEvent
&event
)
5085 if ( OnMouseChildCommon(event
,&x
,&y
) )
5087 bool res
= HandleMouseClick(x
,y
,event
);
5088 if ( !res
) event
.Skip();
5092 void wxPropertyGrid::OnMouseRightClickChild( wxMouseEvent
&event
)
5095 wxASSERT( m_wndEditor
);
5096 // These coords may not be exact (about +-2),
5097 // but that should not matter (right click is about item, not position).
5098 wxPoint pt
= m_wndEditor
->GetPosition();
5099 CalcUnscrolledPosition( event
.m_x
+ pt
.x
, event
.m_y
+ pt
.y
, &x
, &y
);
5101 // FIXME: Used to set m_propHover to selection here. Was it really
5104 bool res
= HandleMouseRightClick(x
,y
,event
);
5105 if ( !res
) event
.Skip();
5108 void wxPropertyGrid::OnMouseMoveChild( wxMouseEvent
&event
)
5111 if ( OnMouseChildCommon(event
,&x
,&y
) )
5113 bool res
= HandleMouseMove(x
,y
,event
);
5114 if ( !res
) event
.Skip();
5118 void wxPropertyGrid::OnMouseUpChild( wxMouseEvent
&event
)
5121 if ( OnMouseChildCommon(event
,&x
,&y
) )
5123 bool res
= HandleMouseUp(x
,y
,event
);
5124 if ( !res
) event
.Skip();
5128 // -----------------------------------------------------------------------
5129 // wxPropertyGrid keyboard event handling
5130 // -----------------------------------------------------------------------
5132 int wxPropertyGrid::KeyEventToActions(wxKeyEvent
&event
, int* pSecond
) const
5134 // Translates wxKeyEvent to wxPG_ACTION_XXX
5136 int keycode
= event
.GetKeyCode();
5137 int modifiers
= event
.GetModifiers();
5139 wxASSERT( !(modifiers
&~(0xFFFF)) );
5141 int hashMapKey
= (keycode
& 0xFFFF) | ((modifiers
& 0xFFFF) << 16);
5143 wxPGHashMapI2I::const_iterator it
= m_actionTriggers
.find(hashMapKey
);
5145 if ( it
== m_actionTriggers
.end() )
5150 int second
= (it
->second
>>16) & 0xFFFF;
5154 return (it
->second
& 0xFFFF);
5157 void wxPropertyGrid::AddActionTrigger( int action
, int keycode
, int modifiers
)
5159 wxASSERT( !(modifiers
&~(0xFFFF)) );
5161 int hashMapKey
= (keycode
& 0xFFFF) | ((modifiers
& 0xFFFF) << 16);
5163 wxPGHashMapI2I::iterator it
= m_actionTriggers
.find(hashMapKey
);
5165 if ( it
!= m_actionTriggers
.end() )
5167 // This key combination is already used
5169 // Can add secondary?
5170 wxASSERT_MSG( !(it
->second
&~(0xFFFF)),
5171 wxT("You can only add up to two separate actions per key combination.") );
5173 action
= it
->second
| (action
<<16);
5176 m_actionTriggers
[hashMapKey
] = action
;
5179 void wxPropertyGrid::ClearActionTriggers( int action
)
5181 wxPGHashMapI2I::iterator it
;
5186 didSomething
= false;
5188 for ( it
= m_actionTriggers
.begin();
5189 it
!= m_actionTriggers
.end();
5192 if ( it
->second
== action
)
5194 m_actionTriggers
.erase(it
);
5195 didSomething
= true;
5200 while ( didSomething
);
5203 void wxPropertyGrid::HandleKeyEvent( wxKeyEvent
&event
, bool fromChild
)
5206 // Handles key event when editor control is not focused.
5209 wxCHECK2(!m_frozen
, return);
5211 // Travelsal between items, collapsing/expanding, etc.
5212 wxPGProperty
* selected
= GetSelection();
5213 int keycode
= event
.GetKeyCode();
5214 bool editorFocused
= IsEditorFocused();
5216 if ( keycode
== WXK_TAB
)
5218 wxWindow
* mainControl
;
5220 if ( HasInternalFlag(wxPG_FL_IN_MANAGER
) )
5221 mainControl
= GetParent();
5225 if ( !event
.ShiftDown() )
5227 if ( !editorFocused
&& m_wndEditor
)
5229 DoSelectProperty( selected
, wxPG_SEL_FOCUS
);
5233 // Tab traversal workaround for platforms on which
5234 // wxWindow::Navigate() may navigate into first child
5235 // instead of next sibling. Does not work perfectly
5236 // in every scenario (for instance, when property grid
5237 // is either first or last control).
5238 #if defined(__WXGTK__)
5239 wxWindow
* sibling
= mainControl
->GetNextSibling();
5241 sibling
->SetFocusFromKbd();
5243 Navigate(wxNavigationKeyEvent::IsForward
);
5249 if ( editorFocused
)
5255 #if defined(__WXGTK__)
5256 wxWindow
* sibling
= mainControl
->GetPrevSibling();
5258 sibling
->SetFocusFromKbd();
5260 Navigate(wxNavigationKeyEvent::IsBackward
);
5268 // Ignore Alt and Control when they are down alone
5269 if ( keycode
== WXK_ALT
||
5270 keycode
== WXK_CONTROL
)
5277 int action
= KeyEventToActions(event
, &secondAction
);
5279 if ( editorFocused
&& action
== wxPG_ACTION_CANCEL_EDIT
)
5282 // Esc cancels any changes
5283 if ( IsEditorsValueModified() )
5285 EditorsValueWasNotModified();
5287 // Update the control as well
5288 selected
->GetEditorClass()->
5289 SetControlStringValue( selected
,
5291 selected
->GetDisplayedString() );
5294 OnValidationFailureReset(selected
);
5300 // Except for TAB and ESC, handle child control events in child control
5303 // Only propagate event if it had modifiers
5304 if ( !event
.HasModifiers() )
5306 event
.StopPropagation();
5312 bool wasHandled
= false;
5317 if ( ButtonTriggerKeyTest(action
, event
) )
5320 wxPGProperty
* p
= selected
;
5322 // Travel and expand/collapse
5325 if ( p
->GetChildCount() )
5327 if ( action
== wxPG_ACTION_COLLAPSE_PROPERTY
|| secondAction
== wxPG_ACTION_COLLAPSE_PROPERTY
)
5329 if ( (m_windowStyle
& wxPG_HIDE_MARGIN
) || Collapse(p
) )
5332 else if ( action
== wxPG_ACTION_EXPAND_PROPERTY
|| secondAction
== wxPG_ACTION_EXPAND_PROPERTY
)
5334 if ( (m_windowStyle
& wxPG_HIDE_MARGIN
) || Expand(p
) )
5341 if ( action
== wxPG_ACTION_PREV_PROPERTY
|| secondAction
== wxPG_ACTION_PREV_PROPERTY
)
5345 else if ( action
== wxPG_ACTION_NEXT_PROPERTY
|| secondAction
== wxPG_ACTION_NEXT_PROPERTY
)
5351 if ( selectDir
>= -1 )
5353 p
= wxPropertyGridIterator::OneStep( m_pState
, wxPG_ITERATE_VISIBLE
, p
, selectDir
);
5355 DoSelectProperty(p
);
5361 // If nothing was selected, select the first item now
5362 // (or navigate out of tab).
5363 if ( action
!= wxPG_ACTION_CANCEL_EDIT
&& secondAction
!= wxPG_ACTION_CANCEL_EDIT
)
5365 wxPGProperty
* p
= wxPropertyGridInterface::GetFirst();
5366 if ( p
) DoSelectProperty(p
);
5375 // -----------------------------------------------------------------------
5377 void wxPropertyGrid::OnKey( wxKeyEvent
&event
)
5379 // If there was editor open and focused, then this event should not
5380 // really be processed here.
5381 if ( IsEditorFocused() )
5383 // However, if event had modifiers, it is probably still best
5385 if ( event
.HasModifiers() )
5388 event
.StopPropagation();
5392 HandleKeyEvent(event
, false);
5395 // -----------------------------------------------------------------------
5397 bool wxPropertyGrid::ButtonTriggerKeyTest( int action
, wxKeyEvent
& event
)
5402 action
= KeyEventToActions(event
, &secondAction
);
5405 // Does the keycode trigger button?
5406 if ( action
== wxPG_ACTION_PRESS_BUTTON
&&
5409 wxCommandEvent
evt(wxEVT_COMMAND_BUTTON_CLICKED
, m_wndEditor2
->GetId());
5410 GetEventHandler()->AddPendingEvent(evt
);
5417 // -----------------------------------------------------------------------
5419 void wxPropertyGrid::OnChildKeyDown( wxKeyEvent
&event
)
5421 HandleKeyEvent(event
, true);
5424 // -----------------------------------------------------------------------
5425 // wxPropertyGrid miscellaneous event handling
5426 // -----------------------------------------------------------------------
5428 void wxPropertyGrid::OnIdle( wxIdleEvent
& WXUNUSED(event
) )
5431 // Check if the focus is in this control or one of its children
5432 wxWindow
* newFocused
= wxWindow::FindFocus();
5434 if ( newFocused
!= m_curFocused
)
5435 HandleFocusChange( newFocused
);
5438 // Check if top-level parent has changed
5439 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING
)
5441 wxWindow
* tlp
= ::wxGetTopLevelParent(this);
5447 bool wxPropertyGrid::IsEditorFocused() const
5449 wxWindow
* focus
= wxWindow::FindFocus();
5451 if ( focus
== m_wndEditor
|| focus
== m_wndEditor2
||
5452 focus
== GetEditorControl() )
5458 // Called by focus event handlers. newFocused is the window that becomes focused.
5459 void wxPropertyGrid::HandleFocusChange( wxWindow
* newFocused
)
5461 unsigned int oldFlags
= m_iFlags
;
5463 m_iFlags
&= ~(wxPG_FL_FOCUSED
);
5465 wxWindow
* parent
= newFocused
;
5467 // This must be one of nextFocus' parents.
5470 // Use m_eventObject, which is either wxPropertyGrid or
5471 // wxPropertyGridManager, as appropriate.
5472 if ( parent
== m_eventObject
)
5474 m_iFlags
|= wxPG_FL_FOCUSED
;
5477 parent
= parent
->GetParent();
5480 m_curFocused
= newFocused
;
5482 if ( (m_iFlags
& wxPG_FL_FOCUSED
) !=
5483 (oldFlags
& wxPG_FL_FOCUSED
) )
5485 if ( !(m_iFlags
& wxPG_FL_FOCUSED
) )
5487 // Need to store changed value
5488 CommitChangesFromEditor();
5494 // Preliminary code for tab-order respecting
5495 // tab-traversal (but should be moved to
5498 wxWindow* prevFocus = event.GetWindow();
5499 wxWindow* useThis = this;
5500 if ( m_iFlags & wxPG_FL_IN_MANAGER )
5501 useThis = GetParent();
5504 prevFocus->GetParent() == useThis->GetParent() )
5506 wxList& children = useThis->GetParent()->GetChildren();
5508 wxNode* node = children.Find(prevFocus);
5510 if ( node->GetNext() &&
5511 useThis == node->GetNext()->GetData() )
5512 DoSelectProperty(GetFirst());
5513 else if ( node->GetPrevious () &&
5514 useThis == node->GetPrevious()->GetData() )
5515 DoSelectProperty(GetLastProperty());
5522 wxPGProperty
* selected
= GetSelection();
5523 if ( selected
&& (m_iFlags
& wxPG_FL_INITIALIZED
) )
5524 DrawItem( selected
);
5528 void wxPropertyGrid::OnFocusEvent( wxFocusEvent
& event
)
5530 if ( event
.GetEventType() == wxEVT_SET_FOCUS
)
5531 HandleFocusChange((wxWindow
*)event
.GetEventObject());
5532 // Line changed to "else" when applying wxPropertyGrid patch #1675902
5533 //else if ( event.GetWindow() )
5535 HandleFocusChange(event
.GetWindow());
5540 // -----------------------------------------------------------------------
5542 void wxPropertyGrid::OnChildFocusEvent( wxChildFocusEvent
& event
)
5544 HandleFocusChange((wxWindow
*)event
.GetEventObject());
5548 // -----------------------------------------------------------------------
5550 void wxPropertyGrid::OnScrollEvent( wxScrollWinEvent
&event
)
5552 m_iFlags
|= wxPG_FL_SCROLLED
;
5557 // -----------------------------------------------------------------------
5559 void wxPropertyGrid::OnCaptureChange( wxMouseCaptureChangedEvent
& WXUNUSED(event
) )
5561 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
5563 m_iFlags
&= ~(wxPG_FL_MOUSE_CAPTURED
);
5567 // -----------------------------------------------------------------------
5568 // Property editor related functions
5569 // -----------------------------------------------------------------------
5571 // noDefCheck = true prevents infinite recursion.
5572 wxPGEditor
* wxPropertyGrid::DoRegisterEditorClass( wxPGEditor
* editorClass
,
5573 const wxString
& editorName
,
5576 wxASSERT( editorClass
);
5578 if ( !noDefCheck
&& wxPGGlobalVars
->m_mapEditorClasses
.empty() )
5579 RegisterDefaultEditors();
5581 wxString name
= editorName
;
5582 if ( name
.length() == 0 )
5583 name
= editorClass
->GetName();
5585 // Existing editor under this name?
5586 wxPGHashMapS2P::iterator vt_it
= wxPGGlobalVars
->m_mapEditorClasses
.find(name
);
5588 if ( vt_it
!= wxPGGlobalVars
->m_mapEditorClasses
.end() )
5590 // If this name was already used, try class name.
5591 name
= editorClass
->GetClassInfo()->GetClassName();
5592 vt_it
= wxPGGlobalVars
->m_mapEditorClasses
.find(name
);
5595 wxCHECK_MSG( vt_it
== wxPGGlobalVars
->m_mapEditorClasses
.end(),
5596 (wxPGEditor
*) vt_it
->second
,
5597 "Editor with given name was already registered" );
5599 wxPGGlobalVars
->m_mapEditorClasses
[name
] = (void*)editorClass
;
5604 // Use this in RegisterDefaultEditors.
5605 #define wxPGRegisterDefaultEditorClass(EDITOR) \
5606 if ( wxPGEditor_##EDITOR == NULL ) \
5608 wxPGEditor_##EDITOR = wxPropertyGrid::RegisterEditorClass( \
5609 new wxPG##EDITOR##Editor, true ); \
5612 // Registers all default editor classes
5613 void wxPropertyGrid::RegisterDefaultEditors()
5615 wxPGRegisterDefaultEditorClass( TextCtrl
);
5616 wxPGRegisterDefaultEditorClass( Choice
);
5617 wxPGRegisterDefaultEditorClass( ComboBox
);
5618 wxPGRegisterDefaultEditorClass( TextCtrlAndButton
);
5619 #if wxPG_INCLUDE_CHECKBOX
5620 wxPGRegisterDefaultEditorClass( CheckBox
);
5622 wxPGRegisterDefaultEditorClass( ChoiceAndButton
);
5624 // Register SpinCtrl etc. editors before use
5625 RegisterAdditionalEditors();
5628 // -----------------------------------------------------------------------
5629 // wxPGStringTokenizer
5630 // Needed to handle C-style string lists (e.g. "str1" "str2")
5631 // -----------------------------------------------------------------------
5633 wxPGStringTokenizer::wxPGStringTokenizer( const wxString
& str
, wxChar delimeter
)
5634 : m_str(&str
), m_curPos(str
.begin()), m_delimeter(delimeter
)
5638 wxPGStringTokenizer::~wxPGStringTokenizer()
5642 bool wxPGStringTokenizer::HasMoreTokens()
5644 const wxString
& str
= *m_str
;
5646 wxString::const_iterator i
= m_curPos
;
5648 wxUniChar delim
= m_delimeter
;
5650 wxUniChar prev_a
= wxT('\0');
5652 bool inToken
= false;
5654 while ( i
!= str
.end() )
5663 m_readyToken
.clear();
5668 if ( prev_a
!= wxT('\\') )
5672 if ( a
!= wxT('\\') )
5692 m_curPos
= str
.end();
5700 wxString
wxPGStringTokenizer::GetNextToken()
5702 return m_readyToken
;
5705 // -----------------------------------------------------------------------
5707 // -----------------------------------------------------------------------
5709 wxPGChoiceEntry::wxPGChoiceEntry()
5710 : wxPGCell(), m_value(wxPG_INVALID_VALUE
)
5714 // -----------------------------------------------------------------------
5716 // -----------------------------------------------------------------------
5718 wxPGChoicesData::wxPGChoicesData()
5722 wxPGChoicesData::~wxPGChoicesData()
5727 void wxPGChoicesData::Clear()
5732 void wxPGChoicesData::CopyDataFrom( wxPGChoicesData
* data
)
5734 wxASSERT( m_items
.size() == 0 );
5736 m_items
= data
->m_items
;
5739 wxPGChoiceEntry
& wxPGChoicesData::Insert( int index
,
5740 const wxPGChoiceEntry
& item
)
5742 wxVector
<wxPGChoiceEntry
>::iterator it
;
5746 index
= (int) m_items
.size();
5750 it
= m_items
.begin() + index
;
5753 m_items
.insert(it
, item
);
5755 wxPGChoiceEntry
& ownEntry
= m_items
[index
];
5757 // Need to fix value?
5758 if ( ownEntry
.GetValue() == wxPG_INVALID_VALUE
)
5759 ownEntry
.SetValue(index
);
5764 // -----------------------------------------------------------------------
5765 // wxPropertyGridEvent
5766 // -----------------------------------------------------------------------
5768 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGridEvent
, wxCommandEvent
)
5771 wxDEFINE_EVENT( wxEVT_PG_SELECTED
, wxPropertyGridEvent
);
5772 wxDEFINE_EVENT( wxEVT_PG_CHANGING
, wxPropertyGridEvent
);
5773 wxDEFINE_EVENT( wxEVT_PG_CHANGED
, wxPropertyGridEvent
);
5774 wxDEFINE_EVENT( wxEVT_PG_HIGHLIGHTED
, wxPropertyGridEvent
);
5775 wxDEFINE_EVENT( wxEVT_PG_RIGHT_CLICK
, wxPropertyGridEvent
);
5776 wxDEFINE_EVENT( wxEVT_PG_PAGE_CHANGED
, wxPropertyGridEvent
);
5777 wxDEFINE_EVENT( wxEVT_PG_ITEM_EXPANDED
, wxPropertyGridEvent
);
5778 wxDEFINE_EVENT( wxEVT_PG_ITEM_COLLAPSED
, wxPropertyGridEvent
);
5779 wxDEFINE_EVENT( wxEVT_PG_DOUBLE_CLICK
, wxPropertyGridEvent
);
5780 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_BEGIN
, wxPropertyGridEvent
);
5781 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_ENDING
, wxPropertyGridEvent
);
5783 // -----------------------------------------------------------------------
5785 void wxPropertyGridEvent::Init()
5787 m_validationInfo
= NULL
;
5790 m_wasVetoed
= false;
5793 // -----------------------------------------------------------------------
5795 wxPropertyGridEvent::wxPropertyGridEvent(wxEventType commandType
, int id
)
5796 : wxCommandEvent(commandType
,id
)
5802 // -----------------------------------------------------------------------
5804 wxPropertyGridEvent::wxPropertyGridEvent(const wxPropertyGridEvent
& event
)
5805 : wxCommandEvent(event
)
5807 m_eventType
= event
.GetEventType();
5808 m_eventObject
= event
.m_eventObject
;
5810 OnPropertyGridSet();
5811 m_property
= event
.m_property
;
5812 m_validationInfo
= event
.m_validationInfo
;
5813 m_canVeto
= event
.m_canVeto
;
5814 m_wasVetoed
= event
.m_wasVetoed
;
5817 // -----------------------------------------------------------------------
5819 void wxPropertyGridEvent::OnPropertyGridSet()
5825 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
5827 m_pg
->m_liveEvents
.push_back(this);
5830 // -----------------------------------------------------------------------
5832 wxPropertyGridEvent::~wxPropertyGridEvent()
5837 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
5840 // Use iterate from the back since it is more likely that the event
5841 // being desroyed is at the end of the array.
5842 wxVector
<wxPropertyGridEvent
*>& liveEvents
= m_pg
->m_liveEvents
;
5844 for ( int i
= liveEvents
.size()-1; i
>= 0; i
-- )
5846 if ( liveEvents
[i
] == this )
5848 liveEvents
.erase(liveEvents
.begin() + i
);
5855 // -----------------------------------------------------------------------
5857 wxEvent
* wxPropertyGridEvent::Clone() const
5859 return new wxPropertyGridEvent( *this );
5862 // -----------------------------------------------------------------------
5863 // wxPropertyGridPopulator
5864 // -----------------------------------------------------------------------
5866 wxPropertyGridPopulator::wxPropertyGridPopulator()
5870 wxPGGlobalVars
->m_offline
++;
5873 // -----------------------------------------------------------------------
5875 void wxPropertyGridPopulator::SetState( wxPropertyGridPageState
* state
)
5878 m_propHierarchy
.clear();
5881 // -----------------------------------------------------------------------
5883 void wxPropertyGridPopulator::SetGrid( wxPropertyGrid
* pg
)
5889 // -----------------------------------------------------------------------
5891 wxPropertyGridPopulator::~wxPropertyGridPopulator()
5894 // Free unused sets of choices
5895 wxPGHashMapS2P::iterator it
;
5897 for( it
= m_dictIdChoices
.begin(); it
!= m_dictIdChoices
.end(); ++it
)
5899 wxPGChoicesData
* data
= (wxPGChoicesData
*) it
->second
;
5906 m_pg
->GetPanel()->Refresh();
5908 wxPGGlobalVars
->m_offline
--;
5911 // -----------------------------------------------------------------------
5913 wxPGProperty
* wxPropertyGridPopulator::Add( const wxString
& propClass
,
5914 const wxString
& propLabel
,
5915 const wxString
& propName
,
5916 const wxString
* propValue
,
5917 wxPGChoices
* pChoices
)
5919 wxClassInfo
* classInfo
= wxClassInfo::FindClass(propClass
);
5920 wxPGProperty
* parent
= GetCurParent();
5922 if ( parent
->HasFlag(wxPG_PROP_AGGREGATE
) )
5924 ProcessError(wxString::Format(wxT("new children cannot be added to '%s'"),parent
->GetName().c_str()));
5928 if ( !classInfo
|| !classInfo
->IsKindOf(CLASSINFO(wxPGProperty
)) )
5930 ProcessError(wxString::Format(wxT("'%s' is not valid property class"),propClass
.c_str()));
5934 wxPGProperty
* property
= (wxPGProperty
*) classInfo
->CreateObject();
5936 property
->SetLabel(propLabel
);
5937 property
->DoSetName(propName
);
5939 if ( pChoices
&& pChoices
->IsOk() )
5940 property
->SetChoices(*pChoices
);
5942 m_state
->DoInsert(parent
, -1, property
);
5945 property
->SetValueFromString( *propValue
, wxPG_FULL_VALUE
|
5946 wxPG_PROGRAMMATIC_VALUE
);
5951 // -----------------------------------------------------------------------
5953 void wxPropertyGridPopulator::AddChildren( wxPGProperty
* property
)
5955 m_propHierarchy
.push_back(property
);
5956 DoScanForChildren();
5957 m_propHierarchy
.pop_back();
5960 // -----------------------------------------------------------------------
5962 wxPGChoices
wxPropertyGridPopulator::ParseChoices( const wxString
& choicesString
,
5963 const wxString
& idString
)
5965 wxPGChoices choices
;
5968 if ( choicesString
[0] == wxT('@') )
5970 wxString ids
= choicesString
.substr(1);
5971 wxPGHashMapS2P::iterator it
= m_dictIdChoices
.find(ids
);
5972 if ( it
== m_dictIdChoices
.end() )
5973 ProcessError(wxString::Format(wxT("No choices defined for id '%s'"),ids
.c_str()));
5975 choices
.AssignData((wxPGChoicesData
*)it
->second
);
5980 if ( idString
.length() )
5982 wxPGHashMapS2P::iterator it
= m_dictIdChoices
.find(idString
);
5983 if ( it
!= m_dictIdChoices
.end() )
5985 choices
.AssignData((wxPGChoicesData
*)it
->second
);
5992 // Parse choices string
5993 wxString::const_iterator it
= choicesString
.begin();
5997 bool labelValid
= false;
5999 for ( ; it
!= choicesString
.end(); ++it
)
6005 if ( c
== wxT('"') )
6010 if ( !value
.ToLong(&l
, 0) ) l
= wxPG_INVALID_VALUE
;
6011 choices
.Add(label
, l
);
6014 //wxLogDebug(wxT("%s, %s"),label.c_str(),value.c_str());
6019 else if ( c
== wxT('=') )
6026 else if ( state
== 2 && (wxIsalnum(c
) || c
== wxT('x')) )
6033 if ( c
== wxT('"') )
6046 if ( !value
.ToLong(&l
, 0) ) l
= wxPG_INVALID_VALUE
;
6047 choices
.Add(label
, l
);
6050 if ( !choices
.IsOk() )
6052 choices
.EnsureData();
6056 if ( idString
.length() )
6057 m_dictIdChoices
[idString
] = choices
.GetData();
6064 // -----------------------------------------------------------------------
6066 bool wxPropertyGridPopulator::ToLongPCT( const wxString
& s
, long* pval
, long max
)
6068 if ( s
.Last() == wxT('%') )
6070 wxString s2
= s
.substr(0,s
.length()-1);
6072 if ( s2
.ToLong(&val
, 10) )
6074 *pval
= (val
*max
)/100;
6080 return s
.ToLong(pval
, 10);
6083 // -----------------------------------------------------------------------
6085 bool wxPropertyGridPopulator::AddAttribute( const wxString
& name
,
6086 const wxString
& type
,
6087 const wxString
& value
)
6089 int l
= m_propHierarchy
.size();
6093 wxPGProperty
* p
= m_propHierarchy
[l
-1];
6094 wxString valuel
= value
.Lower();
6097 if ( type
.length() == 0 )
6102 if ( valuel
== wxT("true") || valuel
== wxT("yes") || valuel
== wxT("1") )
6104 else if ( valuel
== wxT("false") || valuel
== wxT("no") || valuel
== wxT("0") )
6106 else if ( value
.ToLong(&v
, 0) )
6113 if ( type
== wxT("string") )
6117 else if ( type
== wxT("int") )
6120 value
.ToLong(&v
, 0);
6123 else if ( type
== wxT("bool") )
6125 if ( valuel
== wxT("true") || valuel
== wxT("yes") || valuel
== wxT("1") )
6132 ProcessError(wxString::Format(wxT("Invalid attribute type '%s'"),type
.c_str()));
6137 p
->SetAttribute( name
, variant
);
6142 // -----------------------------------------------------------------------
6144 void wxPropertyGridPopulator::ProcessError( const wxString
& msg
)
6146 wxLogError(_("Error in resource: %s"),msg
.c_str());
6149 // -----------------------------------------------------------------------
6151 #endif // wxUSE_PROPGRID