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 // -----------------------------------------------------------------------
121 void wxPropertyGrid::AutoGetTranslation ( bool enable
)
123 wxPGGlobalVars
->m_autoGetTranslation
= enable
;
126 void wxPropertyGrid::AutoGetTranslation ( bool ) { }
129 // -----------------------------------------------------------------------
131 const char wxPropertyGridNameStr
[] = "wxPropertyGrid";
133 // -----------------------------------------------------------------------
134 // Statics in one class for easy destruction.
135 // -----------------------------------------------------------------------
137 #include "wx/module.h"
139 class wxPGGlobalVarsClassManager
: public wxModule
141 DECLARE_DYNAMIC_CLASS(wxPGGlobalVarsClassManager
)
143 wxPGGlobalVarsClassManager() {}
144 virtual bool OnInit() { wxPGGlobalVars
= new wxPGGlobalVarsClass(); return true; }
145 virtual void OnExit() { delete wxPGGlobalVars
; wxPGGlobalVars
= NULL
; }
148 IMPLEMENT_DYNAMIC_CLASS(wxPGGlobalVarsClassManager
, wxModule
)
151 // When wxPG is loaded dynamically after the application is already running
152 // then the built-in module system won't pick this one up. Add it manually.
153 void wxPGInitResourceModule()
155 wxModule
* module = new wxPGGlobalVarsClassManager
;
157 wxModule::RegisterModule(module);
160 wxPGGlobalVarsClass
* wxPGGlobalVars
= NULL
;
163 wxPGGlobalVarsClass::wxPGGlobalVarsClass()
165 wxPGProperty::sm_wxPG_LABEL
= new wxString(wxPG_LABEL_STRING
);
167 m_boolChoices
.Add(_("False"));
168 m_boolChoices
.Add(_("True"));
170 m_fontFamilyChoices
= NULL
;
172 m_defaultRenderer
= new wxPGDefaultRenderer();
174 m_autoGetTranslation
= false;
182 // Prepare some shared variants
183 m_vEmptyString
= wxString();
185 m_vMinusOne
= (long) -1;
189 // Prepare cached string constants
190 m_strstring
= wxS("string");
191 m_strlong
= wxS("long");
192 m_strbool
= wxS("bool");
193 m_strlist
= wxS("list");
194 m_strDefaultValue
= wxS("DefaultValue");
195 m_strMin
= wxS("Min");
196 m_strMax
= wxS("Max");
197 m_strUnits
= wxS("Units");
198 m_strInlineHelp
= wxS("InlineHelp");
204 wxPGGlobalVarsClass::~wxPGGlobalVarsClass()
208 delete m_defaultRenderer
;
210 // This will always have one ref
211 delete m_fontFamilyChoices
;
214 for ( i
=0; i
<m_arrValidators
.size(); i
++ )
215 delete ((wxValidator
*)m_arrValidators
[i
]);
219 // Destroy value type class instances.
220 wxPGHashMapS2P::iterator vt_it
;
222 // Destroy editor class instances.
223 // iterate over all the elements in the class
224 for( vt_it
= m_mapEditorClasses
.begin(); vt_it
!= m_mapEditorClasses
.end(); ++vt_it
)
226 delete ((wxPGEditor
*)vt_it
->second
);
229 delete wxPGProperty::sm_wxPG_LABEL
;
232 void wxPropertyGridInitGlobalsIfNeeded()
236 // -----------------------------------------------------------------------
238 // -----------------------------------------------------------------------
240 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGrid
, wxScrolledWindow
)
242 BEGIN_EVENT_TABLE(wxPropertyGrid
, wxScrolledWindow
)
243 EVT_IDLE(wxPropertyGrid::OnIdle
)
244 EVT_PAINT(wxPropertyGrid::OnPaint
)
245 EVT_SIZE(wxPropertyGrid::OnResize
)
246 EVT_ENTER_WINDOW(wxPropertyGrid::OnMouseEntry
)
247 EVT_LEAVE_WINDOW(wxPropertyGrid::OnMouseEntry
)
248 EVT_MOUSE_CAPTURE_CHANGED(wxPropertyGrid::OnCaptureChange
)
249 EVT_SCROLLWIN(wxPropertyGrid::OnScrollEvent
)
250 EVT_CHILD_FOCUS(wxPropertyGrid::OnChildFocusEvent
)
251 EVT_SET_FOCUS(wxPropertyGrid::OnFocusEvent
)
252 EVT_KILL_FOCUS(wxPropertyGrid::OnFocusEvent
)
253 EVT_SYS_COLOUR_CHANGED(wxPropertyGrid::OnSysColourChanged
)
254 EVT_MOTION(wxPropertyGrid::OnMouseMove
)
255 EVT_LEFT_DOWN(wxPropertyGrid::OnMouseClick
)
256 EVT_LEFT_UP(wxPropertyGrid::OnMouseUp
)
257 EVT_RIGHT_UP(wxPropertyGrid::OnMouseRightClick
)
258 EVT_LEFT_DCLICK(wxPropertyGrid::OnMouseDoubleClick
)
259 EVT_KEY_DOWN(wxPropertyGrid::OnKey
)
262 // -----------------------------------------------------------------------
264 wxPropertyGrid::wxPropertyGrid()
270 // -----------------------------------------------------------------------
272 wxPropertyGrid::wxPropertyGrid( wxWindow
*parent
,
277 const wxString
& name
)
281 Create(parent
,id
,pos
,size
,style
,name
);
284 // -----------------------------------------------------------------------
286 bool wxPropertyGrid::Create( wxWindow
*parent
,
291 const wxString
& name
)
294 if (!(style
&wxBORDER_MASK
))
296 style
|= wxBORDER_THEME
;
301 // Filter out wxTAB_TRAVERSAL - we will handle TABs manually
302 style
&= ~(wxTAB_TRAVERSAL
);
303 style
|= wxWANTS_CHARS
;
305 wxScrolledWindow::Create(parent
,id
,pos
,size
,style
,name
);
312 // -----------------------------------------------------------------------
315 // Initialize values to defaults
317 void wxPropertyGrid::Init1()
319 // Register editor classes, if necessary.
320 if ( wxPGGlobalVars
->m_mapEditorClasses
.empty() )
321 wxPropertyGrid::RegisterDefaultEditors();
325 m_wndEditor
= m_wndEditor2
= NULL
;
329 m_labelEditor
= NULL
;
330 m_labelEditorProperty
= NULL
;
331 m_eventObject
= this;
333 m_processedEvent
= NULL
;
334 m_sortFunction
= NULL
;
335 m_inDoPropertyChanged
= 0;
336 m_inCommitChangesFromEditor
= 0;
337 m_inDoSelectProperty
= 0;
338 m_permanentValidationFailureBehavior
= wxPG_VFB_DEFAULT
;
344 AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY
, WXK_RIGHT
);
345 AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY
, WXK_DOWN
);
346 AddActionTrigger( wxPG_ACTION_PREV_PROPERTY
, WXK_LEFT
);
347 AddActionTrigger( wxPG_ACTION_PREV_PROPERTY
, WXK_UP
);
348 AddActionTrigger( wxPG_ACTION_EXPAND_PROPERTY
, WXK_RIGHT
);
349 AddActionTrigger( wxPG_ACTION_COLLAPSE_PROPERTY
, WXK_LEFT
);
350 AddActionTrigger( wxPG_ACTION_CANCEL_EDIT
, WXK_ESCAPE
);
351 AddActionTrigger( wxPG_ACTION_PRESS_BUTTON
, WXK_DOWN
, wxMOD_ALT
);
352 AddActionTrigger( wxPG_ACTION_PRESS_BUTTON
, WXK_F4
);
354 m_coloursCustomized
= 0;
357 #if wxPG_DOUBLE_BUFFER
358 m_doubleBuffer
= NULL
;
361 #ifndef wxPG_ICON_WIDTH
367 m_iconWidth
= wxPG_ICON_WIDTH
;
372 m_gutterWidth
= wxPG_GUTTER_MIN
;
373 m_subgroup_extramargin
= 10;
377 m_width
= m_height
= 0;
379 m_commonValues
.push_back(new wxPGCommonValue(_("Unspecified"), wxPGGlobalVars
->m_defaultRenderer
) );
382 m_chgInfo_changedProperty
= NULL
;
385 // -----------------------------------------------------------------------
388 // Initialize after parent etc. set
390 void wxPropertyGrid::Init2()
392 wxASSERT( !(m_iFlags
& wxPG_FL_INITIALIZED
) );
395 // Smaller controls on Mac
396 SetWindowVariant(wxWINDOW_VARIANT_SMALL
);
399 // Now create state, if one didn't exist already
400 // (wxPropertyGridManager might have created it for us).
403 m_pState
= CreateState();
404 m_pState
->m_pPropGrid
= this;
405 m_iFlags
|= wxPG_FL_CREATEDSTATE
;
408 if ( !(m_windowStyle
& wxPG_SPLITTER_AUTO_CENTER
) )
409 m_iFlags
|= wxPG_FL_DONT_CENTER_SPLITTER
;
411 if ( m_windowStyle
& wxPG_HIDE_CATEGORIES
)
413 m_pState
->InitNonCatMode();
415 m_pState
->m_properties
= m_pState
->m_abcArray
;
418 GetClientSize(&m_width
,&m_height
);
420 #ifndef wxPG_ICON_WIDTH
421 // create two bitmap nodes for drawing
422 m_expandbmp
= new wxBitmap(expand_xpm
);
423 m_collbmp
= new wxBitmap(collapse_xpm
);
425 // calculate average font height for bitmap centering
427 m_iconWidth
= m_expandbmp
->GetWidth();
428 m_iconHeight
= m_expandbmp
->GetHeight();
431 m_curcursor
= wxCURSOR_ARROW
;
432 m_cursorSizeWE
= new wxCursor( wxCURSOR_SIZEWE
);
434 // adjust bitmap icon y position so they are centered
435 m_vspacing
= wxPG_DEFAULT_VSPACING
;
437 CalculateFontAndBitmapStuff( wxPG_DEFAULT_VSPACING
);
439 // Allocate cell datas indirectly by calling setter
440 m_propertyDefaultCell
.SetBgCol(*wxBLACK
);
441 m_categoryDefaultCell
.SetBgCol(*wxBLACK
);
445 // This helps with flicker
446 SetBackgroundStyle( wxBG_STYLE_CUSTOM
);
448 // Hook the top-level parent
453 // set virtual size to this window size
454 wxSize wndsize
= GetSize();
455 SetVirtualSize(wndsize
.GetWidth(), wndsize
.GetWidth());
457 m_timeCreated
= ::wxGetLocalTimeMillis();
459 //m_canvas->Create(this, wxID_ANY, wxPoint(0, 0), GetClientSize(),
460 // wxWANTS_CHARS | wxCLIP_CHILDREN);
461 SetBackgroundStyle( wxBG_STYLE_CUSTOM
);
463 m_iFlags
|= wxPG_FL_INITIALIZED
;
465 m_ncWidth
= wndsize
.GetWidth();
467 // Need to call OnResize handler or size given in constructor/Create
469 wxSizeEvent
sizeEvent(wndsize
,0);
473 // -----------------------------------------------------------------------
475 wxPropertyGrid::~wxPropertyGrid()
480 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
484 // Remove grid and property pointers from live wxPropertyGridEvents.
485 for ( i
=0; i
<m_liveEvents
.size(); i
++ )
487 wxPropertyGridEvent
* evt
= m_liveEvents
[i
];
488 evt
->SetPropertyGrid(NULL
);
489 evt
->SetProperty(NULL
);
491 m_liveEvents
.clear();
493 if ( m_processedEvent
)
495 // All right... we are being deleted while wxPropertyGrid event
496 // is being sent. Make sure that event propagates as little
497 // as possible (although usually this is not enough to prevent
499 m_processedEvent
->Skip(false);
500 m_processedEvent
->StopPropagation();
502 // Let's use wxMessageBox to make the message appear more
503 // reliably (and *before* the crash can happen).
504 ::wxMessageBox("wxPropertyGrid was being destroyed in an event "
505 "generated by it. This usually leads to a crash "
506 "so it is recommended to destroy the control "
507 "at idle time instead.");
510 DoSelectProperty(NULL
, wxPG_SEL_NOVALIDATE
|wxPG_SEL_DONT_SEND_EVENT
);
512 // This should do prevent things from going too badly wrong
513 m_iFlags
&= ~(wxPG_FL_INITIALIZED
);
515 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
518 // Call with NULL to disconnect event handling
519 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING
)
523 wxASSERT_MSG( !IsEditorsValueModified(),
524 wxS("Most recent change in property editor was ")
525 wxS("lost!!! (if you don't want this to happen, ")
526 wxS("close your frames and dialogs using ")
527 wxS("Close(false).)") );
530 #if wxPG_DOUBLE_BUFFER
531 if ( m_doubleBuffer
)
532 delete m_doubleBuffer
;
535 if ( m_iFlags
& wxPG_FL_CREATEDSTATE
)
538 delete m_cursorSizeWE
;
540 #ifndef wxPG_ICON_WIDTH
545 // Delete common value records
546 for ( i
=0; i
<m_commonValues
.size(); i
++ )
548 // Use temporary variable to work around possible strange VC6 (asserts because m_size is zero)
549 wxPGCommonValue
* value
= m_commonValues
[i
];
554 // -----------------------------------------------------------------------
556 bool wxPropertyGrid::Destroy()
558 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
561 return wxScrolledWindow::Destroy();
564 // -----------------------------------------------------------------------
566 wxPropertyGridPageState
* wxPropertyGrid::CreateState() const
568 return new wxPropertyGridPageState();
571 // -----------------------------------------------------------------------
572 // wxPropertyGrid overridden wxWindow methods
573 // -----------------------------------------------------------------------
575 void wxPropertyGrid::SetWindowStyleFlag( long style
)
577 long old_style
= m_windowStyle
;
579 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
581 wxASSERT( m_pState
);
583 if ( !(style
& wxPG_HIDE_CATEGORIES
) && (old_style
& wxPG_HIDE_CATEGORIES
) )
586 EnableCategories( true );
588 else if ( (style
& wxPG_HIDE_CATEGORIES
) && !(old_style
& wxPG_HIDE_CATEGORIES
) )
590 // Disable categories
591 EnableCategories( false );
593 if ( !(old_style
& wxPG_AUTO_SORT
) && (style
& wxPG_AUTO_SORT
) )
599 PrepareAfterItemsAdded();
601 m_pState
->m_itemsAdded
= 1;
603 #if wxPG_SUPPORT_TOOLTIPS
604 if ( !(old_style
& wxPG_TOOLTIPS
) && (style
& wxPG_TOOLTIPS
) )
610 wxToolTip* tooltip = new wxToolTip ( wxEmptyString );
611 SetToolTip ( tooltip );
612 tooltip->SetDelay ( wxPG_TOOLTIP_DELAY );
615 else if ( (old_style
& wxPG_TOOLTIPS
) && !(style
& wxPG_TOOLTIPS
) )
620 wxScrolledWindow::SetToolTip( NULL
);
625 wxScrolledWindow::SetWindowStyleFlag ( style
);
627 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
629 if ( (old_style
& wxPG_HIDE_MARGIN
) != (style
& wxPG_HIDE_MARGIN
) )
631 CalculateFontAndBitmapStuff( m_vspacing
);
637 // -----------------------------------------------------------------------
639 void wxPropertyGrid::Freeze()
643 wxScrolledWindow::Freeze();
648 // -----------------------------------------------------------------------
650 void wxPropertyGrid::Thaw()
656 wxScrolledWindow::Thaw();
657 RecalculateVirtualSize();
658 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
662 // Force property re-selection
663 // NB: We must copy the selection.
664 wxArrayPGProperty selection
= m_pState
->m_selection
;
665 DoSetSelection(selection
, wxPG_SEL_FORCE
);
669 // -----------------------------------------------------------------------
671 bool wxPropertyGrid::DoAddToSelection( wxPGProperty
* prop
, int selFlags
)
673 wxCHECK( prop
, false );
675 if ( !(GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
) )
676 return DoSelectProperty(prop
, selFlags
);
678 wxArrayPGProperty
& selection
= m_pState
->m_selection
;
680 if ( !selection
.size() )
682 return DoSelectProperty(prop
, selFlags
);
686 // For categories, only one can be selected at a time
687 if ( prop
->IsCategory() || selection
[0]->IsCategory() )
690 selection
.push_back(prop
);
692 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
694 SendEvent( wxEVT_PG_SELECTED
, prop
, NULL
);
703 // -----------------------------------------------------------------------
705 bool wxPropertyGrid::DoRemoveFromSelection( wxPGProperty
* prop
, int selFlags
)
707 wxCHECK( prop
, false );
710 wxArrayPGProperty
& selection
= m_pState
->m_selection
;
711 if ( selection
.size() <= 1 )
713 res
= DoSelectProperty(NULL
, selFlags
);
717 m_pState
->DoRemoveFromSelection(prop
);
725 // -----------------------------------------------------------------------
727 bool wxPropertyGrid::DoSelectAndEdit( wxPGProperty
* prop
,
728 unsigned int colIndex
,
729 unsigned int selFlags
)
732 // NB: Enable following if label editor background colour is
733 // ever changed to any other than m_colSelBack.
735 // We use this workaround to prevent visible flicker when editing
736 // a cell. Atleast on wxMSW, there is a difficult to find
737 // (and perhaps prevent) redraw somewhere between making property
738 // selected and enabling label editing.
740 //wxColour prevColSelBack = m_colSelBack;
741 //m_colSelBack = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
747 res
= DoSelectProperty(prop
, selFlags
);
752 DoClearSelection(false, wxPG_SEL_NO_REFRESH
);
754 if ( m_pState
->m_editableColumns
.Index(colIndex
) == wxNOT_FOUND
)
756 res
= DoAddToSelection(prop
, selFlags
);
760 res
= DoAddToSelection(prop
, selFlags
|wxPG_SEL_NO_REFRESH
);
762 DoBeginLabelEdit(colIndex
, selFlags
);
766 //m_colSelBack = prevColSelBack;
770 // -----------------------------------------------------------------------
772 bool wxPropertyGrid::AddToSelectionFromInputEvent( wxPGProperty
* prop
,
773 unsigned int colIndex
,
774 wxMouseEvent
* mouseEvent
,
777 bool alreadySelected
= m_pState
->DoIsPropertySelected(prop
);
779 bool addToExistingSelection
;
781 if ( GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
)
785 if ( mouseEvent
->GetEventType() == wxEVT_RIGHT_DOWN
||
786 mouseEvent
->GetEventType() == wxEVT_RIGHT_UP
)
788 // Allow right-click for context menu without
789 // disturbing the selection.
790 if ( GetSelectedProperties().size() <= 1 ||
792 return DoSelectAndEdit(prop
, colIndex
, selFlags
);
797 addToExistingSelection
= mouseEvent
->ShiftDown();
802 addToExistingSelection
= false;
807 addToExistingSelection
= false;
810 if ( addToExistingSelection
)
812 if ( !alreadySelected
)
814 res
= DoAddToSelection(prop
, selFlags
);
816 else if ( GetSelectedProperties().size() > 1 )
818 res
= DoRemoveFromSelection(prop
, selFlags
);
823 res
= DoSelectAndEdit(prop
, colIndex
, selFlags
);
829 // -----------------------------------------------------------------------
831 void wxPropertyGrid::DoSetSelection( const wxArrayPGProperty
& newSelection
,
834 if ( newSelection
.size() > 0 )
836 if ( !DoSelectProperty(newSelection
[0], selFlags
) )
841 DoClearSelection(false, selFlags
);
844 for ( unsigned int i
= 1; i
< newSelection
.size(); i
++ )
846 DoAddToSelection(newSelection
[i
], selFlags
);
852 // -----------------------------------------------------------------------
854 void wxPropertyGrid::MakeColumnEditable( unsigned int column
,
857 wxASSERT( column
!= 1 );
859 wxArrayInt
& cols
= m_pState
->m_editableColumns
;
863 cols
.push_back(column
);
867 for ( int i
= cols
.size() - 1; i
> 0; i
-- )
869 if ( cols
[i
] == (int)column
)
870 cols
.erase( cols
.begin() + i
);
875 // -----------------------------------------------------------------------
877 void wxPropertyGrid::DoBeginLabelEdit( unsigned int colIndex
,
880 wxPGProperty
* selected
= GetSelection();
881 wxCHECK_RET(selected
, wxT("No property selected"));
882 wxCHECK_RET(colIndex
!= 1, wxT("Do not use this for column 1"));
884 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
886 if ( SendEvent( wxEVT_PG_LABEL_EDIT_BEGIN
,
893 const wxPGCell
* cell
= NULL
;
894 if ( selected
->HasCell(colIndex
) )
896 cell
= &selected
->GetCell(colIndex
);
897 if ( !cell
->HasText() && colIndex
== 0 )
898 text
= selected
->GetLabel();
904 text
= selected
->GetLabel();
906 cell
= &selected
->GetOrCreateCell(colIndex
);
909 if ( cell
&& cell
->HasText() )
910 text
= cell
->GetText();
912 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
); // send event
914 m_selColumn
= colIndex
;
916 wxRect r
= GetEditorWidgetRect(selected
, m_selColumn
);
918 wxWindow
* tc
= GenerateEditorTextCtrl(r
.GetPosition(),
926 wxWindowID id
= tc
->GetId();
927 tc
->Connect(id
, wxEVT_COMMAND_TEXT_ENTER
,
928 wxCommandEventHandler(wxPropertyGrid::OnLabelEditorEnterPress
),
930 tc
->Connect(id
, wxEVT_KEY_DOWN
,
931 wxKeyEventHandler(wxPropertyGrid::OnLabelEditorKeyPress
),
936 m_labelEditor
= wxStaticCast(tc
, wxTextCtrl
);
937 m_labelEditorProperty
= selected
;
940 // -----------------------------------------------------------------------
943 wxPropertyGrid::OnLabelEditorEnterPress( wxCommandEvent
& WXUNUSED(event
) )
945 DoEndLabelEdit(true);
948 // -----------------------------------------------------------------------
950 void wxPropertyGrid::OnLabelEditorKeyPress( wxKeyEvent
& event
)
952 int keycode
= event
.GetKeyCode();
954 if ( keycode
== WXK_ESCAPE
)
956 DoEndLabelEdit(false);
964 // -----------------------------------------------------------------------
966 void wxPropertyGrid::DoEndLabelEdit( bool commit
, int selFlags
)
968 if ( !m_labelEditor
)
971 wxPGProperty
* prop
= m_labelEditorProperty
;
976 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
978 // wxPG_SEL_NOVALIDATE is passed correctly in selFlags
979 if ( SendEvent( wxEVT_PG_LABEL_EDIT_ENDING
,
980 prop
, NULL
, selFlags
,
985 wxString text
= m_labelEditor
->GetValue();
986 wxPGCell
* cell
= NULL
;
987 if ( prop
->HasCell(m_selColumn
) )
989 cell
= &prop
->GetCell(m_selColumn
);
993 if ( m_selColumn
== 0 )
994 prop
->SetLabel(text
);
996 cell
= &prop
->GetOrCreateCell(m_selColumn
);
1000 cell
->SetText(text
);
1005 DestroyEditorWnd(m_labelEditor
);
1006 m_labelEditor
= NULL
;
1007 m_labelEditorProperty
= NULL
;
1012 // -----------------------------------------------------------------------
1014 void wxPropertyGrid::SetExtraStyle( long exStyle
)
1016 if ( exStyle
& wxPG_EX_ENABLE_TLP_TRACKING
)
1017 OnTLPChanging(::wxGetTopLevelParent(this));
1019 OnTLPChanging(NULL
);
1021 if ( exStyle
& wxPG_EX_NATIVE_DOUBLE_BUFFERING
)
1023 #if defined(__WXMSW__)
1026 // Don't use WS_EX_COMPOSITED just now.
1029 if ( m_iFlags & wxPG_FL_IN_MANAGER )
1030 hWnd = (HWND)GetParent()->GetHWND();
1032 hWnd = (HWND)GetHWND();
1034 ::SetWindowLong( hWnd, GWL_EXSTYLE,
1035 ::GetWindowLong(hWnd, GWL_EXSTYLE) | WS_EX_COMPOSITED );
1038 //#elif defined(__WXGTK20__)
1040 // Only apply wxPG_EX_NATIVE_DOUBLE_BUFFERING if the window
1041 // truly was double-buffered.
1042 if ( !this->IsDoubleBuffered() )
1044 exStyle
&= ~(wxPG_EX_NATIVE_DOUBLE_BUFFERING
);
1048 #if wxPG_DOUBLE_BUFFER
1049 delete m_doubleBuffer
;
1050 m_doubleBuffer
= NULL
;
1055 wxScrolledWindow::SetExtraStyle( exStyle
);
1057 if ( exStyle
& wxPG_EX_INIT_NOCAT
)
1058 m_pState
->InitNonCatMode();
1060 if ( exStyle
& wxPG_EX_HELP_AS_TOOLTIPS
)
1061 m_windowStyle
|= wxPG_TOOLTIPS
;
1064 wxPGGlobalVars
->m_extraStyle
= exStyle
;
1067 // -----------------------------------------------------------------------
1069 // returns the best acceptable minimal size
1070 wxSize
wxPropertyGrid::DoGetBestSize() const
1072 int lineHeight
= wxMax(15, m_lineHeight
);
1074 // don't make the grid too tall (limit height to 10 items) but don't
1075 // make it too small neither
1076 int numLines
= wxMin
1078 wxMax(m_pState
->m_properties
->GetChildCount(), 3),
1082 wxClientDC
dc(const_cast<wxPropertyGrid
*>(this));
1083 int width
= m_marginWidth
;
1084 for ( unsigned int i
= 0; i
< m_pState
->m_colWidths
.size(); i
++ )
1086 width
+= m_pState
->GetColumnFitWidth(dc
, m_pState
->DoGetRoot(), i
, true);
1089 const wxSize sz
= wxSize(width
, lineHeight
*numLines
+ 40);
1095 // -----------------------------------------------------------------------
1097 void wxPropertyGrid::OnTLPChanging( wxWindow
* newTLP
)
1099 if ( newTLP
== m_tlp
)
1102 wxLongLong currentTime
= ::wxGetLocalTimeMillis();
1105 // Parent changed so let's redetermine and re-hook the
1106 // correct top-level window.
1109 m_tlp
->Disconnect( wxEVT_CLOSE_WINDOW
,
1110 wxCloseEventHandler(wxPropertyGrid::OnTLPClose
),
1112 m_tlpClosed
= m_tlp
;
1113 m_tlpClosedTime
= currentTime
;
1118 // Only accept new tlp if same one was not just dismissed.
1119 if ( newTLP
!= m_tlpClosed
||
1120 m_tlpClosedTime
+250 < currentTime
)
1122 newTLP
->Connect( wxEVT_CLOSE_WINDOW
,
1123 wxCloseEventHandler(wxPropertyGrid::OnTLPClose
),
1136 // -----------------------------------------------------------------------
1138 void wxPropertyGrid::OnTLPClose( wxCloseEvent
& event
)
1140 // ClearSelection forces value validation/commit.
1141 if ( event
.CanVeto() && !DoClearSelection() )
1147 // Ok, it can close, set tlp pointer to NULL. Some other event
1148 // handler can of course veto the close, but our OnIdle() should
1149 // then be able to regain the tlp pointer.
1150 OnTLPChanging(NULL
);
1155 // -----------------------------------------------------------------------
1157 bool wxPropertyGrid::Reparent( wxWindowBase
*newParent
)
1159 OnTLPChanging((wxWindow
*)newParent
);
1161 bool res
= wxScrolledWindow::Reparent(newParent
);
1166 // -----------------------------------------------------------------------
1167 // wxPropertyGrid Font and Colour Methods
1168 // -----------------------------------------------------------------------
1170 void wxPropertyGrid::CalculateFontAndBitmapStuff( int vspacing
)
1174 m_captionFont
= wxScrolledWindow::GetFont();
1176 GetTextExtent(wxS("jG"), &x
, &y
, 0, 0, &m_captionFont
);
1177 m_subgroup_extramargin
= x
+ (x
/2);
1180 #if wxPG_USE_RENDERER_NATIVE
1181 m_iconWidth
= wxPG_ICON_WIDTH
;
1182 #elif wxPG_ICON_WIDTH
1184 m_iconWidth
= (m_fontHeight
* wxPG_ICON_WIDTH
) / 13;
1185 if ( m_iconWidth
< 5 ) m_iconWidth
= 5;
1186 else if ( !(m_iconWidth
& 0x01) ) m_iconWidth
++; // must be odd
1190 m_gutterWidth
= m_iconWidth
/ wxPG_GUTTER_DIV
;
1191 if ( m_gutterWidth
< wxPG_GUTTER_MIN
)
1192 m_gutterWidth
= wxPG_GUTTER_MIN
;
1195 if ( vspacing
<= 1 ) vdiv
= 12;
1196 else if ( vspacing
>= 3 ) vdiv
= 3;
1198 m_spacingy
= m_fontHeight
/ vdiv
;
1199 if ( m_spacingy
< wxPG_YSPACING_MIN
)
1200 m_spacingy
= wxPG_YSPACING_MIN
;
1203 if ( !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
1204 m_marginWidth
= m_gutterWidth
*2 + m_iconWidth
;
1206 m_captionFont
.SetWeight(wxBOLD
);
1207 GetTextExtent(wxS("jG"), &x
, &y
, 0, 0, &m_captionFont
);
1209 m_lineHeight
= m_fontHeight
+(2*m_spacingy
)+1;
1212 m_buttonSpacingY
= (m_lineHeight
- m_iconHeight
) / 2;
1213 if ( m_buttonSpacingY
< 0 ) m_buttonSpacingY
= 0;
1216 m_pState
->CalculateFontAndBitmapStuff(vspacing
);
1218 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
1219 RecalculateVirtualSize();
1221 InvalidateBestSize();
1224 // -----------------------------------------------------------------------
1226 void wxPropertyGrid::OnSysColourChanged( wxSysColourChangedEvent
&WXUNUSED(event
) )
1232 // -----------------------------------------------------------------------
1234 static wxColour
wxPGAdjustColour(const wxColour
& src
, int ra
,
1235 int ga
= 1000, int ba
= 1000,
1236 bool forceDifferent
= false)
1243 // Recursion guard (allow 2 max)
1244 static int isinside
= 0;
1246 wxCHECK_MSG( isinside
< 3,
1248 wxT("wxPGAdjustColour should not be recursively called more than once") );
1253 int g
= src
.Green();
1256 if ( r2
>255 ) r2
= 255;
1257 else if ( r2
<0) r2
= 0;
1259 if ( g2
>255 ) g2
= 255;
1260 else if ( g2
<0) g2
= 0;
1262 if ( b2
>255 ) b2
= 255;
1263 else if ( b2
<0) b2
= 0;
1265 // Make sure they are somewhat different
1266 if ( forceDifferent
&& (abs((r
+g
+b
)-(r2
+g2
+b2
)) < abs(ra
/2)) )
1267 dst
= wxPGAdjustColour(src
,-(ra
*2));
1269 dst
= wxColour(r2
,g2
,b2
);
1271 // Recursion guard (allow 2 max)
1278 static int wxPGGetColAvg( const wxColour
& col
)
1280 return (col
.Red() + col
.Green() + col
.Blue()) / 3;
1284 void wxPropertyGrid::RegainColours()
1286 if ( !(m_coloursCustomized
& 0x0002) )
1288 wxColour col
= wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE
);
1290 // Make sure colour is dark enough
1292 int colDec
= wxPGGetColAvg(col
) - 230;
1294 int colDec
= wxPGGetColAvg(col
) - 200;
1297 m_colCapBack
= wxPGAdjustColour(col
,-colDec
);
1300 m_categoryDefaultCell
.GetData()->SetBgCol(m_colCapBack
);
1303 if ( !(m_coloursCustomized
& 0x0001) )
1304 m_colMargin
= m_colCapBack
;
1306 if ( !(m_coloursCustomized
& 0x0004) )
1313 wxColour capForeCol
= wxPGAdjustColour(m_colCapBack
,colDec
,5000,5000,true);
1314 m_colCapFore
= capForeCol
;
1315 m_categoryDefaultCell
.GetData()->SetFgCol(capForeCol
);
1318 if ( !(m_coloursCustomized
& 0x0008) )
1320 wxColour bgCol
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW
);
1321 m_colPropBack
= bgCol
;
1322 m_propertyDefaultCell
.GetData()->SetBgCol(bgCol
);
1325 if ( !(m_coloursCustomized
& 0x0010) )
1327 wxColour fgCol
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT
);
1328 m_colPropFore
= fgCol
;
1329 m_propertyDefaultCell
.GetData()->SetFgCol(fgCol
);
1332 if ( !(m_coloursCustomized
& 0x0020) )
1333 m_colSelBack
= wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT
);
1335 if ( !(m_coloursCustomized
& 0x0040) )
1336 m_colSelFore
= wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHTTEXT
);
1338 if ( !(m_coloursCustomized
& 0x0080) )
1339 m_colLine
= m_colCapBack
;
1341 if ( !(m_coloursCustomized
& 0x0100) )
1342 m_colDisPropFore
= m_colCapFore
;
1344 m_colEmptySpace
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW
);
1347 // -----------------------------------------------------------------------
1349 void wxPropertyGrid::ResetColours()
1351 m_coloursCustomized
= 0;
1358 // -----------------------------------------------------------------------
1360 bool wxPropertyGrid::SetFont( const wxFont
& font
)
1362 // Must disable active editor.
1365 bool res
= wxScrolledWindow::SetFont( font
);
1366 if ( res
&& GetParent()) // may not have been Create()ed yet if SetFont called from SetWindowVariant
1368 CalculateFontAndBitmapStuff( m_vspacing
);
1375 // -----------------------------------------------------------------------
1377 void wxPropertyGrid::SetLineColour( const wxColour
& col
)
1380 m_coloursCustomized
|= 0x80;
1384 // -----------------------------------------------------------------------
1386 void wxPropertyGrid::SetMarginColour( const wxColour
& col
)
1389 m_coloursCustomized
|= 0x01;
1393 // -----------------------------------------------------------------------
1395 void wxPropertyGrid::SetCellBackgroundColour( const wxColour
& col
)
1397 m_colPropBack
= col
;
1398 m_coloursCustomized
|= 0x08;
1400 m_propertyDefaultCell
.GetData()->SetBgCol(col
);
1405 // -----------------------------------------------------------------------
1407 void wxPropertyGrid::SetCellTextColour( const wxColour
& col
)
1409 m_colPropFore
= col
;
1410 m_coloursCustomized
|= 0x10;
1412 m_propertyDefaultCell
.GetData()->SetFgCol(col
);
1417 // -----------------------------------------------------------------------
1419 void wxPropertyGrid::SetEmptySpaceColour( const wxColour
& col
)
1421 m_colEmptySpace
= col
;
1426 // -----------------------------------------------------------------------
1428 void wxPropertyGrid::SetCellDisabledTextColour( const wxColour
& col
)
1430 m_colDisPropFore
= col
;
1431 m_coloursCustomized
|= 0x100;
1435 // -----------------------------------------------------------------------
1437 void wxPropertyGrid::SetSelectionBackgroundColour( const wxColour
& col
)
1440 m_coloursCustomized
|= 0x20;
1444 // -----------------------------------------------------------------------
1446 void wxPropertyGrid::SetSelectionTextColour( const wxColour
& col
)
1449 m_coloursCustomized
|= 0x40;
1453 // -----------------------------------------------------------------------
1455 void wxPropertyGrid::SetCaptionBackgroundColour( const wxColour
& col
)
1458 m_coloursCustomized
|= 0x02;
1460 m_categoryDefaultCell
.GetData()->SetBgCol(col
);
1465 // -----------------------------------------------------------------------
1467 void wxPropertyGrid::SetCaptionTextColour( const wxColour
& col
)
1470 m_coloursCustomized
|= 0x04;
1472 m_categoryDefaultCell
.GetData()->SetFgCol(col
);
1477 // -----------------------------------------------------------------------
1478 // wxPropertyGrid property adding and removal
1479 // -----------------------------------------------------------------------
1481 void wxPropertyGrid::PrepareAfterItemsAdded()
1483 if ( !m_pState
|| !m_pState
->m_itemsAdded
) return;
1485 m_pState
->m_itemsAdded
= 0;
1487 if ( m_windowStyle
& wxPG_AUTO_SORT
)
1488 Sort(wxPG_SORT_TOP_LEVEL_ONLY
);
1490 RecalculateVirtualSize();
1493 // -----------------------------------------------------------------------
1494 // wxPropertyGrid property operations
1495 // -----------------------------------------------------------------------
1497 bool wxPropertyGrid::EnsureVisible( wxPGPropArg id
)
1499 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
1503 bool changed
= false;
1505 // Is it inside collapsed section?
1506 if ( !p
->IsVisible() )
1509 wxPGProperty
* parent
= p
->GetParent();
1510 wxPGProperty
* grandparent
= parent
->GetParent();
1512 if ( grandparent
&& grandparent
!= m_pState
->m_properties
)
1513 Expand( grandparent
);
1521 GetViewStart(&vx
,&vy
);
1522 vy
*=wxPG_PIXELS_PER_UNIT
;
1528 Scroll(vx
, y
/wxPG_PIXELS_PER_UNIT
);
1529 m_iFlags
|= wxPG_FL_SCROLLED
;
1532 else if ( (y
+m_lineHeight
) > (vy
+m_height
) )
1534 Scroll(vx
, (y
-m_height
+(m_lineHeight
*2))/wxPG_PIXELS_PER_UNIT
);
1535 m_iFlags
|= wxPG_FL_SCROLLED
;
1545 // -----------------------------------------------------------------------
1546 // wxPropertyGrid helper methods called by properties
1547 // -----------------------------------------------------------------------
1549 // Control font changer helper.
1550 void wxPropertyGrid::SetCurControlBoldFont()
1552 wxASSERT( m_wndEditor
);
1553 m_wndEditor
->SetFont( m_captionFont
);
1556 // -----------------------------------------------------------------------
1558 wxPoint
wxPropertyGrid::GetGoodEditorDialogPosition( wxPGProperty
* p
,
1561 #if wxPG_SMALL_SCREEN
1562 // On small-screen devices, always show dialogs with default position and size.
1563 return wxDefaultPosition
;
1565 int splitterX
= GetSplitterPosition();
1569 wxCHECK_MSG( y
>= 0, wxPoint(-1,-1), wxT("invalid y?") );
1571 ImprovedClientToScreen( &x
, &y
);
1573 int sw
= wxSystemSettings::GetMetric( ::wxSYS_SCREEN_X
);
1574 int sh
= wxSystemSettings::GetMetric( ::wxSYS_SCREEN_Y
);
1581 new_x
= x
+ (m_width
-splitterX
) - sz
.x
;
1591 new_y
= y
+ m_lineHeight
;
1593 return wxPoint(new_x
,new_y
);
1597 // -----------------------------------------------------------------------
1599 wxString
& wxPropertyGrid::ExpandEscapeSequences( wxString
& dst_str
, wxString
& src_str
)
1601 if ( src_str
.length() == 0 )
1607 bool prev_is_slash
= false;
1609 wxString::const_iterator i
= src_str
.begin();
1613 for ( ; i
!= src_str
.end(); ++i
)
1617 if ( a
!= wxS('\\') )
1619 if ( !prev_is_slash
)
1625 if ( a
== wxS('n') )
1628 dst_str
<< wxS('\n');
1630 dst_str
<< wxS('\n');
1633 else if ( a
== wxS('t') )
1634 dst_str
<< wxS('\t');
1638 prev_is_slash
= false;
1642 if ( prev_is_slash
)
1644 dst_str
<< wxS('\\');
1645 prev_is_slash
= false;
1649 prev_is_slash
= true;
1656 // -----------------------------------------------------------------------
1658 wxString
& wxPropertyGrid::CreateEscapeSequences( wxString
& dst_str
, wxString
& src_str
)
1660 if ( src_str
.length() == 0 )
1666 wxString::const_iterator i
= src_str
.begin();
1667 wxUniChar prev_a
= wxS('\0');
1671 for ( ; i
!= src_str
.end(); ++i
)
1675 if ( a
>= wxS(' ') )
1677 // This surely is not something that requires an escape sequence.
1682 // This might need...
1683 if ( a
== wxS('\r') )
1685 // DOS style line end.
1686 // Already taken care below
1688 else if ( a
== wxS('\n') )
1689 // UNIX style line end.
1690 dst_str
<< wxS("\\n");
1691 else if ( a
== wxS('\t') )
1693 dst_str
<< wxS('\t');
1696 //wxLogDebug(wxT("WARNING: Could not create escape sequence for character #%i"),(int)a);
1706 // -----------------------------------------------------------------------
1708 wxPGProperty
* wxPropertyGrid::DoGetItemAtY( int y
) const
1715 return m_pState
->m_properties
->GetItemAtY(y
, m_lineHeight
, &a
);
1718 // -----------------------------------------------------------------------
1719 // wxPropertyGrid graphics related methods
1720 // -----------------------------------------------------------------------
1722 void wxPropertyGrid::OnPaint( wxPaintEvent
& WXUNUSED(event
) )
1727 // Don't paint after destruction has begun
1728 if ( !HasInternalFlag(wxPG_FL_INITIALIZED
) )
1731 // Find out where the window is scrolled to
1732 int vx
,vy
; // Top left corner of client
1733 GetViewStart(&vx
,&vy
);
1734 vy
*= wxPG_PIXELS_PER_UNIT
;
1736 // Update everything inside the box
1737 wxRect r
= GetUpdateRegion().GetBox();
1741 // FIXME: This is just a workaround for a bug that causes splitters not
1742 // to paint when other windows are being dragged over the grid.
1743 wxRect fullRect
= GetRect();
1745 r
.width
= fullRect
.width
;
1747 // Repaint this rectangle
1748 DrawItems( dc
, r
.y
, r
.y
+ r
.height
, &r
);
1750 // We assume that the size set when grid is shown
1751 // is what is desired.
1752 SetInternalFlag(wxPG_FL_GOOD_SIZE_SET
);
1755 // -----------------------------------------------------------------------
1757 void wxPropertyGrid::DrawExpanderButton( wxDC
& dc
, const wxRect
& rect
,
1758 wxPGProperty
* property
) const
1760 // Prepare rectangle to be used
1762 r
.x
+= m_gutterWidth
; r
.y
+= m_buttonSpacingY
;
1763 r
.width
= m_iconWidth
; r
.height
= m_iconHeight
;
1765 #if (wxPG_USE_RENDERER_NATIVE)
1767 #elif wxPG_ICON_WIDTH
1768 // Drawing expand/collapse button manually
1769 dc
.SetPen(m_colPropFore
);
1770 if ( property
->IsCategory() )
1771 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
1773 dc
.SetBrush(m_colPropBack
);
1775 dc
.DrawRectangle( r
);
1776 int _y
= r
.y
+(m_iconWidth
/2);
1777 dc
.DrawLine(r
.x
+2,_y
,r
.x
+m_iconWidth
-2,_y
);
1782 if ( property
->IsExpanded() )
1784 // wxRenderer functions are non-mutating in nature, so it
1785 // should be safe to cast "const wxPropertyGrid*" to "wxWindow*".
1786 // Hopefully this does not cause problems.
1787 #if (wxPG_USE_RENDERER_NATIVE)
1788 wxRendererNative::Get().DrawTreeItemButton(
1794 #elif wxPG_ICON_WIDTH
1803 #if (wxPG_USE_RENDERER_NATIVE)
1804 wxRendererNative::Get().DrawTreeItemButton(
1810 #elif wxPG_ICON_WIDTH
1811 int _x
= r
.x
+(m_iconWidth
/2);
1812 dc
.DrawLine(_x
,r
.y
+2,_x
,r
.y
+m_iconWidth
-2);
1818 #if (wxPG_USE_RENDERER_NATIVE)
1820 #elif wxPG_ICON_WIDTH
1823 dc
.DrawBitmap( *bmp
, r
.x
, r
.y
, true );
1827 // -----------------------------------------------------------------------
1830 // This is the one called by OnPaint event handler and others.
1831 // topy and bottomy are already unscrolled (ie. physical)
1833 void wxPropertyGrid::DrawItems( wxDC
& dc
,
1835 unsigned int bottomy
,
1836 const wxRect
* drawRect
)
1838 if ( m_frozen
|| m_height
< 1 || bottomy
< topy
|| !m_pState
)
1841 m_pState
->EnsureVirtualHeight();
1843 wxRect tempDrawRect
;
1846 tempDrawRect
= wxRect(0, topy
,
1849 drawRect
= &tempDrawRect
;
1852 // items added check
1853 if ( m_pState
->m_itemsAdded
) PrepareAfterItemsAdded();
1855 int paintFinishY
= 0;
1857 if ( m_pState
->m_properties
->GetChildCount() > 0 )
1860 bool isBuffered
= false;
1862 #if wxPG_DOUBLE_BUFFER
1863 wxMemoryDC
* bufferDC
= NULL
;
1865 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING
) )
1867 if ( !m_doubleBuffer
)
1869 paintFinishY
= drawRect
->y
;
1874 bufferDC
= new wxMemoryDC();
1876 // If nothing was changed, then just copy from double-buffer
1877 bufferDC
->SelectObject( *m_doubleBuffer
);
1887 dc
.SetClippingRegion( *drawRect
);
1888 paintFinishY
= DoDrawItems( *dcPtr
, drawRect
, isBuffered
);
1889 int drawBottomY
= drawRect
->y
+ drawRect
->height
;
1891 // Clear area beyond bottomY?
1892 if ( paintFinishY
< drawBottomY
)
1894 dcPtr
->SetPen(m_colEmptySpace
);
1895 dcPtr
->SetBrush(m_colEmptySpace
);
1896 dcPtr
->DrawRectangle(0, paintFinishY
,
1901 dc
.DestroyClippingRegion();
1904 #if wxPG_DOUBLE_BUFFER
1907 dc
.Blit( drawRect
->x
, drawRect
->y
, drawRect
->width
,
1909 bufferDC
, 0, 0, wxCOPY
);
1916 // Just clear the area
1917 dc
.SetPen(m_colEmptySpace
);
1918 dc
.SetBrush(m_colEmptySpace
);
1919 dc
.DrawRectangle(*drawRect
);
1923 // -----------------------------------------------------------------------
1925 int wxPropertyGrid::DoDrawItems( wxDC
& dc
,
1926 const wxRect
* clipRect
,
1927 bool isBuffered
) const
1929 const wxPGProperty
* firstItem
;
1930 const wxPGProperty
* lastItem
;
1932 firstItem
= DoGetItemAtY(clipRect
->y
);
1933 lastItem
= DoGetItemAtY(clipRect
->y
+clipRect
->height
-1);
1936 lastItem
= GetLastItem( wxPG_ITERATE_VISIBLE
);
1938 if ( m_frozen
|| m_height
< 1 || firstItem
== NULL
)
1941 wxCHECK_MSG( !m_pState
->m_itemsAdded
, clipRect
->y
, wxT("no items added") );
1942 wxASSERT( m_pState
->m_properties
->GetChildCount() );
1944 int lh
= m_lineHeight
;
1947 int lastItemBottomY
;
1949 firstItemTopY
= clipRect
->y
;
1950 lastItemBottomY
= clipRect
->y
+ clipRect
->height
;
1952 // Align y coordinates to item boundaries
1953 firstItemTopY
-= firstItemTopY
% lh
;
1954 lastItemBottomY
+= lh
- (lastItemBottomY
% lh
);
1955 lastItemBottomY
-= 1;
1957 // Entire range outside scrolled, visible area?
1958 if ( firstItemTopY
>= (int)m_pState
->GetVirtualHeight() || lastItemBottomY
<= 0 )
1961 wxCHECK_MSG( firstItemTopY
< lastItemBottomY
, clipRect
->y
, wxT("invalid y values") );
1965 wxLogDebug(wxT(" -> DoDrawItems ( \"%s\" -> \"%s\", height=%i (ch=%i), clipRect = 0x%lX )"),
1966 firstItem->GetLabel().c_str(),
1967 lastItem->GetLabel().c_str(),
1968 (int)(lastItemBottomY - firstItemTopY),
1970 (unsigned long)clipRect );
1975 long windowStyle
= m_windowStyle
;
1981 // With wxPG_DOUBLE_BUFFER, do double buffering
1982 // - buffer's y = 0, so align cliprect and coordinates to that
1984 #if wxPG_DOUBLE_BUFFER
1990 xRelMod
= clipRect
->x
;
1991 yRelMod
= clipRect
->y
;
1994 // clipRect conversion
1999 firstItemTopY
-= yRelMod
;
2000 lastItemBottomY
-= yRelMod
;
2003 wxUnusedVar(isBuffered
);
2006 int x
= m_marginWidth
- xRelMod
;
2008 wxFont normalFont
= GetFont();
2010 bool reallyFocused
= (m_iFlags
& wxPG_FL_FOCUSED
) != 0;
2012 bool isPgEnabled
= IsEnabled();
2015 // Prepare some pens and brushes that are often changed to.
2018 wxBrush
marginBrush(m_colMargin
);
2019 wxPen
marginPen(m_colMargin
);
2020 wxBrush
capbgbrush(m_colCapBack
,wxSOLID
);
2021 wxPen
linepen(m_colLine
,1,wxSOLID
);
2023 wxColour selBackCol
;
2025 selBackCol
= m_colSelBack
;
2027 selBackCol
= m_colMargin
;
2029 // pen that has same colour as text
2030 wxPen
outlinepen(m_colPropFore
,1,wxSOLID
);
2033 // Clear margin with background colour
2035 dc
.SetBrush( marginBrush
);
2036 if ( !(windowStyle
& wxPG_HIDE_MARGIN
) )
2038 dc
.SetPen( *wxTRANSPARENT_PEN
);
2039 dc
.DrawRectangle(-1-xRelMod
,firstItemTopY
-1,x
+2,lastItemBottomY
-firstItemTopY
+2);
2042 const wxPGProperty
* firstSelected
= GetSelection();
2043 const wxPropertyGridPageState
* state
= m_pState
;
2045 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2046 bool wasSelectedPainted
= false;
2049 // TODO: Only render columns that are within clipping region.
2051 dc
.SetFont(normalFont
);
2053 wxPropertyGridConstIterator
it( state
, wxPG_ITERATE_VISIBLE
, firstItem
);
2054 int endScanBottomY
= lastItemBottomY
+ lh
;
2055 int y
= firstItemTopY
;
2058 // Pregenerate list of visible properties.
2059 wxArrayPGProperty visPropArray
;
2060 visPropArray
.reserve((m_height
/m_lineHeight
)+6);
2062 for ( ; !it
.AtEnd(); it
.Next() )
2064 const wxPGProperty
* p
= *it
;
2066 if ( !p
->HasFlag(wxPG_PROP_HIDDEN
) )
2068 visPropArray
.push_back((wxPGProperty
*)p
);
2070 if ( y
> endScanBottomY
)
2077 visPropArray
.push_back(NULL
);
2079 wxPGProperty
* nextP
= visPropArray
[0];
2081 int gridWidth
= state
->m_width
;
2084 for ( unsigned int arrInd
=1;
2085 nextP
&& y
<= lastItemBottomY
;
2088 wxPGProperty
* p
= nextP
;
2089 nextP
= visPropArray
[arrInd
];
2091 int rowHeight
= m_fontHeight
+(m_spacingy
*2)+1;
2092 int textMarginHere
= x
;
2093 int renderFlags
= 0;
2095 int greyDepth
= m_marginWidth
;
2096 if ( !(windowStyle
& wxPG_HIDE_CATEGORIES
) )
2097 greyDepth
= (((int)p
->m_depthBgCol
)-1) * m_subgroup_extramargin
+ m_marginWidth
;
2099 int greyDepthX
= greyDepth
- xRelMod
;
2101 // Use basic depth if in non-categoric mode and parent is base array.
2102 if ( !(windowStyle
& wxPG_HIDE_CATEGORIES
) || p
->GetParent() != m_pState
->m_properties
)
2104 textMarginHere
+= ((unsigned int)((p
->m_depth
-1)*m_subgroup_extramargin
));
2107 // Paint margin area
2108 dc
.SetBrush(marginBrush
);
2109 dc
.SetPen(marginPen
);
2110 dc
.DrawRectangle( -xRelMod
, y
, greyDepth
, lh
);
2112 dc
.SetPen( linepen
);
2118 // Modified by JACS to not draw a margin if wxPG_HIDE_MARGIN is specified, since it
2119 // looks better, at least under Windows when we have a themed border (the themed-window-specific
2120 // whitespace between the real border and the propgrid margin exacerbates the double-border look).
2122 // Is this or its parent themed?
2123 bool suppressMarginEdge
= (GetWindowStyle() & wxPG_HIDE_MARGIN
) &&
2124 (((GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_THEME
) ||
2125 (((GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_NONE
) && ((GetParent()->GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_THEME
)));
2127 bool suppressMarginEdge
= false;
2129 if (!suppressMarginEdge
)
2130 dc
.DrawLine( greyDepthX
, y
, greyDepthX
, y2
);
2133 // Blank out the margin edge
2134 dc
.SetPen(wxPen(GetBackgroundColour()));
2135 dc
.DrawLine( greyDepthX
, y
, greyDepthX
, y2
);
2136 dc
.SetPen( linepen
);
2143 for ( si
=0; si
<state
->m_colWidths
.size(); si
++ )
2145 sx
+= state
->m_colWidths
[si
];
2146 dc
.DrawLine( sx
, y
, sx
, y2
);
2149 // Horizontal Line, below
2150 // (not if both this and next is category caption)
2151 if ( p
->IsCategory() &&
2152 nextP
&& nextP
->IsCategory() )
2153 dc
.SetPen(m_colCapBack
);
2155 dc
.DrawLine( greyDepthX
, y2
-1, gridWidth
-xRelMod
, y2
-1 );
2158 // Need to override row colours?
2162 bool isSelected
= state
->DoIsPropertySelected(p
);
2166 // Disabled may get different colour.
2167 if ( !p
->IsEnabled() )
2169 renderFlags
|= wxPGCellRenderer::Disabled
|
2170 wxPGCellRenderer::DontUseCellFgCol
;
2171 rowFgCol
= m_colDisPropFore
;
2176 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2177 if ( p
== firstSelected
)
2178 wasSelectedPainted
= true;
2181 renderFlags
|= wxPGCellRenderer::Selected
;
2183 if ( !p
->IsCategory() )
2185 renderFlags
|= wxPGCellRenderer::DontUseCellFgCol
|
2186 wxPGCellRenderer::DontUseCellBgCol
;
2188 if ( reallyFocused
&& p
== firstSelected
)
2190 rowFgCol
= m_colSelFore
;
2191 rowBgCol
= selBackCol
;
2193 else if ( isPgEnabled
)
2195 rowFgCol
= m_colPropFore
;
2196 if ( p
== firstSelected
)
2197 rowBgCol
= m_colMargin
;
2199 rowBgCol
= selBackCol
;
2203 rowFgCol
= m_colDisPropFore
;
2204 rowBgCol
= selBackCol
;
2211 if ( rowBgCol
.IsOk() )
2212 rowBgBrush
= wxBrush(rowBgCol
);
2214 if ( HasInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
) )
2215 renderFlags
= renderFlags
& ~wxPGCellRenderer::DontUseCellColours
;
2218 // Fill additional margin area with background colour of first cell
2219 if ( greyDepthX
< textMarginHere
)
2221 if ( !(renderFlags
& wxPGCellRenderer::DontUseCellBgCol
) )
2223 wxPGCell
& cell
= p
->GetCell(0);
2224 rowBgCol
= cell
.GetBgCol();
2225 rowBgBrush
= wxBrush(rowBgCol
);
2227 dc
.SetBrush(rowBgBrush
);
2228 dc
.SetPen(rowBgCol
);
2229 dc
.DrawRectangle(greyDepthX
+1, y
,
2230 textMarginHere
-greyDepthX
, lh
-1);
2233 bool fontChanged
= false;
2235 // Expander button rectangle
2236 wxRect
butRect( ((p
->m_depth
- 1) * m_subgroup_extramargin
) - xRelMod
,
2241 if ( p
->IsCategory() )
2243 // Captions have their cell areas merged as one
2244 dc
.SetFont(m_captionFont
);
2246 wxRect
cellRect(greyDepthX
, y
, gridWidth
- greyDepth
+ 2, rowHeight
-1 );
2248 if ( renderFlags
& wxPGCellRenderer::DontUseCellBgCol
)
2250 dc
.SetBrush(rowBgBrush
);
2251 dc
.SetPen(rowBgCol
);
2254 if ( renderFlags
& wxPGCellRenderer::DontUseCellFgCol
)
2256 dc
.SetTextForeground(rowFgCol
);
2259 wxPGCellRenderer
* renderer
= p
->GetCellRenderer(0);
2260 renderer
->Render( dc
, cellRect
, this, p
, 0, -1, renderFlags
);
2263 if ( !HasFlag(wxPG_HIDE_MARGIN
) && p
->HasVisibleChildren() )
2264 DrawExpanderButton( dc
, butRect
, p
);
2268 if ( p
->m_flags
& wxPG_PROP_MODIFIED
&& (windowStyle
& wxPG_BOLD_MODIFIED
) )
2270 dc
.SetFont(m_captionFont
);
2276 int nextCellWidth
= state
->m_colWidths
[0] -
2277 (greyDepthX
- m_marginWidth
);
2278 wxRect
cellRect(greyDepthX
+1, y
, 0, rowHeight
-1);
2279 int textXAdd
= textMarginHere
- greyDepthX
;
2281 for ( ci
=0; ci
<state
->m_colWidths
.size(); ci
++ )
2283 cellRect
.width
= nextCellWidth
- 1;
2285 wxWindow
* cellEditor
= NULL
;
2286 int cellRenderFlags
= renderFlags
;
2288 // Tree Item Button (must be drawn before clipping is set up)
2289 if ( ci
== 0 && !HasFlag(wxPG_HIDE_MARGIN
) && p
->HasVisibleChildren() )
2290 DrawExpanderButton( dc
, butRect
, p
);
2293 if ( isSelected
&& (ci
== 1 || ci
== m_selColumn
) )
2295 if ( p
== firstSelected
)
2297 if ( ci
== 1 && m_wndEditor
)
2298 cellEditor
= m_wndEditor
;
2299 else if ( ci
== m_selColumn
&& m_labelEditor
)
2300 cellEditor
= m_labelEditor
;
2305 wxColour editorBgCol
=
2306 cellEditor
->GetBackgroundColour();
2307 dc
.SetBrush(editorBgCol
);
2308 dc
.SetPen(editorBgCol
);
2309 dc
.SetTextForeground(m_colPropFore
);
2310 dc
.DrawRectangle(cellRect
);
2312 if ( m_dragStatus
!= 0 ||
2313 (m_iFlags
& wxPG_FL_CUR_USES_CUSTOM_IMAGE
) )
2318 dc
.SetBrush(m_colPropBack
);
2319 dc
.SetPen(m_colPropBack
);
2320 dc
.SetTextForeground(m_colDisPropFore
);
2321 if ( p
->IsEnabled() )
2322 dc
.SetTextForeground(rowFgCol
);
2324 dc
.SetTextForeground(m_colDisPropFore
);
2329 if ( renderFlags
& wxPGCellRenderer::DontUseCellBgCol
)
2331 dc
.SetBrush(rowBgBrush
);
2332 dc
.SetPen(rowBgCol
);
2335 if ( renderFlags
& wxPGCellRenderer::DontUseCellFgCol
)
2337 dc
.SetTextForeground(rowFgCol
);
2341 dc
.SetClippingRegion(cellRect
);
2343 cellRect
.x
+= textXAdd
;
2344 cellRect
.width
-= textXAdd
;
2349 wxPGCellRenderer
* renderer
;
2350 int cmnVal
= p
->GetCommonValue();
2351 if ( cmnVal
== -1 || ci
!= 1 )
2353 renderer
= p
->GetCellRenderer(ci
);
2354 renderer
->Render( dc
, cellRect
, this, p
, ci
, -1,
2359 renderer
= GetCommonValue(cmnVal
)->GetRenderer();
2360 renderer
->Render( dc
, cellRect
, this, p
, ci
, -1,
2365 cellX
+= state
->m_colWidths
[ci
];
2366 if ( ci
< (state
->m_colWidths
.size()-1) )
2367 nextCellWidth
= state
->m_colWidths
[ci
+1];
2369 dc
.DestroyClippingRegion(); // Is this really necessary?
2375 dc
.SetFont(normalFont
);
2380 // Refresh editor controls (seems not needed on msw)
2381 // NOTE: This code is mandatory for GTK!
2382 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2383 if ( wasSelectedPainted
)
2386 m_wndEditor
->Refresh();
2388 m_wndEditor2
->Refresh();
2395 // -----------------------------------------------------------------------
2397 wxRect
wxPropertyGrid::GetPropertyRect( const wxPGProperty
* p1
, const wxPGProperty
* p2
) const
2401 if ( m_width
< 10 || m_height
< 10 ||
2402 !m_pState
->m_properties
->GetChildCount() ||
2404 return wxRect(0,0,0,0);
2409 // Return rect which encloses the given property range
2411 int visTop
= p1
->GetY();
2414 visBottom
= p2
->GetY() + m_lineHeight
;
2416 visBottom
= m_height
+ visTop
;
2418 // If seleced property is inside the range, we'll extend the range to include
2420 wxPGProperty
* selected
= GetSelection();
2423 int selectedY
= selected
->GetY();
2424 if ( selectedY
>= visTop
&& selectedY
< visBottom
)
2426 wxWindow
* editor
= GetEditorControl();
2429 int visBottom2
= selectedY
+ editor
->GetSize().y
;
2430 if ( visBottom2
> visBottom
)
2431 visBottom
= visBottom2
;
2436 return wxRect(0,visTop
-vy
,m_pState
->m_width
,visBottom
-visTop
);
2439 // -----------------------------------------------------------------------
2441 void wxPropertyGrid::DrawItems( const wxPGProperty
* p1
, const wxPGProperty
* p2
)
2446 if ( m_pState
->m_itemsAdded
)
2447 PrepareAfterItemsAdded();
2449 wxRect r
= GetPropertyRect(p1
, p2
);
2456 // -----------------------------------------------------------------------
2458 void wxPropertyGrid::RefreshProperty( wxPGProperty
* p
)
2460 if ( m_pState
->DoIsPropertySelected(p
) )
2462 // NB: We must copy the selection.
2463 wxArrayPGProperty selection
= m_pState
->m_selection
;
2464 DoSetSelection(selection
, wxPG_SEL_FORCE
);
2467 DrawItemAndChildren(p
);
2470 // -----------------------------------------------------------------------
2472 void wxPropertyGrid::DrawItemAndValueRelated( wxPGProperty
* p
)
2477 // Draw item, children, and parent too, if it is not category
2478 wxPGProperty
* parent
= p
->GetParent();
2481 !parent
->IsCategory() &&
2482 parent
->GetParent() )
2485 parent
= parent
->GetParent();
2488 DrawItemAndChildren(p
);
2491 void wxPropertyGrid::DrawItemAndChildren( wxPGProperty
* p
)
2493 wxCHECK_RET( p
, wxT("invalid property id") );
2495 // Do not draw if in non-visible page
2496 if ( p
->GetParentState() != m_pState
)
2499 // do not draw a single item if multiple pending
2500 if ( m_pState
->m_itemsAdded
|| m_frozen
)
2503 // Update child control.
2504 wxPGProperty
* selected
= GetSelection();
2505 if ( selected
&& selected
->GetParent() == p
)
2508 const wxPGProperty
* lastDrawn
= p
->GetLastVisibleSubItem();
2510 DrawItems(p
, lastDrawn
);
2513 // -----------------------------------------------------------------------
2515 void wxPropertyGrid::Refresh( bool WXUNUSED(eraseBackground
),
2516 const wxRect
*rect
)
2518 PrepareAfterItemsAdded();
2520 wxWindow::Refresh(false, rect
);
2522 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2523 // I think this really helps only GTK+1.2
2524 if ( m_wndEditor
) m_wndEditor
->Refresh();
2525 if ( m_wndEditor2
) m_wndEditor2
->Refresh();
2529 // -----------------------------------------------------------------------
2530 // wxPropertyGrid global operations
2531 // -----------------------------------------------------------------------
2533 void wxPropertyGrid::Clear()
2535 m_pState
->DoClear();
2541 RecalculateVirtualSize();
2543 // Need to clear some area at the end
2545 RefreshRect(wxRect(0, 0, m_width
, m_height
));
2548 // -----------------------------------------------------------------------
2550 bool wxPropertyGrid::EnableCategories( bool enable
)
2557 // Enable categories
2560 m_windowStyle
&= ~(wxPG_HIDE_CATEGORIES
);
2565 // Disable categories
2567 m_windowStyle
|= wxPG_HIDE_CATEGORIES
;
2570 if ( !m_pState
->EnableCategories(enable
) )
2575 if ( m_windowStyle
& wxPG_AUTO_SORT
)
2577 m_pState
->m_itemsAdded
= 1; // force
2578 PrepareAfterItemsAdded();
2582 m_pState
->m_itemsAdded
= 1;
2584 // No need for RecalculateVirtualSize() here - it is already called in
2585 // wxPropertyGridPageState method above.
2592 // -----------------------------------------------------------------------
2594 void wxPropertyGrid::SwitchState( wxPropertyGridPageState
* pNewState
)
2596 wxASSERT( pNewState
);
2597 wxASSERT( pNewState
->GetGrid() );
2599 if ( pNewState
== m_pState
)
2602 wxArrayPGProperty oldSelection
= m_pState
->m_selection
;
2604 // Call ClearSelection() instead of DoClearSelection()
2605 // so that selection clear events are not sent.
2608 m_pState
->m_selection
= oldSelection
;
2610 bool orig_mode
= m_pState
->IsInNonCatMode();
2611 bool new_state_mode
= pNewState
->IsInNonCatMode();
2613 m_pState
= pNewState
;
2616 int pgWidth
= GetClientSize().x
;
2617 if ( HasVirtualWidth() )
2619 int minWidth
= pgWidth
;
2620 if ( pNewState
->m_width
< minWidth
)
2622 pNewState
->m_width
= minWidth
;
2623 pNewState
->CheckColumnWidths();
2629 // Just in case, fully re-center splitter
2630 if ( HasFlag( wxPG_SPLITTER_AUTO_CENTER
) )
2631 pNewState
->m_fSplitterX
= -1.0;
2633 pNewState
->OnClientWidthChange( pgWidth
, pgWidth
- pNewState
->m_width
);
2638 // If necessary, convert state to correct mode.
2639 if ( orig_mode
!= new_state_mode
)
2641 // This should refresh as well.
2642 EnableCategories( orig_mode
?false:true );
2644 else if ( !m_frozen
)
2646 // Refresh, if not frozen.
2647 m_pState
->PrepareAfterItemsAdded();
2649 // Reselect (Use SetSelection() instead of Do-variant so that
2650 // events won't be sent).
2651 SetSelection(m_pState
->m_selection
);
2653 RecalculateVirtualSize(0);
2657 m_pState
->m_itemsAdded
= 1;
2660 // -----------------------------------------------------------------------
2662 // Call to SetSplitterPosition will always disable splitter auto-centering
2663 // if parent window is shown.
2664 void wxPropertyGrid::DoSetSplitterPosition_( int newxpos
, bool refresh
, int splitterIndex
, bool allPages
)
2666 if ( ( newxpos
< wxPG_DRAG_MARGIN
) )
2669 wxPropertyGridPageState
* state
= m_pState
;
2671 state
->DoSetSplitterPosition( newxpos
, splitterIndex
, allPages
);
2675 if ( GetSelection() )
2676 CorrectEditorWidgetSizeX();
2682 // -----------------------------------------------------------------------
2684 void wxPropertyGrid::CenterSplitter( bool enableAutoCentering
)
2686 SetSplitterPosition( m_width
/2, true );
2687 if ( enableAutoCentering
&& ( m_windowStyle
& wxPG_SPLITTER_AUTO_CENTER
) )
2688 m_iFlags
&= ~(wxPG_FL_DONT_CENTER_SPLITTER
);
2691 // -----------------------------------------------------------------------
2692 // wxPropertyGrid item iteration (GetNextProperty etc.) methods
2693 // -----------------------------------------------------------------------
2695 // Returns nearest paint visible property (such that will be painted unless
2696 // window is scrolled or resized). If given property is paint visible, then
2697 // it itself will be returned
2698 wxPGProperty
* wxPropertyGrid::GetNearestPaintVisible( wxPGProperty
* p
) const
2700 int vx
,vy1
;// Top left corner of client
2701 GetViewStart(&vx
,&vy1
);
2702 vy1
*= wxPG_PIXELS_PER_UNIT
;
2704 int vy2
= vy1
+ m_height
;
2705 int propY
= p
->GetY2(m_lineHeight
);
2707 if ( (propY
+ m_lineHeight
) < vy1
)
2710 return DoGetItemAtY( vy1
);
2712 else if ( propY
> vy2
)
2715 return DoGetItemAtY( vy2
);
2718 // Itself paint visible
2723 // -----------------------------------------------------------------------
2724 // Methods related to change in value, value modification and sending events
2725 // -----------------------------------------------------------------------
2727 // commits any changes in editor of selected property
2728 // return true if validation did not fail
2729 // flags are same as with DoSelectProperty
2730 bool wxPropertyGrid::CommitChangesFromEditor( wxUint32 flags
)
2732 // Committing already?
2733 if ( m_inCommitChangesFromEditor
)
2736 // Don't do this if already processing editor event. It might
2737 // induce recursive dialogs and crap like that.
2738 if ( m_iFlags
& wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
)
2740 if ( m_inDoPropertyChanged
)
2746 wxPGProperty
* selected
= GetSelection();
2749 IsEditorsValueModified() &&
2750 (m_iFlags
& wxPG_FL_INITIALIZED
) &&
2753 m_inCommitChangesFromEditor
= 1;
2755 wxVariant
variant(selected
->GetValueRef());
2756 bool valueIsPending
= false;
2758 // JACS - necessary to avoid new focus being found spuriously within OnIdle
2759 // due to another window getting focus
2760 wxWindow
* oldFocus
= m_curFocused
;
2762 bool validationFailure
= false;
2763 bool forceSuccess
= (flags
& (wxPG_SEL_NOVALIDATE
|wxPG_SEL_FORCE
)) ? true : false;
2765 m_chgInfo_changedProperty
= NULL
;
2767 // If truly modified, schedule value as pending.
2768 if ( selected
->GetEditorClass()->
2769 GetValueFromControl( variant
,
2771 GetEditorControl() ) )
2773 if ( DoEditorValidate() &&
2774 PerformValidation(selected
, variant
) )
2776 valueIsPending
= true;
2780 validationFailure
= true;
2785 EditorsValueWasNotModified();
2790 m_inCommitChangesFromEditor
= 0;
2792 if ( validationFailure
&& !forceSuccess
)
2796 oldFocus
->SetFocus();
2797 m_curFocused
= oldFocus
;
2800 res
= OnValidationFailure(selected
, variant
);
2802 // Now prevent further validation failure messages
2805 EditorsValueWasNotModified();
2806 OnValidationFailureReset(selected
);
2809 else if ( valueIsPending
)
2811 DoPropertyChanged( selected
, flags
);
2812 EditorsValueWasNotModified();
2821 // -----------------------------------------------------------------------
2823 bool wxPropertyGrid::PerformValidation( wxPGProperty
* p
, wxVariant
& pendingValue
,
2827 // Runs all validation functionality.
2828 // Returns true if value passes all tests.
2831 m_validationInfo
.m_failureBehavior
= m_permanentValidationFailureBehavior
;
2834 // Variant list a special value that cannot be validated
2836 if ( pendingValue
.GetType() != wxPG_VARIANT_TYPE_LIST
)
2838 if ( !p
->ValidateValue(pendingValue
, m_validationInfo
) )
2843 // Adapt list to child values, if necessary
2844 wxVariant listValue
= pendingValue
;
2845 wxVariant
* pPendingValue
= &pendingValue
;
2846 wxVariant
* pList
= NULL
;
2848 // If parent has wxPG_PROP_AGGREGATE flag, or uses composite
2849 // string value, then we need treat as it was changed instead
2850 // (or, in addition, as is the case with composite string parent).
2851 // This includes creating list variant for child values.
2853 wxPGProperty
* pwc
= p
->GetParent();
2854 wxPGProperty
* changedProperty
= p
;
2855 wxPGProperty
* baseChangedProperty
= changedProperty
;
2856 wxVariant bcpPendingList
;
2858 listValue
= pendingValue
;
2859 listValue
.SetName(p
->GetBaseName());
2862 (pwc
->HasFlag(wxPG_PROP_AGGREGATE
) || pwc
->HasFlag(wxPG_PROP_COMPOSED_VALUE
)) )
2864 wxVariantList tempList
;
2865 wxVariant
lv(tempList
, pwc
->GetBaseName());
2866 lv
.Append(listValue
);
2868 pPendingValue
= &listValue
;
2870 if ( pwc
->HasFlag(wxPG_PROP_AGGREGATE
) )
2872 baseChangedProperty
= pwc
;
2873 bcpPendingList
= lv
;
2876 changedProperty
= pwc
;
2877 pwc
= pwc
->GetParent();
2881 wxPGProperty
* evtChangingProperty
= changedProperty
;
2883 if ( pPendingValue
->GetType() != wxPG_VARIANT_TYPE_LIST
)
2885 value
= *pPendingValue
;
2889 // Convert list to child values
2890 pList
= pPendingValue
;
2891 changedProperty
->AdaptListToValue( *pPendingValue
, &value
);
2894 wxVariant evtChangingValue
= value
;
2896 if ( flags
& SendEvtChanging
)
2898 // FIXME: After proper ValueToString()s added, remove
2899 // this. It is just a temporary fix, as evt_changing
2900 // will simply not work for wxPG_PROP_COMPOSED_VALUE
2901 // (unless it is selected, and textctrl editor is open).
2902 if ( changedProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
2904 evtChangingProperty
= baseChangedProperty
;
2905 if ( evtChangingProperty
!= p
)
2907 evtChangingProperty
->AdaptListToValue( bcpPendingList
, &evtChangingValue
);
2911 evtChangingValue
= pendingValue
;
2915 if ( evtChangingProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
2917 if ( changedProperty
== GetSelection() )
2919 wxWindow
* editor
= GetEditorControl();
2920 wxASSERT( editor
->IsKindOf(CLASSINFO(wxTextCtrl
)) );
2921 evtChangingValue
= wxStaticCast(editor
, wxTextCtrl
)->GetValue();
2925 wxLogDebug(wxT("WARNING: wxEVT_PG_CHANGING is about to happen with old value."));
2930 wxASSERT( m_chgInfo_changedProperty
== NULL
);
2931 m_chgInfo_changedProperty
= changedProperty
;
2932 m_chgInfo_baseChangedProperty
= baseChangedProperty
;
2933 m_chgInfo_pendingValue
= value
;
2936 m_chgInfo_valueList
= *pList
;
2938 m_chgInfo_valueList
.MakeNull();
2940 // If changedProperty is not property which value was edited,
2941 // then call wxPGProperty::ValidateValue() for that as well.
2942 if ( p
!= changedProperty
&& value
.GetType() != wxPG_VARIANT_TYPE_LIST
)
2944 if ( !changedProperty
->ValidateValue(value
, m_validationInfo
) )
2948 if ( flags
& SendEvtChanging
)
2950 // SendEvent returns true if event was vetoed
2951 if ( SendEvent( wxEVT_PG_CHANGING
, evtChangingProperty
,
2952 &evtChangingValue
) )
2956 if ( flags
& IsStandaloneValidation
)
2958 // If called in 'generic' context, we need to reset
2959 // m_chgInfo_changedProperty and write back translated value.
2960 m_chgInfo_changedProperty
= NULL
;
2961 pendingValue
= value
;
2967 // -----------------------------------------------------------------------
2969 void wxPropertyGrid::DoShowPropertyError( wxPGProperty
* WXUNUSED(property
), const wxString
& msg
)
2971 if ( !msg
.length() )
2975 if ( !wxPGGlobalVars
->m_offline
)
2977 wxWindow
* topWnd
= ::wxGetTopLevelParent(this);
2980 wxFrame
* pFrame
= wxDynamicCast(topWnd
, wxFrame
);
2983 wxStatusBar
* pStatusBar
= pFrame
->GetStatusBar();
2986 pStatusBar
->SetStatusText(msg
);
2994 ::wxMessageBox(msg
, wxT("Property Error"));
2997 // -----------------------------------------------------------------------
2999 bool wxPropertyGrid::OnValidationFailure( wxPGProperty
* property
,
3000 wxVariant
& invalidValue
)
3002 wxWindow
* editor
= GetEditorControl();
3004 // First call property's handler
3005 property
->OnValidationFailure(invalidValue
);
3007 bool res
= DoOnValidationFailure(property
, invalidValue
);
3010 // For non-wxTextCtrl editors, we do need to revert the value
3011 if ( !editor
->IsKindOf(CLASSINFO(wxTextCtrl
)) &&
3012 property
== GetSelection() )
3014 property
->GetEditorClass()->UpdateControl(property
, editor
);
3017 property
->SetFlag(wxPG_PROP_INVALID_VALUE
);
3022 bool wxPropertyGrid::DoOnValidationFailure( wxPGProperty
* property
, wxVariant
& WXUNUSED(invalidValue
) )
3024 int vfb
= m_validationInfo
.m_failureBehavior
;
3026 if ( vfb
& wxPG_VFB_BEEP
)
3029 if ( (vfb
& wxPG_VFB_MARK_CELL
) &&
3030 !property
->HasFlag(wxPG_PROP_INVALID_VALUE
) )
3032 unsigned int colCount
= m_pState
->GetColumnCount();
3034 // We need backup marked property's cells
3035 m_propCellsBackup
= property
->m_cells
;
3037 wxColour vfbFg
= *wxWHITE
;
3038 wxColour vfbBg
= *wxRED
;
3040 property
->EnsureCells(colCount
);
3042 for ( unsigned int i
=0; i
<colCount
; i
++ )
3044 wxPGCell
& cell
= property
->m_cells
[i
];
3045 cell
.SetFgCol(vfbFg
);
3046 cell
.SetBgCol(vfbBg
);
3049 DrawItemAndChildren(property
);
3051 if ( property
== GetSelection() )
3053 SetInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
);
3055 wxWindow
* editor
= GetEditorControl();
3058 editor
->SetForegroundColour(vfbFg
);
3059 editor
->SetBackgroundColour(vfbBg
);
3064 if ( vfb
& wxPG_VFB_SHOW_MESSAGE
)
3066 wxString msg
= m_validationInfo
.m_failureMessage
;
3068 if ( !msg
.length() )
3069 msg
= wxT("You have entered invalid value. Press ESC to cancel editing.");
3071 DoShowPropertyError(property
, msg
);
3074 return (vfb
& wxPG_VFB_STAY_IN_PROPERTY
) ? false : true;
3077 // -----------------------------------------------------------------------
3079 void wxPropertyGrid::DoOnValidationFailureReset( wxPGProperty
* property
)
3081 int vfb
= m_validationInfo
.m_failureBehavior
;
3083 if ( vfb
& wxPG_VFB_MARK_CELL
)
3086 property
->m_cells
= m_propCellsBackup
;
3088 ClearInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
);
3090 if ( property
== GetSelection() && GetEditorControl() )
3092 // Calling this will recreate the control, thus resetting its colour
3093 RefreshProperty(property
);
3097 DrawItemAndChildren(property
);
3102 // -----------------------------------------------------------------------
3104 // flags are same as with DoSelectProperty
3105 bool wxPropertyGrid::DoPropertyChanged( wxPGProperty
* p
, unsigned int selFlags
)
3107 if ( m_inDoPropertyChanged
)
3110 wxWindow
* editor
= GetEditorControl();
3111 wxPGProperty
* selected
= GetSelection();
3113 m_pState
->m_anyModified
= 1;
3115 m_inDoPropertyChanged
= 1;
3117 // Maybe need to update control
3118 wxASSERT( m_chgInfo_changedProperty
!= NULL
);
3120 // These values were calculated in PerformValidation()
3121 wxPGProperty
* changedProperty
= m_chgInfo_changedProperty
;
3122 wxVariant value
= m_chgInfo_pendingValue
;
3124 wxPGProperty
* topPaintedProperty
= changedProperty
;
3126 while ( !topPaintedProperty
->IsCategory() &&
3127 !topPaintedProperty
->IsRoot() )
3129 topPaintedProperty
= topPaintedProperty
->GetParent();
3132 changedProperty
->SetValue(value
, &m_chgInfo_valueList
, wxPG_SETVAL_BY_USER
);
3134 // Set as Modified (not if dragging just began)
3135 if ( !(p
->m_flags
& wxPG_PROP_MODIFIED
) )
3137 p
->m_flags
|= wxPG_PROP_MODIFIED
;
3138 if ( p
== selected
&& (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3141 SetCurControlBoldFont();
3147 // Propagate updates to parent(s)
3149 wxPGProperty
* prevPwc
= NULL
;
3151 while ( prevPwc
!= topPaintedProperty
)
3153 pwc
->m_flags
|= wxPG_PROP_MODIFIED
;
3155 if ( pwc
== selected
&& (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3158 SetCurControlBoldFont();
3162 pwc
= pwc
->GetParent();
3165 // Draw the actual property
3166 DrawItemAndChildren( topPaintedProperty
);
3169 // If value was set by wxPGProperty::OnEvent, then update the editor
3171 if ( selFlags
& wxPG_SEL_DIALOGVAL
)
3177 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
3178 if ( m_wndEditor
) m_wndEditor
->Refresh();
3179 if ( m_wndEditor2
) m_wndEditor2
->Refresh();
3184 wxASSERT( !changedProperty
->GetParent()->HasFlag(wxPG_PROP_AGGREGATE
) );
3186 // If top parent has composite string value, then send to child parents,
3187 // starting from baseChangedProperty.
3188 if ( changedProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
3190 pwc
= m_chgInfo_baseChangedProperty
;
3192 while ( pwc
!= changedProperty
)
3194 SendEvent( wxEVT_PG_CHANGED
, pwc
, NULL
);
3195 pwc
= pwc
->GetParent();
3199 SendEvent( wxEVT_PG_CHANGED
, changedProperty
, NULL
);
3201 m_inDoPropertyChanged
= 0;
3206 // -----------------------------------------------------------------------
3208 bool wxPropertyGrid::ChangePropertyValue( wxPGPropArg id
, wxVariant newValue
)
3210 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
3212 m_chgInfo_changedProperty
= NULL
;
3214 if ( PerformValidation(p
, newValue
) )
3216 DoPropertyChanged(p
);
3221 OnValidationFailure(p
, newValue
);
3227 // -----------------------------------------------------------------------
3229 wxVariant
wxPropertyGrid::GetUncommittedPropertyValue()
3231 wxPGProperty
* prop
= GetSelectedProperty();
3234 return wxNullVariant
;
3236 wxTextCtrl
* tc
= GetEditorTextCtrl();
3237 wxVariant value
= prop
->GetValue();
3239 if ( !tc
|| !IsEditorsValueModified() )
3242 if ( !prop
->StringToValue(value
, tc
->GetValue()) )
3245 if ( !PerformValidation(prop
, value
, IsStandaloneValidation
) )
3246 return prop
->GetValue();
3251 // -----------------------------------------------------------------------
3253 // Runs wxValidator for the selected property
3254 bool wxPropertyGrid::DoEditorValidate()
3259 // -----------------------------------------------------------------------
3261 void wxPropertyGrid::HandleCustomEditorEvent( wxEvent
&event
)
3263 wxPGProperty
* selected
= GetSelection();
3265 // Somehow, event is handled after property has been deselected.
3266 // Possibly, but very rare.
3268 selected
->HasFlag(wxPG_PROP_BEING_DELETED
) ||
3269 // Also don't handle editor event if wxEVT_PG_CHANGED or
3270 // similar is currently doing something (showing a
3271 // message box, for instance).
3275 if ( m_iFlags
& wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
)
3278 wxVariant
pendingValue(selected
->GetValueRef());
3279 wxWindow
* wnd
= GetEditorControl();
3280 wxWindow
* editorWnd
= wxDynamicCast(event
.GetEventObject(), wxWindow
);
3282 bool wasUnspecified
= selected
->IsValueUnspecified();
3283 int usesAutoUnspecified
= selected
->UsesAutoUnspecified();
3284 bool valueIsPending
= false;
3286 m_chgInfo_changedProperty
= NULL
;
3288 m_iFlags
&= ~(wxPG_FL_VALIDATION_FAILED
|wxPG_FL_VALUE_CHANGE_IN_EVENT
);
3291 // Filter out excess wxTextCtrl modified events
3292 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_UPDATED
&&
3294 wnd
->IsKindOf(CLASSINFO(wxTextCtrl
)) )
3296 wxTextCtrl
* tc
= (wxTextCtrl
*) wnd
;
3298 wxString newTcValue
= tc
->GetValue();
3299 if ( m_prevTcValue
== newTcValue
)
3302 m_prevTcValue
= newTcValue
;
3305 SetInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
);
3307 bool validationFailure
= false;
3308 bool buttonWasHandled
= false;
3311 // Try common button handling
3312 if ( m_wndEditor2
&& event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
3314 wxPGEditorDialogAdapter
* adapter
= selected
->GetEditorDialog();
3318 buttonWasHandled
= true;
3319 // Store as res2, as previously (and still currently alternatively)
3320 // dialogs can be shown by handling wxEVT_COMMAND_BUTTON_CLICKED
3321 // in wxPGProperty::OnEvent().
3322 adapter
->ShowDialog( this, selected
);
3327 if ( !buttonWasHandled
)
3329 if ( wnd
|| m_wndEditor2
)
3331 // First call editor class' event handler.
3332 const wxPGEditor
* editor
= selected
->GetEditorClass();
3334 if ( editor
->OnEvent( this, selected
, editorWnd
, event
) )
3336 // If changes, validate them
3337 if ( DoEditorValidate() )
3339 if ( editor
->GetValueFromControl( pendingValue
,
3342 valueIsPending
= true;
3346 validationFailure
= true;
3351 // Then the property's custom handler (must be always called, unless
3352 // validation failed).
3353 if ( !validationFailure
)
3354 buttonWasHandled
= selected
->OnEvent( this, editorWnd
, event
);
3357 // SetValueInEvent(), as called in one of the functions referred above
3358 // overrides editor's value.
3359 if ( m_iFlags
& wxPG_FL_VALUE_CHANGE_IN_EVENT
)
3361 valueIsPending
= true;
3362 pendingValue
= m_changeInEventValue
;
3363 selFlags
|= wxPG_SEL_DIALOGVAL
;
3366 if ( !validationFailure
&& valueIsPending
)
3367 if ( !PerformValidation(selected
, pendingValue
) )
3368 validationFailure
= true;
3370 if ( validationFailure
)
3372 OnValidationFailure(selected
, pendingValue
);
3374 else if ( valueIsPending
)
3376 selFlags
|= ( !wasUnspecified
&& selected
->IsValueUnspecified() && usesAutoUnspecified
) ? wxPG_SEL_SETUNSPEC
: 0;
3378 DoPropertyChanged(selected
, selFlags
);
3379 EditorsValueWasNotModified();
3381 // Regardless of editor type, unfocus editor on
3382 // text-editing related enter press.
3383 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_ENTER
)
3390 // No value after all
3392 // Regardless of editor type, unfocus editor on
3393 // text-editing related enter press.
3394 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_ENTER
)
3399 // Let unhandled button click events go to the parent
3400 if ( !buttonWasHandled
&& event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
3402 wxCommandEvent
evt(wxEVT_COMMAND_BUTTON_CLICKED
,GetId());
3403 GetEventHandler()->AddPendingEvent(evt
);
3407 ClearInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
);
3410 // -----------------------------------------------------------------------
3411 // wxPropertyGrid editor control helper methods
3412 // -----------------------------------------------------------------------
3414 wxRect
wxPropertyGrid::GetEditorWidgetRect( wxPGProperty
* p
, int column
) const
3416 int itemy
= p
->GetY2(m_lineHeight
);
3417 int splitterX
= m_pState
->DoGetSplitterPosition(column
-1);
3418 int colEnd
= splitterX
+ m_pState
->m_colWidths
[column
];
3419 int imageOffset
= 0;
3421 int vx
, vy
; // Top left corner of client
3422 GetViewStart(&vx
, &vy
);
3423 vy
*= wxPG_PIXELS_PER_UNIT
;
3425 // TODO: If custom image detection changes from current, change this.
3426 if ( m_iFlags
& wxPG_FL_CUR_USES_CUSTOM_IMAGE
)
3428 //m_iFlags |= wxPG_FL_CUR_USES_CUSTOM_IMAGE;
3429 int iw
= p
->OnMeasureImage().x
;
3431 iw
= wxPG_CUSTOM_IMAGE_WIDTH
;
3432 imageOffset
= p
->GetImageOffset(iw
);
3437 splitterX
+imageOffset
+wxPG_XBEFOREWIDGET
+wxPG_CONTROL_MARGIN
+1,
3439 colEnd
-splitterX
-wxPG_XBEFOREWIDGET
-wxPG_CONTROL_MARGIN
-imageOffset
-1,
3444 // -----------------------------------------------------------------------
3446 wxRect
wxPropertyGrid::GetImageRect( wxPGProperty
* p
, int item
) const
3448 wxSize sz
= GetImageSize(p
, item
);
3449 return wxRect(wxPG_CONTROL_MARGIN
+ wxCC_CUSTOM_IMAGE_MARGIN1
,
3450 wxPG_CUSTOM_IMAGE_SPACINGY
,
3455 // return size of custom paint image
3456 wxSize
wxPropertyGrid::GetImageSize( wxPGProperty
* p
, int item
) const
3458 // If called with NULL property, then return default image
3459 // size for properties that use image.
3461 return wxSize(wxPG_CUSTOM_IMAGE_WIDTH
,wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight
));
3463 wxSize cis
= p
->OnMeasureImage(item
);
3465 int choiceCount
= p
->m_choices
.GetCount();
3466 int comVals
= p
->GetDisplayedCommonValueCount();
3467 if ( item
>= choiceCount
&& comVals
> 0 )
3469 unsigned int cvi
= item
-choiceCount
;
3470 cis
= GetCommonValue(cvi
)->GetRenderer()->GetImageSize(NULL
, 1, cvi
);
3472 else if ( item
>= 0 && choiceCount
== 0 )
3473 return wxSize(0, 0);
3478 cis
.x
= wxPG_CUSTOM_IMAGE_WIDTH
;
3483 cis
.y
= wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight
);
3490 // -----------------------------------------------------------------------
3492 // takes scrolling into account
3493 void wxPropertyGrid::ImprovedClientToScreen( int* px
, int* py
)
3496 GetViewStart(&vx
,&vy
);
3497 vy
*=wxPG_PIXELS_PER_UNIT
;
3498 vx
*=wxPG_PIXELS_PER_UNIT
;
3501 ClientToScreen( px
, py
);
3504 // -----------------------------------------------------------------------
3506 wxPropertyGridHitTestResult
wxPropertyGrid::HitTest( const wxPoint
& pt
) const
3509 GetViewStart(&pt2
.x
,&pt2
.y
);
3510 pt2
.x
*= wxPG_PIXELS_PER_UNIT
;
3511 pt2
.y
*= wxPG_PIXELS_PER_UNIT
;
3515 return m_pState
->HitTest(pt2
);
3518 // -----------------------------------------------------------------------
3520 // custom set cursor
3521 void wxPropertyGrid::CustomSetCursor( int type
, bool override
)
3523 if ( type
== m_curcursor
&& !override
) return;
3525 wxCursor
* cursor
= &wxPG_DEFAULT_CURSOR
;
3527 if ( type
== wxCURSOR_SIZEWE
)
3528 cursor
= m_cursorSizeWE
;
3530 SetCursor( *cursor
);
3535 // -----------------------------------------------------------------------
3536 // wxPropertyGrid property selection, editor creation
3537 // -----------------------------------------------------------------------
3540 // This class forwards events from property editor controls to wxPropertyGrid.
3541 class wxPropertyGridEditorEventForwarder
: public wxEvtHandler
3544 wxPropertyGridEditorEventForwarder( wxPropertyGrid
* propGrid
)
3545 : wxEvtHandler(), m_propGrid(propGrid
)
3549 virtual ~wxPropertyGridEditorEventForwarder()
3554 bool ProcessEvent( wxEvent
& event
)
3559 m_propGrid
->HandleCustomEditorEvent(event
);
3561 return wxEvtHandler::ProcessEvent(event
);
3564 wxPropertyGrid
* m_propGrid
;
3567 // Setups event handling for child control
3568 void wxPropertyGrid::SetupChildEventHandling( wxWindow
* argWnd
)
3570 wxWindowID id
= argWnd
->GetId();
3572 if ( argWnd
== m_wndEditor
)
3574 argWnd
->Connect(id
, wxEVT_MOTION
,
3575 wxMouseEventHandler(wxPropertyGrid::OnMouseMoveChild
),
3577 argWnd
->Connect(id
, wxEVT_LEFT_UP
,
3578 wxMouseEventHandler(wxPropertyGrid::OnMouseUpChild
),
3580 argWnd
->Connect(id
, wxEVT_LEFT_DOWN
,
3581 wxMouseEventHandler(wxPropertyGrid::OnMouseClickChild
),
3583 argWnd
->Connect(id
, wxEVT_RIGHT_UP
,
3584 wxMouseEventHandler(wxPropertyGrid::OnMouseRightClickChild
),
3586 argWnd
->Connect(id
, wxEVT_ENTER_WINDOW
,
3587 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry
),
3589 argWnd
->Connect(id
, wxEVT_LEAVE_WINDOW
,
3590 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry
),
3594 wxPropertyGridEditorEventForwarder
* forwarder
;
3595 forwarder
= new wxPropertyGridEditorEventForwarder(this);
3596 argWnd
->PushEventHandler(forwarder
);
3598 argWnd
->Connect(id
, wxEVT_KEY_DOWN
,
3599 wxCharEventHandler(wxPropertyGrid::OnChildKeyDown
),
3603 void wxPropertyGrid::DestroyEditorWnd( wxWindow
* wnd
)
3610 // Do not free editors immediately (for sake of processing events)
3611 wxPendingDelete
.Append(wnd
);
3614 void wxPropertyGrid::FreeEditors()
3617 // Return focus back to canvas from children (this is required at least for
3618 // GTK+, which, unlike Windows, clears focus when control is destroyed
3619 // instead of moving it to closest parent).
3620 wxWindow
* focus
= wxWindow::FindFocus();
3623 wxWindow
* parent
= focus
->GetParent();
3626 if ( parent
== this )
3631 parent
= parent
->GetParent();
3635 // Do not free editors immediately if processing events
3638 wxEvtHandler
* handler
= m_wndEditor2
->PopEventHandler(false);
3639 m_wndEditor2
->Hide();
3640 wxPendingDelete
.Append( handler
);
3641 DestroyEditorWnd(m_wndEditor2
);
3642 m_wndEditor2
= NULL
;
3647 wxEvtHandler
* handler
= m_wndEditor
->PopEventHandler(false);
3648 m_wndEditor
->Hide();
3649 wxPendingDelete
.Append( handler
);
3650 DestroyEditorWnd(m_wndEditor
);
3655 // Call with NULL to de-select property
3656 bool wxPropertyGrid::DoSelectProperty( wxPGProperty
* p
, unsigned int flags
)
3661 wxLogDebug(wxT("SelectProperty( %s (%s[%i]) )"),p->m_label.c_str(),
3662 p->m_parent->m_label.c_str(),p->GetIndexInParent());
3666 wxLogDebug(wxT("SelectProperty( NULL, -1 )"));
3670 if ( m_inDoSelectProperty
)
3673 m_inDoSelectProperty
= 1;
3677 m_inDoSelectProperty
= 0;
3681 wxArrayPGProperty prevSelection
= m_pState
->m_selection
;
3682 wxPGProperty
* prevFirstSel
;
3684 if ( prevSelection
.size() > 0 )
3685 prevFirstSel
= prevSelection
[0];
3687 prevFirstSel
= NULL
;
3689 if ( prevFirstSel
&& prevFirstSel
->HasFlag(wxPG_PROP_BEING_DELETED
) )
3690 prevFirstSel
= NULL
;
3692 // Always send event, as this is indirect call
3693 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
);
3697 wxPrintf( "Selected %s\n", prevFirstSel->GetClassInfo()->GetClassName() );
3699 wxPrintf( "None selected\n" );
3702 wxPrintf( "P = %s\n", p->GetClassInfo()->GetClassName() );
3704 wxPrintf( "P = NULL\n" );
3707 // If we are frozen, then just set the values.
3710 m_iFlags
&= ~(wxPG_FL_ABNORMAL_EDITOR
);
3711 m_editorFocused
= 0;
3712 m_pState
->DoSetSelection(p
);
3714 // If frozen, always free controls. But don't worry, as Thaw will
3715 // recall SelectProperty to recreate them.
3718 // Prevent any further selection measures in this call
3724 if ( prevFirstSel
== p
&&
3725 prevSelection
.size() <= 1 &&
3726 !(flags
& wxPG_SEL_FORCE
) )
3728 // Only set focus if not deselecting
3731 if ( flags
& wxPG_SEL_FOCUS
)
3735 m_wndEditor
->SetFocus();
3736 m_editorFocused
= 1;
3745 m_inDoSelectProperty
= 0;
3750 // First, deactivate previous
3753 OnValidationFailureReset(prevFirstSel
);
3755 // Must double-check if this is an selected in case of forceswitch
3756 if ( p
!= prevFirstSel
)
3758 if ( !CommitChangesFromEditor(flags
) )
3760 // Validation has failed, so we can't exit the previous editor
3761 //::wxMessageBox(_("Please correct the value or press ESC to cancel the edit."),
3762 // _("Invalid Value"),wxOK|wxICON_ERROR);
3763 m_inDoSelectProperty
= 0;
3770 m_iFlags
&= ~(wxPG_FL_ABNORMAL_EDITOR
);
3771 EditorsValueWasNotModified();
3774 SetInternalFlag(wxPG_FL_IN_SELECT_PROPERTY
);
3776 m_pState
->DoSetSelection(p
);
3778 // Redraw unselected
3779 for ( unsigned int i
=0; i
<prevSelection
.size(); i
++ )
3781 DrawItem(prevSelection
[i
]);
3785 // Then, activate the one given.
3788 int propY
= p
->GetY2(m_lineHeight
);
3790 int splitterX
= GetSplitterPosition();
3791 m_editorFocused
= 0;
3792 m_iFlags
|= wxPG_FL_PRIMARY_FILLS_ENTIRE
;
3793 if ( p
!= prevFirstSel
)
3794 m_iFlags
&= ~(wxPG_FL_VALIDATION_FAILED
);
3796 wxASSERT( m_wndEditor
== NULL
);
3799 // Only create editor for non-disabled non-caption
3800 if ( !p
->IsCategory() && !(p
->m_flags
& wxPG_PROP_DISABLED
) )
3802 // do this for non-caption items
3806 // Do we need to paint the custom image, if any?
3807 m_iFlags
&= ~(wxPG_FL_CUR_USES_CUSTOM_IMAGE
);
3808 if ( (p
->m_flags
& wxPG_PROP_CUSTOMIMAGE
) &&
3809 !p
->GetEditorClass()->CanContainCustomImage()
3811 m_iFlags
|= wxPG_FL_CUR_USES_CUSTOM_IMAGE
;
3813 wxRect grect
= GetEditorWidgetRect(p
, m_selColumn
);
3814 wxPoint goodPos
= grect
.GetPosition();
3816 const wxPGEditor
* editor
= p
->GetEditorClass();
3817 wxCHECK_MSG(editor
, false,
3818 wxT("NULL editor class not allowed"));
3820 m_iFlags
&= ~wxPG_FL_FIXED_WIDTH_EDITOR
;
3822 wxPGWindowList wndList
=
3823 editor
->CreateControls(this,
3828 m_wndEditor
= wndList
.m_primary
;
3829 m_wndEditor2
= wndList
.m_secondary
;
3830 wxWindow
* primaryCtrl
= GetEditorControl();
3833 // Essentially, primaryCtrl == m_wndEditor
3836 // NOTE: It is allowed for m_wndEditor to be NULL - in this
3837 // case value is drawn as normal, and m_wndEditor2 is
3838 // assumed to be a right-aligned button that triggers
3839 // a separate editorCtrl window.
3843 wxASSERT_MSG( m_wndEditor
->GetParent() == GetPanel(),
3844 "CreateControls must use result of "
3845 "wxPropertyGrid::GetPanel() as parent "
3848 // Set validator, if any
3849 #if wxUSE_VALIDATORS
3850 wxValidator
* validator
= p
->GetValidator();
3852 primaryCtrl
->SetValidator(*validator
);
3855 if ( m_wndEditor
->GetSize().y
> (m_lineHeight
+6) )
3856 m_iFlags
|= wxPG_FL_ABNORMAL_EDITOR
;
3858 // If it has modified status, use bold font
3859 // (must be done before capturing m_ctrlXAdjust)
3860 if ( (p
->m_flags
& wxPG_PROP_MODIFIED
) &&
3861 (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3862 SetCurControlBoldFont();
3864 // Store x relative to splitter (we'll need it).
3865 m_ctrlXAdjust
= m_wndEditor
->GetPosition().x
- splitterX
;
3867 // Check if background clear is not necessary
3868 wxPoint pos
= m_wndEditor
->GetPosition();
3869 if ( pos
.x
> (splitterX
+1) || pos
.y
> propY
)
3871 m_iFlags
&= ~(wxPG_FL_PRIMARY_FILLS_ENTIRE
);
3874 m_wndEditor
->SetSizeHints(3, 3);
3876 SetupChildEventHandling(primaryCtrl
);
3878 // Focus and select all (wxTextCtrl, wxComboBox etc)
3879 if ( flags
& wxPG_SEL_FOCUS
)
3881 primaryCtrl
->SetFocus();
3883 p
->GetEditorClass()->OnFocus(p
, primaryCtrl
);
3889 wxASSERT_MSG( m_wndEditor2
->GetParent() == GetPanel(),
3890 "CreateControls must use result of "
3891 "wxPropertyGrid::GetPanel() as parent "
3894 // Get proper id for wndSecondary
3895 m_wndSecId
= m_wndEditor2
->GetId();
3896 wxWindowList children
= m_wndEditor2
->GetChildren();
3897 wxWindowList::iterator node
= children
.begin();
3898 if ( node
!= children
.end() )
3899 m_wndSecId
= ((wxWindow
*)*node
)->GetId();
3901 m_wndEditor2
->SetSizeHints(3,3);
3903 m_wndEditor2
->Show();
3905 SetupChildEventHandling(m_wndEditor2
);
3907 // If no primary editor, focus to button to allow
3908 // it to interprete ENTER etc.
3909 // NOTE: Due to problems focusing away from it, this
3910 // has been disabled.
3912 if ( (flags & wxPG_SEL_FOCUS) && !m_wndEditor )
3913 m_wndEditor2->SetFocus();
3917 if ( flags
& wxPG_SEL_FOCUS
)
3918 m_editorFocused
= 1;
3923 // Make sure focus is in grid canvas (important for wxGTK,
3928 EditorsValueWasNotModified();
3930 // If it's inside collapsed section, expand parent, scroll, etc.
3931 // Also, if it was partially visible, scroll it into view.
3932 if ( !(flags
& wxPG_SEL_NONVISIBLE
) )
3937 m_wndEditor
->Show(true);
3940 if ( !(flags
& wxPG_SEL_NO_REFRESH
) )
3945 // Make sure focus is in grid canvas
3949 ClearInternalFlag(wxPG_FL_IN_SELECT_PROPERTY
);
3955 // Show help text in status bar.
3956 // (if found and grid not embedded in manager with help box and
3957 // style wxPG_EX_HELP_AS_TOOLTIPS is not used).
3960 if ( !(GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS
) )
3962 wxStatusBar
* statusbar
= NULL
;
3963 if ( !(m_iFlags
& wxPG_FL_NOSTATUSBARHELP
) )
3965 wxFrame
* frame
= wxDynamicCast(::wxGetTopLevelParent(this),wxFrame
);
3967 statusbar
= frame
->GetStatusBar();
3972 const wxString
* pHelpString
= (const wxString
*) NULL
;
3976 pHelpString
= &p
->GetHelpString();
3977 if ( pHelpString
->length() )
3979 // Set help box text.
3980 statusbar
->SetStatusText( *pHelpString
);
3981 m_iFlags
|= wxPG_FL_STRING_IN_STATUSBAR
;
3985 if ( (!pHelpString
|| !pHelpString
->length()) &&
3986 (m_iFlags
& wxPG_FL_STRING_IN_STATUSBAR
) )
3988 // Clear help box - but only if it was written
3989 // by us at previous time.
3990 statusbar
->SetStatusText( m_emptyString
);
3991 m_iFlags
&= ~(wxPG_FL_STRING_IN_STATUSBAR
);
3997 m_inDoSelectProperty
= 0;
3999 // call wx event handler (here so that it also occurs on deselection)
4000 if ( !(flags
& wxPG_SEL_DONT_SEND_EVENT
) )
4001 SendEvent( wxEVT_PG_SELECTED
, p
, NULL
);
4006 // -----------------------------------------------------------------------
4008 bool wxPropertyGrid::UnfocusEditor()
4010 wxPGProperty
* selected
= GetSelection();
4012 if ( !selected
|| !m_wndEditor
|| m_frozen
)
4015 if ( !CommitChangesFromEditor(0) )
4024 // -----------------------------------------------------------------------
4026 void wxPropertyGrid::RefreshEditor()
4028 wxPGProperty
* p
= GetSelection();
4032 wxWindow
* wnd
= GetEditorControl();
4036 // Set editor font boldness - must do this before
4037 // calling UpdateControl().
4038 if ( HasFlag(wxPG_BOLD_MODIFIED
) )
4040 if ( p
->HasFlag(wxPG_PROP_MODIFIED
) )
4041 wnd
->SetFont(GetCaptionFont());
4043 wnd
->SetFont(GetFont());
4046 const wxPGEditor
* editorClass
= p
->GetEditorClass();
4048 editorClass
->UpdateControl(p
, wnd
);
4050 if ( p
->IsValueUnspecified() )
4051 editorClass
->SetValueToUnspecified(p
, wnd
);
4054 // -----------------------------------------------------------------------
4056 bool wxPropertyGrid::SelectProperty( wxPGPropArg id
, bool focus
)
4058 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
4060 int flags
= wxPG_SEL_DONT_SEND_EVENT
;
4062 flags
|= wxPG_SEL_FOCUS
;
4064 return DoSelectProperty(p
, flags
);
4067 // -----------------------------------------------------------------------
4068 // wxPropertyGrid expand/collapse state
4069 // -----------------------------------------------------------------------
4071 bool wxPropertyGrid::DoCollapse( wxPGProperty
* p
, bool sendEvents
)
4073 wxPGProperty
* pwc
= wxStaticCast(p
, wxPGProperty
);
4074 wxPGProperty
* selected
= GetSelection();
4076 // If active editor was inside collapsed section, then disable it
4077 if ( selected
&& selected
->IsSomeParent(p
) )
4082 // Store dont-center-splitter flag 'cause we need to temporarily set it
4083 wxUint32 old_flag
= m_iFlags
& wxPG_FL_DONT_CENTER_SPLITTER
;
4084 m_iFlags
|= wxPG_FL_DONT_CENTER_SPLITTER
;
4086 bool res
= m_pState
->DoCollapse(pwc
);
4091 SendEvent( wxEVT_PG_ITEM_COLLAPSED
, p
);
4093 RecalculateVirtualSize();
4095 // Redraw etc. only if collapsed was visible.
4096 if (pwc
->IsVisible() &&
4098 ( !pwc
->IsCategory() || !(m_windowStyle
& wxPG_HIDE_CATEGORIES
) ) )
4100 // When item is collapsed so that scrollbar would move,
4101 // graphics mess is about (unless we redraw everything).
4106 // Clear dont-center-splitter flag if it wasn't set
4107 m_iFlags
= (m_iFlags
& ~wxPG_FL_DONT_CENTER_SPLITTER
) | old_flag
;
4112 // -----------------------------------------------------------------------
4114 bool wxPropertyGrid::DoExpand( wxPGProperty
* p
, bool sendEvents
)
4116 wxCHECK_MSG( p
, false, wxT("invalid property id") );
4118 wxPGProperty
* pwc
= (wxPGProperty
*)p
;
4120 // Store dont-center-splitter flag 'cause we need to temporarily set it
4121 wxUint32 old_flag
= m_iFlags
& wxPG_FL_DONT_CENTER_SPLITTER
;
4122 m_iFlags
|= wxPG_FL_DONT_CENTER_SPLITTER
;
4124 bool res
= m_pState
->DoExpand(pwc
);
4129 SendEvent( wxEVT_PG_ITEM_EXPANDED
, p
);
4131 RecalculateVirtualSize();
4133 // Redraw etc. only if expanded was visible.
4134 if ( pwc
->IsVisible() && !m_frozen
&&
4135 ( !pwc
->IsCategory() || !(m_windowStyle
& wxPG_HIDE_CATEGORIES
) )
4139 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4142 DrawItems(pwc
, NULL
);
4147 // Clear dont-center-splitter flag if it wasn't set
4148 m_iFlags
= (m_iFlags
& ~wxPG_FL_DONT_CENTER_SPLITTER
) | old_flag
;
4153 // -----------------------------------------------------------------------
4155 bool wxPropertyGrid::DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
)
4158 return m_pState
->DoHideProperty(p
, hide
, flags
);
4160 wxArrayPGProperty selection
= m_pState
->m_selection
; // Must use a copy
4161 int selRemoveCount
= 0;
4162 for ( unsigned int i
=0; i
<selection
.size(); i
++ )
4164 wxPGProperty
* selected
= selection
[i
];
4165 if ( selected
== p
|| selected
->IsSomeParent(p
) )
4167 if ( !DoRemoveFromSelection(p
, flags
) )
4169 selRemoveCount
+= 1;
4173 m_pState
->DoHideProperty(p
, hide
, flags
);
4175 RecalculateVirtualSize();
4182 // -----------------------------------------------------------------------
4183 // wxPropertyGrid size related methods
4184 // -----------------------------------------------------------------------
4186 void wxPropertyGrid::RecalculateVirtualSize( int forceXPos
)
4188 if ( (m_iFlags
& wxPG_FL_RECALCULATING_VIRTUAL_SIZE
) || m_frozen
)
4192 // If virtual height was changed, then recalculate editor control position(s)
4193 if ( m_pState
->m_vhCalcPending
)
4194 CorrectEditorWidgetPosY();
4196 m_pState
->EnsureVirtualHeight();
4198 wxASSERT_LEVEL_2_MSG(
4199 m_pState
->GetVirtualHeight() == m_pState
->GetActualVirtualHeight(),
4200 "VirtualHeight and ActualVirtualHeight should match"
4203 m_iFlags
|= wxPG_FL_RECALCULATING_VIRTUAL_SIZE
;
4205 int x
= m_pState
->m_width
;
4206 int y
= m_pState
->m_virtualHeight
;
4209 GetClientSize(&width
,&height
);
4211 // Now adjust virtual size.
4212 SetVirtualSize(x
, y
);
4218 // Adjust scrollbars
4219 if ( HasVirtualWidth() )
4221 xAmount
= x
/wxPG_PIXELS_PER_UNIT
;
4222 xPos
= GetScrollPos( wxHORIZONTAL
);
4225 if ( forceXPos
!= -1 )
4228 else if ( xPos
> (xAmount
-(width
/wxPG_PIXELS_PER_UNIT
)) )
4231 int yAmount
= y
/ wxPG_PIXELS_PER_UNIT
;
4232 int yPos
= GetScrollPos( wxVERTICAL
);
4234 SetScrollbars( wxPG_PIXELS_PER_UNIT
, wxPG_PIXELS_PER_UNIT
,
4235 xAmount
, yAmount
, xPos
, yPos
, true );
4237 // Must re-get size now
4238 GetClientSize(&width
,&height
);
4240 if ( !HasVirtualWidth() )
4242 m_pState
->SetVirtualWidth(width
);
4249 m_pState
->CheckColumnWidths();
4251 if ( GetSelection() )
4252 CorrectEditorWidgetSizeX();
4254 m_iFlags
&= ~wxPG_FL_RECALCULATING_VIRTUAL_SIZE
;
4257 // -----------------------------------------------------------------------
4259 void wxPropertyGrid::OnResize( wxSizeEvent
& event
)
4261 if ( !(m_iFlags
& wxPG_FL_INITIALIZED
) )
4265 GetClientSize(&width
, &height
);
4270 #if wxPG_DOUBLE_BUFFER
4271 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING
) )
4273 int dblh
= (m_lineHeight
*2);
4274 if ( !m_doubleBuffer
)
4276 // Create double buffer bitmap to draw on, if none
4277 int w
= (width
>250)?width
:250;
4278 int h
= height
+ dblh
;
4280 m_doubleBuffer
= new wxBitmap( w
, h
);
4284 int w
= m_doubleBuffer
->GetWidth();
4285 int h
= m_doubleBuffer
->GetHeight();
4287 // Double buffer must be large enough
4288 if ( w
< width
|| h
< (height
+dblh
) )
4290 if ( w
< width
) w
= width
;
4291 if ( h
< (height
+dblh
) ) h
= height
+ dblh
;
4292 delete m_doubleBuffer
;
4293 m_doubleBuffer
= new wxBitmap( w
, h
);
4300 m_pState
->OnClientWidthChange( width
, event
.GetSize().x
- m_ncWidth
, true );
4301 m_ncWidth
= event
.GetSize().x
;
4305 if ( m_pState
->m_itemsAdded
)
4306 PrepareAfterItemsAdded();
4308 // Without this, virtual size (atleast under wxGTK) will be skewed
4309 RecalculateVirtualSize();
4315 // -----------------------------------------------------------------------
4317 void wxPropertyGrid::SetVirtualWidth( int width
)
4321 // Disable virtual width
4322 width
= GetClientSize().x
;
4323 ClearInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH
);
4327 // Enable virtual width
4328 SetInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH
);
4330 m_pState
->SetVirtualWidth( width
);
4333 void wxPropertyGrid::SetFocusOnCanvas()
4335 SetFocusIgnoringChildren();
4336 m_editorFocused
= 0;
4339 // -----------------------------------------------------------------------
4340 // wxPropertyGrid mouse event handling
4341 // -----------------------------------------------------------------------
4343 // selFlags uses same values DoSelectProperty's flags
4344 // Returns true if event was vetoed.
4345 bool wxPropertyGrid::SendEvent( int eventType
, wxPGProperty
* p
,
4347 unsigned int selFlags
,
4348 unsigned int column
)
4350 // Send property grid event of specific type and with specific property
4351 wxPropertyGridEvent
evt( eventType
, m_eventObject
->GetId() );
4352 evt
.SetPropertyGrid(this);
4353 evt
.SetEventObject(m_eventObject
);
4355 evt
.SetColumn(column
);
4356 if ( eventType
== wxEVT_PG_CHANGING
)
4359 evt
.SetCanVeto(true);
4360 m_validationInfo
.m_pValue
= pValue
;
4361 evt
.SetupValidationInfo();
4366 evt
.SetPropertyValue(p
->GetValue());
4368 if ( !(selFlags
& wxPG_SEL_NOVALIDATE
) )
4369 evt
.SetCanVeto(true);
4372 m_processedEvent
= &evt
;
4373 m_eventObject
->HandleWindowEvent(evt
);
4374 m_processedEvent
= NULL
;
4376 return evt
.WasVetoed();
4379 // -----------------------------------------------------------------------
4381 // Return false if should be skipped
4382 bool wxPropertyGrid::HandleMouseClick( int x
, unsigned int y
, wxMouseEvent
&event
)
4386 // Need to set focus?
4387 if ( !(m_iFlags
& wxPG_FL_FOCUSED
) )
4392 wxPropertyGridPageState
* state
= m_pState
;
4394 int splitterHitOffset
;
4395 int columnHit
= state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4397 wxPGProperty
* p
= DoGetItemAtY(y
);
4401 int depth
= (int)p
->GetDepth() - 1;
4403 int marginEnds
= m_marginWidth
+ ( depth
* m_subgroup_extramargin
);
4405 if ( x
>= marginEnds
)
4409 if ( p
->IsCategory() )
4411 // This is category.
4412 wxPropertyCategory
* pwc
= (wxPropertyCategory
*)p
;
4414 int textX
= m_marginWidth
+ ((unsigned int)((pwc
->m_depth
-1)*m_subgroup_extramargin
));
4416 // Expand, collapse, activate etc. if click on text or left of splitter.
4419 ( x
< (textX
+pwc
->GetTextExtent(this, m_captionFont
)+(wxPG_CAPRECTXMARGIN
*2)) ||
4424 if ( !AddToSelectionFromInputEvent( p
,
4429 // On double-click, expand/collapse.
4430 if ( event
.ButtonDClick() && !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
4432 if ( pwc
->IsExpanded() ) DoCollapse( p
, true );
4433 else DoExpand( p
, true );
4437 else if ( splitterHit
== -1 )
4440 unsigned int selFlag
= 0;
4441 if ( columnHit
== 1 )
4443 m_iFlags
|= wxPG_FL_ACTIVATION_BY_CLICK
;
4444 selFlag
= wxPG_SEL_FOCUS
;
4446 if ( !AddToSelectionFromInputEvent( p
,
4452 m_iFlags
&= ~(wxPG_FL_ACTIVATION_BY_CLICK
);
4454 if ( p
->GetChildCount() && !p
->IsCategory() )
4455 // On double-click, expand/collapse.
4456 if ( event
.ButtonDClick() && !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
4458 wxPGProperty
* pwc
= (wxPGProperty
*)p
;
4459 if ( pwc
->IsExpanded() ) DoCollapse( p
, true );
4460 else DoExpand( p
, true );
4467 // click on splitter
4468 if ( !(m_windowStyle
& wxPG_STATIC_SPLITTER
) )
4470 if ( event
.GetEventType() == wxEVT_LEFT_DCLICK
)
4472 // Double-clicking the splitter causes auto-centering
4473 CenterSplitter( true );
4475 else if ( m_dragStatus
== 0 )
4478 // Begin draggin the splitter
4482 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
);
4486 // Changes must be committed here or the
4487 // value won't be drawn correctly
4488 if ( !CommitChangesFromEditor() )
4491 m_wndEditor
->Show ( false );
4494 if ( !(m_iFlags
& wxPG_FL_MOUSE_CAPTURED
) )
4497 m_iFlags
|= wxPG_FL_MOUSE_CAPTURED
;
4501 m_draggedSplitter
= splitterHit
;
4502 m_dragOffset
= splitterHitOffset
;
4504 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4505 // Fixes button disappearance bug
4507 m_wndEditor2
->Show ( false );
4510 m_startingSplitterX
= x
- splitterHitOffset
;
4518 if ( p
->GetChildCount() )
4520 int nx
= x
+ m_marginWidth
- marginEnds
; // Normalize x.
4522 if ( (nx
>= m_gutterWidth
&& nx
< (m_gutterWidth
+m_iconWidth
)) )
4524 int y2
= y
% m_lineHeight
;
4525 if ( (y2
>= m_buttonSpacingY
&& y2
< (m_buttonSpacingY
+m_iconHeight
)) )
4527 // On click on expander button, expand/collapse
4528 if ( ((wxPGProperty
*)p
)->IsExpanded() )
4529 DoCollapse( p
, true );
4531 DoExpand( p
, true );
4540 // -----------------------------------------------------------------------
4542 bool wxPropertyGrid::HandleMouseRightClick( int WXUNUSED(x
),
4543 unsigned int WXUNUSED(y
),
4544 wxMouseEvent
& event
)
4548 // Select property here as well
4549 wxPGProperty
* p
= m_propHover
;
4550 AddToSelectionFromInputEvent(p
, m_colHover
, &event
);
4552 // Send right click event.
4553 SendEvent( wxEVT_PG_RIGHT_CLICK
, p
);
4560 // -----------------------------------------------------------------------
4562 bool wxPropertyGrid::HandleMouseDoubleClick( int WXUNUSED(x
),
4563 unsigned int WXUNUSED(y
),
4564 wxMouseEvent
& event
)
4568 // Select property here as well
4569 wxPGProperty
* p
= m_propHover
;
4571 AddToSelectionFromInputEvent(p
, m_colHover
, &event
);
4573 // Send double-click event.
4574 SendEvent( wxEVT_PG_DOUBLE_CLICK
, m_propHover
);
4581 // -----------------------------------------------------------------------
4583 #if wxPG_SUPPORT_TOOLTIPS
4585 void wxPropertyGrid::SetToolTip( const wxString
& tipString
)
4587 if ( tipString
.length() )
4589 wxScrolledWindow::SetToolTip(tipString
);
4593 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4594 wxScrolledWindow::SetToolTip( m_emptyString
);
4596 wxScrolledWindow::SetToolTip( NULL
);
4601 #endif // #if wxPG_SUPPORT_TOOLTIPS
4603 // -----------------------------------------------------------------------
4605 // Return false if should be skipped
4606 bool wxPropertyGrid::HandleMouseMove( int x
, unsigned int y
,
4607 wxMouseEvent
&event
)
4609 // Safety check (needed because mouse capturing may
4610 // otherwise freeze the control)
4611 if ( m_dragStatus
> 0 && !event
.Dragging() )
4613 HandleMouseUp(x
, y
, event
);
4616 wxPropertyGridPageState
* state
= m_pState
;
4618 int splitterHitOffset
;
4619 int columnHit
= state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4620 int splitterX
= x
- splitterHitOffset
;
4622 m_colHover
= columnHit
;
4624 if ( m_dragStatus
> 0 )
4626 if ( x
> (m_marginWidth
+ wxPG_DRAG_MARGIN
) &&
4627 x
< (m_pState
->m_width
- wxPG_DRAG_MARGIN
) )
4630 int newSplitterX
= x
- m_dragOffset
;
4631 int splitterX
= x
- splitterHitOffset
;
4633 // Splitter redraw required?
4634 if ( newSplitterX
!= splitterX
)
4637 SetInternalFlag(wxPG_FL_DONT_CENTER_SPLITTER
);
4638 state
->DoSetSplitterPosition(newSplitterX
,
4641 state
->m_fSplitterX
= (float) newSplitterX
;
4643 if ( GetSelection() )
4644 CorrectEditorWidgetSizeX();
4658 int ih
= m_lineHeight
;
4661 #if wxPG_SUPPORT_TOOLTIPS
4662 wxPGProperty
* prevHover
= m_propHover
;
4663 unsigned char prevSide
= m_mouseSide
;
4665 int curPropHoverY
= y
- (y
% ih
);
4667 // On which item it hovers
4670 ( sy
< m_propHoverY
|| sy
>= (m_propHoverY
+ih
) )
4673 // Mouse moves on another property
4675 m_propHover
= DoGetItemAtY(y
);
4676 m_propHoverY
= curPropHoverY
;
4679 SendEvent( wxEVT_PG_HIGHLIGHTED
, m_propHover
);
4682 #if wxPG_SUPPORT_TOOLTIPS
4683 // Store which side we are on
4685 if ( columnHit
== 1 )
4687 else if ( columnHit
== 0 )
4691 // If tooltips are enabled, show label or value as a tip
4692 // in case it doesn't otherwise show in full length.
4694 if ( m_windowStyle
& wxPG_TOOLTIPS
)
4696 wxToolTip
* tooltip
= GetToolTip();
4698 if ( m_propHover
!= prevHover
|| prevSide
!= m_mouseSide
)
4700 if ( m_propHover
&& !m_propHover
->IsCategory() )
4703 if ( GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS
)
4705 // Show help string as a tooltip
4706 wxString tipString
= m_propHover
->GetHelpString();
4708 SetToolTip(tipString
);
4712 // Show cropped value string as a tooltip
4716 if ( m_mouseSide
== 1 )
4718 tipString
= m_propHover
->m_label
;
4719 space
= splitterX
-m_marginWidth
-3;
4721 else if ( m_mouseSide
== 2 )
4723 tipString
= m_propHover
->GetDisplayedString();
4725 space
= m_width
- splitterX
;
4726 if ( m_propHover
->m_flags
& wxPG_PROP_CUSTOMIMAGE
)
4727 space
-= wxPG_CUSTOM_IMAGE_WIDTH
+
4728 wxCC_CUSTOM_IMAGE_MARGIN1
+
4729 wxCC_CUSTOM_IMAGE_MARGIN2
;
4735 GetTextExtent( tipString
, &tw
, &th
, 0, 0 );
4738 SetToolTip( tipString
);
4745 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4746 SetToolTip( m_emptyString
);
4748 wxScrolledWindow::SetToolTip( NULL
);
4759 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4760 SetToolTip( m_emptyString
);
4762 wxScrolledWindow::SetToolTip( NULL
);
4770 if ( splitterHit
== -1 ||
4772 HasFlag(wxPG_STATIC_SPLITTER
) )
4774 // hovering on something else
4775 if ( m_curcursor
!= wxCURSOR_ARROW
)
4776 CustomSetCursor( wxCURSOR_ARROW
);
4780 // Do not allow splitter cursor on caption items.
4781 // (also not if we were dragging and its started
4782 // outside the splitter region)
4784 if ( !m_propHover
->IsCategory() &&
4788 // hovering on splitter
4790 // NB: Condition disabled since MouseLeave event (from the
4791 // editor control) cannot be reliably detected.
4792 //if ( m_curcursor != wxCURSOR_SIZEWE )
4793 CustomSetCursor( wxCURSOR_SIZEWE
, true );
4799 // hovering on something else
4800 if ( m_curcursor
!= wxCURSOR_ARROW
)
4801 CustomSetCursor( wxCURSOR_ARROW
);
4806 // Multi select by dragging
4808 if ( (GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
) &&
4809 event
.LeftIsDown() &&
4813 !state
->DoIsPropertySelected(m_propHover
) )
4815 // Additional requirement is that the hovered property
4816 // is adjacent to edges of selection.
4817 const wxArrayPGProperty
& selection
= GetSelectedProperties();
4819 // Since categories cannot be selected along with 'other'
4820 // properties, exclude them from iterator flags.
4821 int iterFlags
= wxPG_ITERATE_VISIBLE
& (~wxPG_PROP_CATEGORY
);
4823 for ( int i
=(selection
.size()-1); i
>=0; i
-- )
4825 // TODO: This could be optimized by keeping track of
4826 // which properties are at the edges of selection.
4827 wxPGProperty
* selProp
= selection
[i
];
4828 if ( state
->ArePropertiesAdjacent(m_propHover
, selProp
,
4831 DoAddToSelection(m_propHover
);
4840 // -----------------------------------------------------------------------
4842 // Also handles Leaving event
4843 bool wxPropertyGrid::HandleMouseUp( int x
, unsigned int WXUNUSED(y
),
4844 wxMouseEvent
&WXUNUSED(event
) )
4846 wxPropertyGridPageState
* state
= m_pState
;
4850 int splitterHitOffset
;
4851 state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4853 // No event type check - basicly calling this method should
4854 // just stop dragging.
4855 // Left up after dragged?
4856 if ( m_dragStatus
>= 1 )
4859 // End Splitter Dragging
4861 // DO NOT ENABLE FOLLOWING LINE!
4862 // (it is only here as a reminder to not to do it)
4865 // Disable splitter auto-centering
4866 m_iFlags
|= wxPG_FL_DONT_CENTER_SPLITTER
;
4868 // This is necessary to return cursor
4869 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
4872 m_iFlags
&= ~(wxPG_FL_MOUSE_CAPTURED
);
4875 // Set back the default cursor, if necessary
4876 if ( splitterHit
== -1 ||
4879 CustomSetCursor( wxCURSOR_ARROW
);
4884 // Control background needs to be cleared
4885 wxPGProperty
* selected
= GetSelection();
4886 if ( !(m_iFlags
& wxPG_FL_PRIMARY_FILLS_ENTIRE
) && selected
)
4887 DrawItem( selected
);
4891 m_wndEditor
->Show ( true );
4894 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4895 // Fixes button disappearance bug
4897 m_wndEditor2
->Show ( true );
4900 // This clears the focus.
4901 m_editorFocused
= 0;
4907 // -----------------------------------------------------------------------
4909 bool wxPropertyGrid::OnMouseCommon( wxMouseEvent
& event
, int* px
, int* py
)
4911 int splitterX
= GetSplitterPosition();
4914 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &ux
, &uy
);
4916 wxWindow
* wnd
= GetEditorControl();
4918 // Hide popup on clicks
4919 if ( event
.GetEventType() != wxEVT_MOTION
)
4920 if ( wnd
&& wnd
->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox
)) )
4922 ((wxOwnerDrawnComboBox
*)wnd
)->HidePopup();
4928 if ( wnd
== NULL
|| m_dragStatus
||
4930 ux
<= (splitterX
+ wxPG_SPLITTERX_DETECTMARGIN2
) ||
4931 ux
>= (r
.x
+r
.width
) ||
4933 event
.m_y
>= (r
.y
+r
.height
)
4943 if ( m_curcursor
!= wxCURSOR_ARROW
) CustomSetCursor ( wxCURSOR_ARROW
);
4948 // -----------------------------------------------------------------------
4950 void wxPropertyGrid::OnMouseClick( wxMouseEvent
&event
)
4953 if ( OnMouseCommon( event
, &x
, &y
) )
4955 HandleMouseClick(x
,y
,event
);
4960 // -----------------------------------------------------------------------
4962 void wxPropertyGrid::OnMouseRightClick( wxMouseEvent
&event
)
4965 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &x
, &y
);
4966 HandleMouseRightClick(x
,y
,event
);
4970 // -----------------------------------------------------------------------
4972 void wxPropertyGrid::OnMouseDoubleClick( wxMouseEvent
&event
)
4974 // Always run standard mouse-down handler as well
4975 OnMouseClick(event
);
4978 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &x
, &y
);
4979 HandleMouseDoubleClick(x
,y
,event
);
4983 // -----------------------------------------------------------------------
4985 void wxPropertyGrid::OnMouseMove( wxMouseEvent
&event
)
4988 if ( OnMouseCommon( event
, &x
, &y
) )
4990 HandleMouseMove(x
,y
,event
);
4995 // -----------------------------------------------------------------------
4997 void wxPropertyGrid::OnMouseUp( wxMouseEvent
&event
)
5000 if ( OnMouseCommon( event
, &x
, &y
) )
5002 HandleMouseUp(x
,y
,event
);
5007 // -----------------------------------------------------------------------
5009 void wxPropertyGrid::OnMouseEntry( wxMouseEvent
&event
)
5011 // This may get called from child control as well, so event's
5012 // mouse position cannot be relied on.
5014 if ( event
.Entering() )
5016 if ( !(m_iFlags
& wxPG_FL_MOUSE_INSIDE
) )
5018 // TODO: Fix this (detect parent and only do
5019 // cursor trick if it is a manager).
5020 wxASSERT( GetParent() );
5021 GetParent()->SetCursor(wxNullCursor
);
5023 m_iFlags
|= wxPG_FL_MOUSE_INSIDE
;
5026 GetParent()->SetCursor(wxNullCursor
);
5028 else if ( event
.Leaving() )
5030 // Without this, wxSpinCtrl editor will sometimes have wrong cursor
5031 SetCursor( wxNullCursor
);
5033 // Get real cursor position
5034 wxPoint pt
= ScreenToClient(::wxGetMousePosition());
5036 if ( ( pt
.x
<= 0 || pt
.y
<= 0 || pt
.x
>= m_width
|| pt
.y
>= m_height
) )
5039 if ( (m_iFlags
& wxPG_FL_MOUSE_INSIDE
) )
5041 m_iFlags
&= ~(wxPG_FL_MOUSE_INSIDE
);
5045 wxPropertyGrid::HandleMouseUp ( -1, 10000, event
);
5053 // -----------------------------------------------------------------------
5055 // Common code used by various OnMouseXXXChild methods.
5056 bool wxPropertyGrid::OnMouseChildCommon( wxMouseEvent
&event
, int* px
, int *py
)
5058 wxWindow
* topCtrlWnd
= (wxWindow
*)event
.GetEventObject();
5059 wxASSERT( topCtrlWnd
);
5061 event
.GetPosition(&x
,&y
);
5063 int splitterX
= GetSplitterPosition();
5065 wxRect r
= topCtrlWnd
->GetRect();
5066 if ( !m_dragStatus
&&
5067 x
> (splitterX
-r
.x
+wxPG_SPLITTERX_DETECTMARGIN2
) &&
5068 y
>= 0 && y
< r
.height \
5071 if ( m_curcursor
!= wxCURSOR_ARROW
) CustomSetCursor ( wxCURSOR_ARROW
);
5076 CalcUnscrolledPosition( event
.m_x
+ r
.x
, event
.m_y
+ r
.y
, \
5083 void wxPropertyGrid::OnMouseClickChild( wxMouseEvent
&event
)
5086 if ( OnMouseChildCommon(event
,&x
,&y
) )
5088 bool res
= HandleMouseClick(x
,y
,event
);
5089 if ( !res
) event
.Skip();
5093 void wxPropertyGrid::OnMouseRightClickChild( wxMouseEvent
&event
)
5096 wxASSERT( m_wndEditor
);
5097 // These coords may not be exact (about +-2),
5098 // but that should not matter (right click is about item, not position).
5099 wxPoint pt
= m_wndEditor
->GetPosition();
5100 CalcUnscrolledPosition( event
.m_x
+ pt
.x
, event
.m_y
+ pt
.y
, &x
, &y
);
5102 // FIXME: Used to set m_propHover to selection here. Was it really
5105 bool res
= HandleMouseRightClick(x
,y
,event
);
5106 if ( !res
) event
.Skip();
5109 void wxPropertyGrid::OnMouseMoveChild( wxMouseEvent
&event
)
5112 if ( OnMouseChildCommon(event
,&x
,&y
) )
5114 bool res
= HandleMouseMove(x
,y
,event
);
5115 if ( !res
) event
.Skip();
5119 void wxPropertyGrid::OnMouseUpChild( wxMouseEvent
&event
)
5122 if ( OnMouseChildCommon(event
,&x
,&y
) )
5124 bool res
= HandleMouseUp(x
,y
,event
);
5125 if ( !res
) event
.Skip();
5129 // -----------------------------------------------------------------------
5130 // wxPropertyGrid keyboard event handling
5131 // -----------------------------------------------------------------------
5133 int wxPropertyGrid::KeyEventToActions(wxKeyEvent
&event
, int* pSecond
) const
5135 // Translates wxKeyEvent to wxPG_ACTION_XXX
5137 int keycode
= event
.GetKeyCode();
5138 int modifiers
= event
.GetModifiers();
5140 wxASSERT( !(modifiers
&~(0xFFFF)) );
5142 int hashMapKey
= (keycode
& 0xFFFF) | ((modifiers
& 0xFFFF) << 16);
5144 wxPGHashMapI2I::const_iterator it
= m_actionTriggers
.find(hashMapKey
);
5146 if ( it
== m_actionTriggers
.end() )
5151 int second
= (it
->second
>>16) & 0xFFFF;
5155 return (it
->second
& 0xFFFF);
5158 void wxPropertyGrid::AddActionTrigger( int action
, int keycode
, int modifiers
)
5160 wxASSERT( !(modifiers
&~(0xFFFF)) );
5162 int hashMapKey
= (keycode
& 0xFFFF) | ((modifiers
& 0xFFFF) << 16);
5164 wxPGHashMapI2I::iterator it
= m_actionTriggers
.find(hashMapKey
);
5166 if ( it
!= m_actionTriggers
.end() )
5168 // This key combination is already used
5170 // Can add secondary?
5171 wxASSERT_MSG( !(it
->second
&~(0xFFFF)),
5172 wxT("You can only add up to two separate actions per key combination.") );
5174 action
= it
->second
| (action
<<16);
5177 m_actionTriggers
[hashMapKey
] = action
;
5180 void wxPropertyGrid::ClearActionTriggers( int action
)
5182 wxPGHashMapI2I::iterator it
;
5187 didSomething
= false;
5189 for ( it
= m_actionTriggers
.begin();
5190 it
!= m_actionTriggers
.end();
5193 if ( it
->second
== action
)
5195 m_actionTriggers
.erase(it
);
5196 didSomething
= true;
5201 while ( didSomething
);
5204 void wxPropertyGrid::HandleKeyEvent( wxKeyEvent
&event
, bool fromChild
)
5207 // Handles key event when editor control is not focused.
5210 wxCHECK2(!m_frozen
, return);
5212 // Travelsal between items, collapsing/expanding, etc.
5213 wxPGProperty
* selected
= GetSelection();
5214 int keycode
= event
.GetKeyCode();
5215 bool editorFocused
= IsEditorFocused();
5217 if ( keycode
== WXK_TAB
)
5219 wxWindow
* mainControl
;
5221 if ( HasInternalFlag(wxPG_FL_IN_MANAGER
) )
5222 mainControl
= GetParent();
5226 if ( !event
.ShiftDown() )
5228 if ( !editorFocused
&& m_wndEditor
)
5230 DoSelectProperty( selected
, wxPG_SEL_FOCUS
);
5234 // Tab traversal workaround for platforms on which
5235 // wxWindow::Navigate() may navigate into first child
5236 // instead of next sibling. Does not work perfectly
5237 // in every scenario (for instance, when property grid
5238 // is either first or last control).
5239 #if defined(__WXGTK__)
5240 wxWindow
* sibling
= mainControl
->GetNextSibling();
5242 sibling
->SetFocusFromKbd();
5244 Navigate(wxNavigationKeyEvent::IsForward
);
5250 if ( editorFocused
)
5256 #if defined(__WXGTK__)
5257 wxWindow
* sibling
= mainControl
->GetPrevSibling();
5259 sibling
->SetFocusFromKbd();
5261 Navigate(wxNavigationKeyEvent::IsBackward
);
5269 // Ignore Alt and Control when they are down alone
5270 if ( keycode
== WXK_ALT
||
5271 keycode
== WXK_CONTROL
)
5278 int action
= KeyEventToActions(event
, &secondAction
);
5280 if ( editorFocused
&& action
== wxPG_ACTION_CANCEL_EDIT
)
5283 // Esc cancels any changes
5284 if ( IsEditorsValueModified() )
5286 EditorsValueWasNotModified();
5288 // Update the control as well
5289 selected
->GetEditorClass()->
5290 SetControlStringValue( selected
,
5292 selected
->GetDisplayedString() );
5295 OnValidationFailureReset(selected
);
5301 // Except for TAB and ESC, handle child control events in child control
5304 // Only propagate event if it had modifiers
5305 if ( !event
.HasModifiers() )
5307 event
.StopPropagation();
5313 bool wasHandled
= false;
5318 if ( ButtonTriggerKeyTest(action
, event
) )
5321 wxPGProperty
* p
= selected
;
5323 // Travel and expand/collapse
5326 if ( p
->GetChildCount() )
5328 if ( action
== wxPG_ACTION_COLLAPSE_PROPERTY
|| secondAction
== wxPG_ACTION_COLLAPSE_PROPERTY
)
5330 if ( (m_windowStyle
& wxPG_HIDE_MARGIN
) || Collapse(p
) )
5333 else if ( action
== wxPG_ACTION_EXPAND_PROPERTY
|| secondAction
== wxPG_ACTION_EXPAND_PROPERTY
)
5335 if ( (m_windowStyle
& wxPG_HIDE_MARGIN
) || Expand(p
) )
5342 if ( action
== wxPG_ACTION_PREV_PROPERTY
|| secondAction
== wxPG_ACTION_PREV_PROPERTY
)
5346 else if ( action
== wxPG_ACTION_NEXT_PROPERTY
|| secondAction
== wxPG_ACTION_NEXT_PROPERTY
)
5352 if ( selectDir
>= -1 )
5354 p
= wxPropertyGridIterator::OneStep( m_pState
, wxPG_ITERATE_VISIBLE
, p
, selectDir
);
5356 DoSelectProperty(p
);
5362 // If nothing was selected, select the first item now
5363 // (or navigate out of tab).
5364 if ( action
!= wxPG_ACTION_CANCEL_EDIT
&& secondAction
!= wxPG_ACTION_CANCEL_EDIT
)
5366 wxPGProperty
* p
= wxPropertyGridInterface::GetFirst();
5367 if ( p
) DoSelectProperty(p
);
5376 // -----------------------------------------------------------------------
5378 void wxPropertyGrid::OnKey( wxKeyEvent
&event
)
5380 // If there was editor open and focused, then this event should not
5381 // really be processed here.
5382 if ( IsEditorFocused() )
5384 // However, if event had modifiers, it is probably still best
5386 if ( event
.HasModifiers() )
5389 event
.StopPropagation();
5393 HandleKeyEvent(event
, false);
5396 // -----------------------------------------------------------------------
5398 bool wxPropertyGrid::ButtonTriggerKeyTest( int action
, wxKeyEvent
& event
)
5403 action
= KeyEventToActions(event
, &secondAction
);
5406 // Does the keycode trigger button?
5407 if ( action
== wxPG_ACTION_PRESS_BUTTON
&&
5410 wxCommandEvent
evt(wxEVT_COMMAND_BUTTON_CLICKED
, m_wndEditor2
->GetId());
5411 GetEventHandler()->AddPendingEvent(evt
);
5418 // -----------------------------------------------------------------------
5420 void wxPropertyGrid::OnChildKeyDown( wxKeyEvent
&event
)
5422 HandleKeyEvent(event
, true);
5425 // -----------------------------------------------------------------------
5426 // wxPropertyGrid miscellaneous event handling
5427 // -----------------------------------------------------------------------
5429 void wxPropertyGrid::OnIdle( wxIdleEvent
& WXUNUSED(event
) )
5432 // Check if the focus is in this control or one of its children
5433 wxWindow
* newFocused
= wxWindow::FindFocus();
5435 if ( newFocused
!= m_curFocused
)
5436 HandleFocusChange( newFocused
);
5439 // Check if top-level parent has changed
5440 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING
)
5442 wxWindow
* tlp
= ::wxGetTopLevelParent(this);
5448 bool wxPropertyGrid::IsEditorFocused() const
5450 wxWindow
* focus
= wxWindow::FindFocus();
5452 if ( focus
== m_wndEditor
|| focus
== m_wndEditor2
||
5453 focus
== GetEditorControl() )
5459 // Called by focus event handlers. newFocused is the window that becomes focused.
5460 void wxPropertyGrid::HandleFocusChange( wxWindow
* newFocused
)
5462 unsigned int oldFlags
= m_iFlags
;
5464 m_iFlags
&= ~(wxPG_FL_FOCUSED
);
5466 wxWindow
* parent
= newFocused
;
5468 // This must be one of nextFocus' parents.
5471 // Use m_eventObject, which is either wxPropertyGrid or
5472 // wxPropertyGridManager, as appropriate.
5473 if ( parent
== m_eventObject
)
5475 m_iFlags
|= wxPG_FL_FOCUSED
;
5478 parent
= parent
->GetParent();
5481 m_curFocused
= newFocused
;
5483 if ( (m_iFlags
& wxPG_FL_FOCUSED
) !=
5484 (oldFlags
& wxPG_FL_FOCUSED
) )
5486 if ( !(m_iFlags
& wxPG_FL_FOCUSED
) )
5488 // Need to store changed value
5489 CommitChangesFromEditor();
5495 // Preliminary code for tab-order respecting
5496 // tab-traversal (but should be moved to
5499 wxWindow* prevFocus = event.GetWindow();
5500 wxWindow* useThis = this;
5501 if ( m_iFlags & wxPG_FL_IN_MANAGER )
5502 useThis = GetParent();
5505 prevFocus->GetParent() == useThis->GetParent() )
5507 wxList& children = useThis->GetParent()->GetChildren();
5509 wxNode* node = children.Find(prevFocus);
5511 if ( node->GetNext() &&
5512 useThis == node->GetNext()->GetData() )
5513 DoSelectProperty(GetFirst());
5514 else if ( node->GetPrevious () &&
5515 useThis == node->GetPrevious()->GetData() )
5516 DoSelectProperty(GetLastProperty());
5523 wxPGProperty
* selected
= GetSelection();
5524 if ( selected
&& (m_iFlags
& wxPG_FL_INITIALIZED
) )
5525 DrawItem( selected
);
5529 void wxPropertyGrid::OnFocusEvent( wxFocusEvent
& event
)
5531 if ( event
.GetEventType() == wxEVT_SET_FOCUS
)
5532 HandleFocusChange((wxWindow
*)event
.GetEventObject());
5533 // Line changed to "else" when applying wxPropertyGrid patch #1675902
5534 //else if ( event.GetWindow() )
5536 HandleFocusChange(event
.GetWindow());
5541 // -----------------------------------------------------------------------
5543 void wxPropertyGrid::OnChildFocusEvent( wxChildFocusEvent
& event
)
5545 HandleFocusChange((wxWindow
*)event
.GetEventObject());
5549 // -----------------------------------------------------------------------
5551 void wxPropertyGrid::OnScrollEvent( wxScrollWinEvent
&event
)
5553 m_iFlags
|= wxPG_FL_SCROLLED
;
5558 // -----------------------------------------------------------------------
5560 void wxPropertyGrid::OnCaptureChange( wxMouseCaptureChangedEvent
& WXUNUSED(event
) )
5562 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
5564 m_iFlags
&= ~(wxPG_FL_MOUSE_CAPTURED
);
5568 // -----------------------------------------------------------------------
5569 // Property editor related functions
5570 // -----------------------------------------------------------------------
5572 // noDefCheck = true prevents infinite recursion.
5573 wxPGEditor
* wxPropertyGrid::DoRegisterEditorClass( wxPGEditor
* editorClass
,
5574 const wxString
& editorName
,
5577 wxASSERT( editorClass
);
5579 if ( !noDefCheck
&& wxPGGlobalVars
->m_mapEditorClasses
.empty() )
5580 RegisterDefaultEditors();
5582 wxString name
= editorName
;
5583 if ( name
.length() == 0 )
5584 name
= editorClass
->GetName();
5586 // Existing editor under this name?
5587 wxPGHashMapS2P::iterator vt_it
= wxPGGlobalVars
->m_mapEditorClasses
.find(name
);
5589 if ( vt_it
!= wxPGGlobalVars
->m_mapEditorClasses
.end() )
5591 // If this name was already used, try class name.
5592 name
= editorClass
->GetClassInfo()->GetClassName();
5593 vt_it
= wxPGGlobalVars
->m_mapEditorClasses
.find(name
);
5596 wxCHECK_MSG( vt_it
== wxPGGlobalVars
->m_mapEditorClasses
.end(),
5597 (wxPGEditor
*) vt_it
->second
,
5598 "Editor with given name was already registered" );
5600 wxPGGlobalVars
->m_mapEditorClasses
[name
] = (void*)editorClass
;
5605 // Use this in RegisterDefaultEditors.
5606 #define wxPGRegisterDefaultEditorClass(EDITOR) \
5607 if ( wxPGEditor_##EDITOR == NULL ) \
5609 wxPGEditor_##EDITOR = wxPropertyGrid::RegisterEditorClass( \
5610 new wxPG##EDITOR##Editor, true ); \
5613 // Registers all default editor classes
5614 void wxPropertyGrid::RegisterDefaultEditors()
5616 wxPGRegisterDefaultEditorClass( TextCtrl
);
5617 wxPGRegisterDefaultEditorClass( Choice
);
5618 wxPGRegisterDefaultEditorClass( ComboBox
);
5619 wxPGRegisterDefaultEditorClass( TextCtrlAndButton
);
5620 #if wxPG_INCLUDE_CHECKBOX
5621 wxPGRegisterDefaultEditorClass( CheckBox
);
5623 wxPGRegisterDefaultEditorClass( ChoiceAndButton
);
5625 // Register SpinCtrl etc. editors before use
5626 RegisterAdditionalEditors();
5629 // -----------------------------------------------------------------------
5630 // wxPGStringTokenizer
5631 // Needed to handle C-style string lists (e.g. "str1" "str2")
5632 // -----------------------------------------------------------------------
5634 wxPGStringTokenizer::wxPGStringTokenizer( const wxString
& str
, wxChar delimeter
)
5635 : m_str(&str
), m_curPos(str
.begin()), m_delimeter(delimeter
)
5639 wxPGStringTokenizer::~wxPGStringTokenizer()
5643 bool wxPGStringTokenizer::HasMoreTokens()
5645 const wxString
& str
= *m_str
;
5647 wxString::const_iterator i
= m_curPos
;
5649 wxUniChar delim
= m_delimeter
;
5651 wxUniChar prev_a
= wxT('\0');
5653 bool inToken
= false;
5655 while ( i
!= str
.end() )
5664 m_readyToken
.clear();
5669 if ( prev_a
!= wxT('\\') )
5673 if ( a
!= wxT('\\') )
5693 m_curPos
= str
.end();
5701 wxString
wxPGStringTokenizer::GetNextToken()
5703 return m_readyToken
;
5706 // -----------------------------------------------------------------------
5708 // -----------------------------------------------------------------------
5710 wxPGChoiceEntry::wxPGChoiceEntry()
5711 : wxPGCell(), m_value(wxPG_INVALID_VALUE
)
5715 // -----------------------------------------------------------------------
5717 // -----------------------------------------------------------------------
5719 wxPGChoicesData::wxPGChoicesData()
5723 wxPGChoicesData::~wxPGChoicesData()
5728 void wxPGChoicesData::Clear()
5733 void wxPGChoicesData::CopyDataFrom( wxPGChoicesData
* data
)
5735 wxASSERT( m_items
.size() == 0 );
5737 m_items
= data
->m_items
;
5740 wxPGChoiceEntry
& wxPGChoicesData::Insert( int index
,
5741 const wxPGChoiceEntry
& item
)
5743 wxVector
<wxPGChoiceEntry
>::iterator it
;
5747 index
= (int) m_items
.size();
5751 it
= m_items
.begin() + index
;
5754 m_items
.insert(it
, item
);
5756 wxPGChoiceEntry
& ownEntry
= m_items
[index
];
5758 // Need to fix value?
5759 if ( ownEntry
.GetValue() == wxPG_INVALID_VALUE
)
5760 ownEntry
.SetValue(index
);
5765 // -----------------------------------------------------------------------
5766 // wxPropertyGridEvent
5767 // -----------------------------------------------------------------------
5769 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGridEvent
, wxCommandEvent
)
5772 wxDEFINE_EVENT( wxEVT_PG_SELECTED
, wxPropertyGridEvent
);
5773 wxDEFINE_EVENT( wxEVT_PG_CHANGING
, wxPropertyGridEvent
);
5774 wxDEFINE_EVENT( wxEVT_PG_CHANGED
, wxPropertyGridEvent
);
5775 wxDEFINE_EVENT( wxEVT_PG_HIGHLIGHTED
, wxPropertyGridEvent
);
5776 wxDEFINE_EVENT( wxEVT_PG_RIGHT_CLICK
, wxPropertyGridEvent
);
5777 wxDEFINE_EVENT( wxEVT_PG_PAGE_CHANGED
, wxPropertyGridEvent
);
5778 wxDEFINE_EVENT( wxEVT_PG_ITEM_EXPANDED
, wxPropertyGridEvent
);
5779 wxDEFINE_EVENT( wxEVT_PG_ITEM_COLLAPSED
, wxPropertyGridEvent
);
5780 wxDEFINE_EVENT( wxEVT_PG_DOUBLE_CLICK
, wxPropertyGridEvent
);
5781 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_BEGIN
, wxPropertyGridEvent
);
5782 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_ENDING
, wxPropertyGridEvent
);
5784 // -----------------------------------------------------------------------
5786 void wxPropertyGridEvent::Init()
5788 m_validationInfo
= NULL
;
5791 m_wasVetoed
= false;
5794 // -----------------------------------------------------------------------
5796 wxPropertyGridEvent::wxPropertyGridEvent(wxEventType commandType
, int id
)
5797 : wxCommandEvent(commandType
,id
)
5803 // -----------------------------------------------------------------------
5805 wxPropertyGridEvent::wxPropertyGridEvent(const wxPropertyGridEvent
& event
)
5806 : wxCommandEvent(event
)
5808 m_eventType
= event
.GetEventType();
5809 m_eventObject
= event
.m_eventObject
;
5811 OnPropertyGridSet();
5812 m_property
= event
.m_property
;
5813 m_validationInfo
= event
.m_validationInfo
;
5814 m_canVeto
= event
.m_canVeto
;
5815 m_wasVetoed
= event
.m_wasVetoed
;
5818 // -----------------------------------------------------------------------
5820 void wxPropertyGridEvent::OnPropertyGridSet()
5826 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
5828 m_pg
->m_liveEvents
.push_back(this);
5831 // -----------------------------------------------------------------------
5833 wxPropertyGridEvent::~wxPropertyGridEvent()
5838 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
5841 // Use iterate from the back since it is more likely that the event
5842 // being desroyed is at the end of the array.
5843 wxVector
<wxPropertyGridEvent
*>& liveEvents
= m_pg
->m_liveEvents
;
5845 for ( int i
= liveEvents
.size()-1; i
>= 0; i
-- )
5847 if ( liveEvents
[i
] == this )
5849 liveEvents
.erase(liveEvents
.begin() + i
);
5856 // -----------------------------------------------------------------------
5858 wxEvent
* wxPropertyGridEvent::Clone() const
5860 return new wxPropertyGridEvent( *this );
5863 // -----------------------------------------------------------------------
5864 // wxPropertyGridPopulator
5865 // -----------------------------------------------------------------------
5867 wxPropertyGridPopulator::wxPropertyGridPopulator()
5871 wxPGGlobalVars
->m_offline
++;
5874 // -----------------------------------------------------------------------
5876 void wxPropertyGridPopulator::SetState( wxPropertyGridPageState
* state
)
5879 m_propHierarchy
.clear();
5882 // -----------------------------------------------------------------------
5884 void wxPropertyGridPopulator::SetGrid( wxPropertyGrid
* pg
)
5890 // -----------------------------------------------------------------------
5892 wxPropertyGridPopulator::~wxPropertyGridPopulator()
5895 // Free unused sets of choices
5896 wxPGHashMapS2P::iterator it
;
5898 for( it
= m_dictIdChoices
.begin(); it
!= m_dictIdChoices
.end(); ++it
)
5900 wxPGChoicesData
* data
= (wxPGChoicesData
*) it
->second
;
5907 m_pg
->GetPanel()->Refresh();
5909 wxPGGlobalVars
->m_offline
--;
5912 // -----------------------------------------------------------------------
5914 wxPGProperty
* wxPropertyGridPopulator::Add( const wxString
& propClass
,
5915 const wxString
& propLabel
,
5916 const wxString
& propName
,
5917 const wxString
* propValue
,
5918 wxPGChoices
* pChoices
)
5920 wxClassInfo
* classInfo
= wxClassInfo::FindClass(propClass
);
5921 wxPGProperty
* parent
= GetCurParent();
5923 if ( parent
->HasFlag(wxPG_PROP_AGGREGATE
) )
5925 ProcessError(wxString::Format(wxT("new children cannot be added to '%s'"),parent
->GetName().c_str()));
5929 if ( !classInfo
|| !classInfo
->IsKindOf(CLASSINFO(wxPGProperty
)) )
5931 ProcessError(wxString::Format(wxT("'%s' is not valid property class"),propClass
.c_str()));
5935 wxPGProperty
* property
= (wxPGProperty
*) classInfo
->CreateObject();
5937 property
->SetLabel(propLabel
);
5938 property
->DoSetName(propName
);
5940 if ( pChoices
&& pChoices
->IsOk() )
5941 property
->SetChoices(*pChoices
);
5943 m_state
->DoInsert(parent
, -1, property
);
5946 property
->SetValueFromString( *propValue
, wxPG_FULL_VALUE
|
5947 wxPG_PROGRAMMATIC_VALUE
);
5952 // -----------------------------------------------------------------------
5954 void wxPropertyGridPopulator::AddChildren( wxPGProperty
* property
)
5956 m_propHierarchy
.push_back(property
);
5957 DoScanForChildren();
5958 m_propHierarchy
.pop_back();
5961 // -----------------------------------------------------------------------
5963 wxPGChoices
wxPropertyGridPopulator::ParseChoices( const wxString
& choicesString
,
5964 const wxString
& idString
)
5966 wxPGChoices choices
;
5969 if ( choicesString
[0] == wxT('@') )
5971 wxString ids
= choicesString
.substr(1);
5972 wxPGHashMapS2P::iterator it
= m_dictIdChoices
.find(ids
);
5973 if ( it
== m_dictIdChoices
.end() )
5974 ProcessError(wxString::Format(wxT("No choices defined for id '%s'"),ids
.c_str()));
5976 choices
.AssignData((wxPGChoicesData
*)it
->second
);
5981 if ( idString
.length() )
5983 wxPGHashMapS2P::iterator it
= m_dictIdChoices
.find(idString
);
5984 if ( it
!= m_dictIdChoices
.end() )
5986 choices
.AssignData((wxPGChoicesData
*)it
->second
);
5993 // Parse choices string
5994 wxString::const_iterator it
= choicesString
.begin();
5998 bool labelValid
= false;
6000 for ( ; it
!= choicesString
.end(); ++it
)
6006 if ( c
== wxT('"') )
6011 if ( !value
.ToLong(&l
, 0) ) l
= wxPG_INVALID_VALUE
;
6012 choices
.Add(label
, l
);
6015 //wxLogDebug(wxT("%s, %s"),label.c_str(),value.c_str());
6020 else if ( c
== wxT('=') )
6027 else if ( state
== 2 && (wxIsalnum(c
) || c
== wxT('x')) )
6034 if ( c
== wxT('"') )
6047 if ( !value
.ToLong(&l
, 0) ) l
= wxPG_INVALID_VALUE
;
6048 choices
.Add(label
, l
);
6051 if ( !choices
.IsOk() )
6053 choices
.EnsureData();
6057 if ( idString
.length() )
6058 m_dictIdChoices
[idString
] = choices
.GetData();
6065 // -----------------------------------------------------------------------
6067 bool wxPropertyGridPopulator::ToLongPCT( const wxString
& s
, long* pval
, long max
)
6069 if ( s
.Last() == wxT('%') )
6071 wxString s2
= s
.substr(0,s
.length()-1);
6073 if ( s2
.ToLong(&val
, 10) )
6075 *pval
= (val
*max
)/100;
6081 return s
.ToLong(pval
, 10);
6084 // -----------------------------------------------------------------------
6086 bool wxPropertyGridPopulator::AddAttribute( const wxString
& name
,
6087 const wxString
& type
,
6088 const wxString
& value
)
6090 int l
= m_propHierarchy
.size();
6094 wxPGProperty
* p
= m_propHierarchy
[l
-1];
6095 wxString valuel
= value
.Lower();
6098 if ( type
.length() == 0 )
6103 if ( valuel
== wxT("true") || valuel
== wxT("yes") || valuel
== wxT("1") )
6105 else if ( valuel
== wxT("false") || valuel
== wxT("no") || valuel
== wxT("0") )
6107 else if ( value
.ToLong(&v
, 0) )
6114 if ( type
== wxT("string") )
6118 else if ( type
== wxT("int") )
6121 value
.ToLong(&v
, 0);
6124 else if ( type
== wxT("bool") )
6126 if ( valuel
== wxT("true") || valuel
== wxT("yes") || valuel
== wxT("1") )
6133 ProcessError(wxString::Format(wxT("Invalid attribute type '%s'"),type
.c_str()));
6138 p
->SetAttribute( name
, variant
);
6143 // -----------------------------------------------------------------------
6145 void wxPropertyGridPopulator::ProcessError( const wxString
& msg
)
6147 wxLogError(_("Error in resource: %s"),msg
.c_str());
6150 // -----------------------------------------------------------------------
6152 #endif // wxUSE_PROPGRID