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
* clipRect
)
1838 if ( m_frozen
|| m_height
< 1 || bottomy
< topy
|| !m_pState
)
1841 m_pState
->EnsureVirtualHeight();
1843 wxRect tempClipRect
;
1846 tempClipRect
= wxRect(0,topy
,m_pState
->m_width
,bottomy
);
1847 clipRect
= &tempClipRect
;
1850 // items added check
1851 if ( m_pState
->m_itemsAdded
) PrepareAfterItemsAdded();
1853 int paintFinishY
= 0;
1855 if ( m_pState
->m_properties
->GetChildCount() > 0 )
1858 bool isBuffered
= false;
1860 #if wxPG_DOUBLE_BUFFER
1861 wxMemoryDC
* bufferDC
= NULL
;
1863 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING
) )
1865 if ( !m_doubleBuffer
)
1867 paintFinishY
= clipRect
->y
;
1872 bufferDC
= new wxMemoryDC();
1874 // If nothing was changed, then just copy from double-buffer
1875 bufferDC
->SelectObject( *m_doubleBuffer
);
1885 dc
.SetClippingRegion( *clipRect
);
1886 paintFinishY
= DoDrawItems( *dcPtr
, clipRect
, isBuffered
);
1888 // Clear area beyond bottomY?
1889 if ( paintFinishY
< (clipRect
->y
+clipRect
->height
) )
1891 dcPtr
->SetPen(m_colEmptySpace
);
1892 dcPtr
->SetBrush(m_colEmptySpace
);
1893 dcPtr
->DrawRectangle( 0, paintFinishY
, m_width
,
1894 (clipRect
->y
+clipRect
->height
) );
1898 #if wxPG_DOUBLE_BUFFER
1901 dc
.Blit( clipRect
->x
, clipRect
->y
, clipRect
->width
,
1903 bufferDC
, 0, 0, wxCOPY
);
1904 dc
.DestroyClippingRegion(); // Is this really necessary?
1911 // Just clear the area
1912 dc
.SetPen(m_colEmptySpace
);
1913 dc
.SetBrush(m_colEmptySpace
);
1914 dc
.DrawRectangle(*clipRect
);
1918 // -----------------------------------------------------------------------
1920 int wxPropertyGrid::DoDrawItems( wxDC
& dc
,
1921 const wxRect
* clipRect
,
1922 bool isBuffered
) const
1924 const wxPGProperty
* firstItem
;
1925 const wxPGProperty
* lastItem
;
1927 firstItem
= DoGetItemAtY(clipRect
->y
);
1928 lastItem
= DoGetItemAtY(clipRect
->y
+clipRect
->height
-1);
1931 lastItem
= GetLastItem( wxPG_ITERATE_VISIBLE
);
1933 if ( m_frozen
|| m_height
< 1 || firstItem
== NULL
)
1936 wxCHECK_MSG( !m_pState
->m_itemsAdded
, clipRect
->y
, wxT("no items added") );
1937 wxASSERT( m_pState
->m_properties
->GetChildCount() );
1939 int lh
= m_lineHeight
;
1942 int lastItemBottomY
;
1944 firstItemTopY
= clipRect
->y
;
1945 lastItemBottomY
= clipRect
->y
+ clipRect
->height
;
1947 // Align y coordinates to item boundaries
1948 firstItemTopY
-= firstItemTopY
% lh
;
1949 lastItemBottomY
+= lh
- (lastItemBottomY
% lh
);
1950 lastItemBottomY
-= 1;
1952 // Entire range outside scrolled, visible area?
1953 if ( firstItemTopY
>= (int)m_pState
->GetVirtualHeight() || lastItemBottomY
<= 0 )
1956 wxCHECK_MSG( firstItemTopY
< lastItemBottomY
, clipRect
->y
, wxT("invalid y values") );
1960 wxLogDebug(wxT(" -> DoDrawItems ( \"%s\" -> \"%s\", height=%i (ch=%i), clipRect = 0x%lX )"),
1961 firstItem->GetLabel().c_str(),
1962 lastItem->GetLabel().c_str(),
1963 (int)(lastItemBottomY - firstItemTopY),
1965 (unsigned long)clipRect );
1970 long windowStyle
= m_windowStyle
;
1976 // With wxPG_DOUBLE_BUFFER, do double buffering
1977 // - buffer's y = 0, so align cliprect and coordinates to that
1979 #if wxPG_DOUBLE_BUFFER
1985 xRelMod
= clipRect
->x
;
1986 yRelMod
= clipRect
->y
;
1989 // clipRect conversion
1994 firstItemTopY
-= yRelMod
;
1995 lastItemBottomY
-= yRelMod
;
1998 wxUnusedVar(isBuffered
);
2001 int x
= m_marginWidth
- xRelMod
;
2003 wxFont normalFont
= GetFont();
2005 bool reallyFocused
= (m_iFlags
& wxPG_FL_FOCUSED
) != 0;
2007 bool isPgEnabled
= IsEnabled();
2010 // Prepare some pens and brushes that are often changed to.
2013 wxBrush
marginBrush(m_colMargin
);
2014 wxPen
marginPen(m_colMargin
);
2015 wxBrush
capbgbrush(m_colCapBack
,wxSOLID
);
2016 wxPen
linepen(m_colLine
,1,wxSOLID
);
2018 wxColour selBackCol
;
2020 selBackCol
= m_colSelBack
;
2022 selBackCol
= m_colMargin
;
2024 // pen that has same colour as text
2025 wxPen
outlinepen(m_colPropFore
,1,wxSOLID
);
2028 // Clear margin with background colour
2030 dc
.SetBrush( marginBrush
);
2031 if ( !(windowStyle
& wxPG_HIDE_MARGIN
) )
2033 dc
.SetPen( *wxTRANSPARENT_PEN
);
2034 dc
.DrawRectangle(-1-xRelMod
,firstItemTopY
-1,x
+2,lastItemBottomY
-firstItemTopY
+2);
2037 const wxPGProperty
* firstSelected
= GetSelection();
2038 const wxPropertyGridPageState
* state
= m_pState
;
2040 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2041 bool wasSelectedPainted
= false;
2044 // TODO: Only render columns that are within clipping region.
2046 dc
.SetFont(normalFont
);
2048 wxPropertyGridConstIterator
it( state
, wxPG_ITERATE_VISIBLE
, firstItem
);
2049 int endScanBottomY
= lastItemBottomY
+ lh
;
2050 int y
= firstItemTopY
;
2053 // Pregenerate list of visible properties.
2054 wxArrayPGProperty visPropArray
;
2055 visPropArray
.reserve((m_height
/m_lineHeight
)+6);
2057 for ( ; !it
.AtEnd(); it
.Next() )
2059 const wxPGProperty
* p
= *it
;
2061 if ( !p
->HasFlag(wxPG_PROP_HIDDEN
) )
2063 visPropArray
.push_back((wxPGProperty
*)p
);
2065 if ( y
> endScanBottomY
)
2072 visPropArray
.push_back(NULL
);
2074 wxPGProperty
* nextP
= visPropArray
[0];
2076 int gridWidth
= state
->m_width
;
2079 for ( unsigned int arrInd
=1;
2080 nextP
&& y
<= lastItemBottomY
;
2083 wxPGProperty
* p
= nextP
;
2084 nextP
= visPropArray
[arrInd
];
2086 int rowHeight
= m_fontHeight
+(m_spacingy
*2)+1;
2087 int textMarginHere
= x
;
2088 int renderFlags
= 0;
2090 int greyDepth
= m_marginWidth
;
2091 if ( !(windowStyle
& wxPG_HIDE_CATEGORIES
) )
2092 greyDepth
= (((int)p
->m_depthBgCol
)-1) * m_subgroup_extramargin
+ m_marginWidth
;
2094 int greyDepthX
= greyDepth
- xRelMod
;
2096 // Use basic depth if in non-categoric mode and parent is base array.
2097 if ( !(windowStyle
& wxPG_HIDE_CATEGORIES
) || p
->GetParent() != m_pState
->m_properties
)
2099 textMarginHere
+= ((unsigned int)((p
->m_depth
-1)*m_subgroup_extramargin
));
2102 // Paint margin area
2103 dc
.SetBrush(marginBrush
);
2104 dc
.SetPen(marginPen
);
2105 dc
.DrawRectangle( -xRelMod
, y
, greyDepth
, lh
);
2107 dc
.SetPen( linepen
);
2113 // Modified by JACS to not draw a margin if wxPG_HIDE_MARGIN is specified, since it
2114 // looks better, at least under Windows when we have a themed border (the themed-window-specific
2115 // whitespace between the real border and the propgrid margin exacerbates the double-border look).
2117 // Is this or its parent themed?
2118 bool suppressMarginEdge
= (GetWindowStyle() & wxPG_HIDE_MARGIN
) &&
2119 (((GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_THEME
) ||
2120 (((GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_NONE
) && ((GetParent()->GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_THEME
)));
2122 bool suppressMarginEdge
= false;
2124 if (!suppressMarginEdge
)
2125 dc
.DrawLine( greyDepthX
, y
, greyDepthX
, y2
);
2128 // Blank out the margin edge
2129 dc
.SetPen(wxPen(GetBackgroundColour()));
2130 dc
.DrawLine( greyDepthX
, y
, greyDepthX
, y2
);
2131 dc
.SetPen( linepen
);
2138 for ( si
=0; si
<state
->m_colWidths
.size(); si
++ )
2140 sx
+= state
->m_colWidths
[si
];
2141 dc
.DrawLine( sx
, y
, sx
, y2
);
2144 // Horizontal Line, below
2145 // (not if both this and next is category caption)
2146 if ( p
->IsCategory() &&
2147 nextP
&& nextP
->IsCategory() )
2148 dc
.SetPen(m_colCapBack
);
2150 dc
.DrawLine( greyDepthX
, y2
-1, gridWidth
-xRelMod
, y2
-1 );
2153 // Need to override row colours?
2157 bool isSelected
= state
->DoIsPropertySelected(p
);
2161 // Disabled may get different colour.
2162 if ( !p
->IsEnabled() )
2164 renderFlags
|= wxPGCellRenderer::Disabled
|
2165 wxPGCellRenderer::DontUseCellFgCol
;
2166 rowFgCol
= m_colDisPropFore
;
2171 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2172 if ( p
== firstSelected
)
2173 wasSelectedPainted
= true;
2176 renderFlags
|= wxPGCellRenderer::Selected
;
2178 if ( !p
->IsCategory() )
2180 renderFlags
|= wxPGCellRenderer::DontUseCellFgCol
|
2181 wxPGCellRenderer::DontUseCellBgCol
;
2183 if ( reallyFocused
&& p
== firstSelected
)
2185 rowFgCol
= m_colSelFore
;
2186 rowBgCol
= selBackCol
;
2188 else if ( isPgEnabled
)
2190 rowFgCol
= m_colPropFore
;
2191 if ( p
== firstSelected
)
2192 rowBgCol
= m_colMargin
;
2194 rowBgCol
= selBackCol
;
2198 rowFgCol
= m_colDisPropFore
;
2199 rowBgCol
= selBackCol
;
2206 if ( rowBgCol
.IsOk() )
2207 rowBgBrush
= wxBrush(rowBgCol
);
2209 if ( HasInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
) )
2210 renderFlags
= renderFlags
& ~wxPGCellRenderer::DontUseCellColours
;
2213 // Fill additional margin area with background colour of first cell
2214 if ( greyDepthX
< textMarginHere
)
2216 if ( !(renderFlags
& wxPGCellRenderer::DontUseCellBgCol
) )
2218 wxPGCell
& cell
= p
->GetCell(0);
2219 rowBgCol
= cell
.GetBgCol();
2220 rowBgBrush
= wxBrush(rowBgCol
);
2222 dc
.SetBrush(rowBgBrush
);
2223 dc
.SetPen(rowBgCol
);
2224 dc
.DrawRectangle(greyDepthX
+1, y
,
2225 textMarginHere
-greyDepthX
, lh
-1);
2228 bool fontChanged
= false;
2230 // Expander button rectangle
2231 wxRect
butRect( ((p
->m_depth
- 1) * m_subgroup_extramargin
) - xRelMod
,
2236 if ( p
->IsCategory() )
2238 // Captions have their cell areas merged as one
2239 dc
.SetFont(m_captionFont
);
2241 wxRect
cellRect(greyDepthX
, y
, gridWidth
- greyDepth
+ 2, rowHeight
-1 );
2243 if ( renderFlags
& wxPGCellRenderer::DontUseCellBgCol
)
2245 dc
.SetBrush(rowBgBrush
);
2246 dc
.SetPen(rowBgCol
);
2249 if ( renderFlags
& wxPGCellRenderer::DontUseCellFgCol
)
2251 dc
.SetTextForeground(rowFgCol
);
2254 wxPGCellRenderer
* renderer
= p
->GetCellRenderer(0);
2255 renderer
->Render( dc
, cellRect
, this, p
, 0, -1, renderFlags
);
2258 if ( !HasFlag(wxPG_HIDE_MARGIN
) && p
->HasVisibleChildren() )
2259 DrawExpanderButton( dc
, butRect
, p
);
2263 if ( p
->m_flags
& wxPG_PROP_MODIFIED
&& (windowStyle
& wxPG_BOLD_MODIFIED
) )
2265 dc
.SetFont(m_captionFont
);
2271 int nextCellWidth
= state
->m_colWidths
[0] -
2272 (greyDepthX
- m_marginWidth
);
2273 wxRect
cellRect(greyDepthX
+1, y
, 0, rowHeight
-1);
2274 int textXAdd
= textMarginHere
- greyDepthX
;
2276 for ( ci
=0; ci
<state
->m_colWidths
.size(); ci
++ )
2278 cellRect
.width
= nextCellWidth
- 1;
2280 wxWindow
* cellEditor
= NULL
;
2281 int cellRenderFlags
= renderFlags
;
2283 // Tree Item Button (must be drawn before clipping is set up)
2284 if ( ci
== 0 && !HasFlag(wxPG_HIDE_MARGIN
) && p
->HasVisibleChildren() )
2285 DrawExpanderButton( dc
, butRect
, p
);
2288 if ( isSelected
&& (ci
== 1 || ci
== m_selColumn
) )
2290 if ( p
== firstSelected
)
2292 if ( ci
== 1 && m_wndEditor
)
2293 cellEditor
= m_wndEditor
;
2294 else if ( ci
== m_selColumn
&& m_labelEditor
)
2295 cellEditor
= m_labelEditor
;
2300 wxColour editorBgCol
=
2301 cellEditor
->GetBackgroundColour();
2302 dc
.SetBrush(editorBgCol
);
2303 dc
.SetPen(editorBgCol
);
2304 dc
.SetTextForeground(m_colPropFore
);
2305 dc
.DrawRectangle(cellRect
);
2307 if ( m_dragStatus
!= 0 ||
2308 (m_iFlags
& wxPG_FL_CUR_USES_CUSTOM_IMAGE
) )
2313 dc
.SetBrush(m_colPropBack
);
2314 dc
.SetPen(m_colPropBack
);
2315 dc
.SetTextForeground(m_colDisPropFore
);
2316 if ( p
->IsEnabled() )
2317 dc
.SetTextForeground(rowFgCol
);
2319 dc
.SetTextForeground(m_colDisPropFore
);
2324 if ( renderFlags
& wxPGCellRenderer::DontUseCellBgCol
)
2326 dc
.SetBrush(rowBgBrush
);
2327 dc
.SetPen(rowBgCol
);
2330 if ( renderFlags
& wxPGCellRenderer::DontUseCellFgCol
)
2332 dc
.SetTextForeground(rowFgCol
);
2336 dc
.SetClippingRegion(cellRect
);
2338 cellRect
.x
+= textXAdd
;
2339 cellRect
.width
-= textXAdd
;
2344 wxPGCellRenderer
* renderer
;
2345 int cmnVal
= p
->GetCommonValue();
2346 if ( cmnVal
== -1 || ci
!= 1 )
2348 renderer
= p
->GetCellRenderer(ci
);
2349 renderer
->Render( dc
, cellRect
, this, p
, ci
, -1,
2354 renderer
= GetCommonValue(cmnVal
)->GetRenderer();
2355 renderer
->Render( dc
, cellRect
, this, p
, ci
, -1,
2360 cellX
+= state
->m_colWidths
[ci
];
2361 if ( ci
< (state
->m_colWidths
.size()-1) )
2362 nextCellWidth
= state
->m_colWidths
[ci
+1];
2364 dc
.DestroyClippingRegion(); // Is this really necessary?
2370 dc
.SetFont(normalFont
);
2375 // Refresh editor controls (seems not needed on msw)
2376 // NOTE: This code is mandatory for GTK!
2377 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2378 if ( wasSelectedPainted
)
2381 m_wndEditor
->Refresh();
2383 m_wndEditor2
->Refresh();
2390 // -----------------------------------------------------------------------
2392 wxRect
wxPropertyGrid::GetPropertyRect( const wxPGProperty
* p1
, const wxPGProperty
* p2
) const
2396 if ( m_width
< 10 || m_height
< 10 ||
2397 !m_pState
->m_properties
->GetChildCount() ||
2399 return wxRect(0,0,0,0);
2404 // Return rect which encloses the given property range
2406 int visTop
= p1
->GetY();
2409 visBottom
= p2
->GetY() + m_lineHeight
;
2411 visBottom
= m_height
+ visTop
;
2413 // If seleced property is inside the range, we'll extend the range to include
2415 wxPGProperty
* selected
= GetSelection();
2418 int selectedY
= selected
->GetY();
2419 if ( selectedY
>= visTop
&& selectedY
< visBottom
)
2421 wxWindow
* editor
= GetEditorControl();
2424 int visBottom2
= selectedY
+ editor
->GetSize().y
;
2425 if ( visBottom2
> visBottom
)
2426 visBottom
= visBottom2
;
2431 return wxRect(0,visTop
-vy
,m_pState
->m_width
,visBottom
-visTop
);
2434 // -----------------------------------------------------------------------
2436 void wxPropertyGrid::DrawItems( const wxPGProperty
* p1
, const wxPGProperty
* p2
)
2441 if ( m_pState
->m_itemsAdded
)
2442 PrepareAfterItemsAdded();
2444 wxRect r
= GetPropertyRect(p1
, p2
);
2451 // -----------------------------------------------------------------------
2453 void wxPropertyGrid::RefreshProperty( wxPGProperty
* p
)
2455 if ( m_pState
->DoIsPropertySelected(p
) )
2457 // NB: We must copy the selection.
2458 wxArrayPGProperty selection
= m_pState
->m_selection
;
2459 DoSetSelection(selection
, wxPG_SEL_FORCE
);
2462 DrawItemAndChildren(p
);
2465 // -----------------------------------------------------------------------
2467 void wxPropertyGrid::DrawItemAndValueRelated( wxPGProperty
* p
)
2472 // Draw item, children, and parent too, if it is not category
2473 wxPGProperty
* parent
= p
->GetParent();
2476 !parent
->IsCategory() &&
2477 parent
->GetParent() )
2480 parent
= parent
->GetParent();
2483 DrawItemAndChildren(p
);
2486 void wxPropertyGrid::DrawItemAndChildren( wxPGProperty
* p
)
2488 wxCHECK_RET( p
, wxT("invalid property id") );
2490 // Do not draw if in non-visible page
2491 if ( p
->GetParentState() != m_pState
)
2494 // do not draw a single item if multiple pending
2495 if ( m_pState
->m_itemsAdded
|| m_frozen
)
2498 // Update child control.
2499 wxPGProperty
* selected
= GetSelection();
2500 if ( selected
&& selected
->GetParent() == p
)
2503 const wxPGProperty
* lastDrawn
= p
->GetLastVisibleSubItem();
2505 DrawItems(p
, lastDrawn
);
2508 // -----------------------------------------------------------------------
2510 void wxPropertyGrid::Refresh( bool WXUNUSED(eraseBackground
),
2511 const wxRect
*rect
)
2513 PrepareAfterItemsAdded();
2515 wxWindow::Refresh(false, rect
);
2517 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2518 // I think this really helps only GTK+1.2
2519 if ( m_wndEditor
) m_wndEditor
->Refresh();
2520 if ( m_wndEditor2
) m_wndEditor2
->Refresh();
2524 // -----------------------------------------------------------------------
2525 // wxPropertyGrid global operations
2526 // -----------------------------------------------------------------------
2528 void wxPropertyGrid::Clear()
2530 m_pState
->DoClear();
2536 RecalculateVirtualSize();
2538 // Need to clear some area at the end
2540 RefreshRect(wxRect(0, 0, m_width
, m_height
));
2543 // -----------------------------------------------------------------------
2545 bool wxPropertyGrid::EnableCategories( bool enable
)
2552 // Enable categories
2555 m_windowStyle
&= ~(wxPG_HIDE_CATEGORIES
);
2560 // Disable categories
2562 m_windowStyle
|= wxPG_HIDE_CATEGORIES
;
2565 if ( !m_pState
->EnableCategories(enable
) )
2570 if ( m_windowStyle
& wxPG_AUTO_SORT
)
2572 m_pState
->m_itemsAdded
= 1; // force
2573 PrepareAfterItemsAdded();
2577 m_pState
->m_itemsAdded
= 1;
2579 // No need for RecalculateVirtualSize() here - it is already called in
2580 // wxPropertyGridPageState method above.
2587 // -----------------------------------------------------------------------
2589 void wxPropertyGrid::SwitchState( wxPropertyGridPageState
* pNewState
)
2591 wxASSERT( pNewState
);
2592 wxASSERT( pNewState
->GetGrid() );
2594 if ( pNewState
== m_pState
)
2597 wxArrayPGProperty oldSelection
= m_pState
->m_selection
;
2599 // Call ClearSelection() instead of DoClearSelection()
2600 // so that selection clear events are not sent.
2603 m_pState
->m_selection
= oldSelection
;
2605 bool orig_mode
= m_pState
->IsInNonCatMode();
2606 bool new_state_mode
= pNewState
->IsInNonCatMode();
2608 m_pState
= pNewState
;
2611 int pgWidth
= GetClientSize().x
;
2612 if ( HasVirtualWidth() )
2614 int minWidth
= pgWidth
;
2615 if ( pNewState
->m_width
< minWidth
)
2617 pNewState
->m_width
= minWidth
;
2618 pNewState
->CheckColumnWidths();
2624 // Just in case, fully re-center splitter
2625 if ( HasFlag( wxPG_SPLITTER_AUTO_CENTER
) )
2626 pNewState
->m_fSplitterX
= -1.0;
2628 pNewState
->OnClientWidthChange( pgWidth
, pgWidth
- pNewState
->m_width
);
2633 // If necessary, convert state to correct mode.
2634 if ( orig_mode
!= new_state_mode
)
2636 // This should refresh as well.
2637 EnableCategories( orig_mode
?false:true );
2639 else if ( !m_frozen
)
2641 // Refresh, if not frozen.
2642 m_pState
->PrepareAfterItemsAdded();
2644 // Reselect (Use SetSelection() instead of Do-variant so that
2645 // events won't be sent).
2646 SetSelection(m_pState
->m_selection
);
2648 RecalculateVirtualSize(0);
2652 m_pState
->m_itemsAdded
= 1;
2655 // -----------------------------------------------------------------------
2657 // Call to SetSplitterPosition will always disable splitter auto-centering
2658 // if parent window is shown.
2659 void wxPropertyGrid::DoSetSplitterPosition_( int newxpos
, bool refresh
, int splitterIndex
, bool allPages
)
2661 if ( ( newxpos
< wxPG_DRAG_MARGIN
) )
2664 wxPropertyGridPageState
* state
= m_pState
;
2666 state
->DoSetSplitterPosition( newxpos
, splitterIndex
, allPages
);
2670 if ( GetSelection() )
2671 CorrectEditorWidgetSizeX();
2677 // -----------------------------------------------------------------------
2679 void wxPropertyGrid::CenterSplitter( bool enableAutoCentering
)
2681 SetSplitterPosition( m_width
/2, true );
2682 if ( enableAutoCentering
&& ( m_windowStyle
& wxPG_SPLITTER_AUTO_CENTER
) )
2683 m_iFlags
&= ~(wxPG_FL_DONT_CENTER_SPLITTER
);
2686 // -----------------------------------------------------------------------
2687 // wxPropertyGrid item iteration (GetNextProperty etc.) methods
2688 // -----------------------------------------------------------------------
2690 // Returns nearest paint visible property (such that will be painted unless
2691 // window is scrolled or resized). If given property is paint visible, then
2692 // it itself will be returned
2693 wxPGProperty
* wxPropertyGrid::GetNearestPaintVisible( wxPGProperty
* p
) const
2695 int vx
,vy1
;// Top left corner of client
2696 GetViewStart(&vx
,&vy1
);
2697 vy1
*= wxPG_PIXELS_PER_UNIT
;
2699 int vy2
= vy1
+ m_height
;
2700 int propY
= p
->GetY2(m_lineHeight
);
2702 if ( (propY
+ m_lineHeight
) < vy1
)
2705 return DoGetItemAtY( vy1
);
2707 else if ( propY
> vy2
)
2710 return DoGetItemAtY( vy2
);
2713 // Itself paint visible
2718 // -----------------------------------------------------------------------
2719 // Methods related to change in value, value modification and sending events
2720 // -----------------------------------------------------------------------
2722 // commits any changes in editor of selected property
2723 // return true if validation did not fail
2724 // flags are same as with DoSelectProperty
2725 bool wxPropertyGrid::CommitChangesFromEditor( wxUint32 flags
)
2727 // Committing already?
2728 if ( m_inCommitChangesFromEditor
)
2731 // Don't do this if already processing editor event. It might
2732 // induce recursive dialogs and crap like that.
2733 if ( m_iFlags
& wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
)
2735 if ( m_inDoPropertyChanged
)
2741 wxPGProperty
* selected
= GetSelection();
2744 IsEditorsValueModified() &&
2745 (m_iFlags
& wxPG_FL_INITIALIZED
) &&
2748 m_inCommitChangesFromEditor
= 1;
2750 wxVariant
variant(selected
->GetValueRef());
2751 bool valueIsPending
= false;
2753 // JACS - necessary to avoid new focus being found spuriously within OnIdle
2754 // due to another window getting focus
2755 wxWindow
* oldFocus
= m_curFocused
;
2757 bool validationFailure
= false;
2758 bool forceSuccess
= (flags
& (wxPG_SEL_NOVALIDATE
|wxPG_SEL_FORCE
)) ? true : false;
2760 m_chgInfo_changedProperty
= NULL
;
2762 // If truly modified, schedule value as pending.
2763 if ( selected
->GetEditorClass()->
2764 GetValueFromControl( variant
,
2766 GetEditorControl() ) )
2768 if ( DoEditorValidate() &&
2769 PerformValidation(selected
, variant
) )
2771 valueIsPending
= true;
2775 validationFailure
= true;
2780 EditorsValueWasNotModified();
2785 m_inCommitChangesFromEditor
= 0;
2787 if ( validationFailure
&& !forceSuccess
)
2791 oldFocus
->SetFocus();
2792 m_curFocused
= oldFocus
;
2795 res
= OnValidationFailure(selected
, variant
);
2797 // Now prevent further validation failure messages
2800 EditorsValueWasNotModified();
2801 OnValidationFailureReset(selected
);
2804 else if ( valueIsPending
)
2806 DoPropertyChanged( selected
, flags
);
2807 EditorsValueWasNotModified();
2816 // -----------------------------------------------------------------------
2818 bool wxPropertyGrid::PerformValidation( wxPGProperty
* p
, wxVariant
& pendingValue
,
2822 // Runs all validation functionality.
2823 // Returns true if value passes all tests.
2826 m_validationInfo
.m_failureBehavior
= m_permanentValidationFailureBehavior
;
2829 // Variant list a special value that cannot be validated
2831 if ( pendingValue
.GetType() != wxPG_VARIANT_TYPE_LIST
)
2833 if ( !p
->ValidateValue(pendingValue
, m_validationInfo
) )
2838 // Adapt list to child values, if necessary
2839 wxVariant listValue
= pendingValue
;
2840 wxVariant
* pPendingValue
= &pendingValue
;
2841 wxVariant
* pList
= NULL
;
2843 // If parent has wxPG_PROP_AGGREGATE flag, or uses composite
2844 // string value, then we need treat as it was changed instead
2845 // (or, in addition, as is the case with composite string parent).
2846 // This includes creating list variant for child values.
2848 wxPGProperty
* pwc
= p
->GetParent();
2849 wxPGProperty
* changedProperty
= p
;
2850 wxPGProperty
* baseChangedProperty
= changedProperty
;
2851 wxVariant bcpPendingList
;
2853 listValue
= pendingValue
;
2854 listValue
.SetName(p
->GetBaseName());
2857 (pwc
->HasFlag(wxPG_PROP_AGGREGATE
) || pwc
->HasFlag(wxPG_PROP_COMPOSED_VALUE
)) )
2859 wxVariantList tempList
;
2860 wxVariant
lv(tempList
, pwc
->GetBaseName());
2861 lv
.Append(listValue
);
2863 pPendingValue
= &listValue
;
2865 if ( pwc
->HasFlag(wxPG_PROP_AGGREGATE
) )
2867 baseChangedProperty
= pwc
;
2868 bcpPendingList
= lv
;
2871 changedProperty
= pwc
;
2872 pwc
= pwc
->GetParent();
2876 wxPGProperty
* evtChangingProperty
= changedProperty
;
2878 if ( pPendingValue
->GetType() != wxPG_VARIANT_TYPE_LIST
)
2880 value
= *pPendingValue
;
2884 // Convert list to child values
2885 pList
= pPendingValue
;
2886 changedProperty
->AdaptListToValue( *pPendingValue
, &value
);
2889 wxVariant evtChangingValue
= value
;
2891 if ( flags
& SendEvtChanging
)
2893 // FIXME: After proper ValueToString()s added, remove
2894 // this. It is just a temporary fix, as evt_changing
2895 // will simply not work for wxPG_PROP_COMPOSED_VALUE
2896 // (unless it is selected, and textctrl editor is open).
2897 if ( changedProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
2899 evtChangingProperty
= baseChangedProperty
;
2900 if ( evtChangingProperty
!= p
)
2902 evtChangingProperty
->AdaptListToValue( bcpPendingList
, &evtChangingValue
);
2906 evtChangingValue
= pendingValue
;
2910 if ( evtChangingProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
2912 if ( changedProperty
== GetSelection() )
2914 wxWindow
* editor
= GetEditorControl();
2915 wxASSERT( editor
->IsKindOf(CLASSINFO(wxTextCtrl
)) );
2916 evtChangingValue
= wxStaticCast(editor
, wxTextCtrl
)->GetValue();
2920 wxLogDebug(wxT("WARNING: wxEVT_PG_CHANGING is about to happen with old value."));
2925 wxASSERT( m_chgInfo_changedProperty
== NULL
);
2926 m_chgInfo_changedProperty
= changedProperty
;
2927 m_chgInfo_baseChangedProperty
= baseChangedProperty
;
2928 m_chgInfo_pendingValue
= value
;
2931 m_chgInfo_valueList
= *pList
;
2933 m_chgInfo_valueList
.MakeNull();
2935 // If changedProperty is not property which value was edited,
2936 // then call wxPGProperty::ValidateValue() for that as well.
2937 if ( p
!= changedProperty
&& value
.GetType() != wxPG_VARIANT_TYPE_LIST
)
2939 if ( !changedProperty
->ValidateValue(value
, m_validationInfo
) )
2943 if ( flags
& SendEvtChanging
)
2945 // SendEvent returns true if event was vetoed
2946 if ( SendEvent( wxEVT_PG_CHANGING
, evtChangingProperty
,
2947 &evtChangingValue
) )
2951 if ( flags
& IsStandaloneValidation
)
2953 // If called in 'generic' context, we need to reset
2954 // m_chgInfo_changedProperty and write back translated value.
2955 m_chgInfo_changedProperty
= NULL
;
2956 pendingValue
= value
;
2962 // -----------------------------------------------------------------------
2964 void wxPropertyGrid::DoShowPropertyError( wxPGProperty
* WXUNUSED(property
), const wxString
& msg
)
2966 if ( !msg
.length() )
2970 if ( !wxPGGlobalVars
->m_offline
)
2972 wxWindow
* topWnd
= ::wxGetTopLevelParent(this);
2975 wxFrame
* pFrame
= wxDynamicCast(topWnd
, wxFrame
);
2978 wxStatusBar
* pStatusBar
= pFrame
->GetStatusBar();
2981 pStatusBar
->SetStatusText(msg
);
2989 ::wxMessageBox(msg
, wxT("Property Error"));
2992 // -----------------------------------------------------------------------
2994 bool wxPropertyGrid::OnValidationFailure( wxPGProperty
* property
,
2995 wxVariant
& invalidValue
)
2997 wxWindow
* editor
= GetEditorControl();
2999 // First call property's handler
3000 property
->OnValidationFailure(invalidValue
);
3002 bool res
= DoOnValidationFailure(property
, invalidValue
);
3005 // For non-wxTextCtrl editors, we do need to revert the value
3006 if ( !editor
->IsKindOf(CLASSINFO(wxTextCtrl
)) &&
3007 property
== GetSelection() )
3009 property
->GetEditorClass()->UpdateControl(property
, editor
);
3012 property
->SetFlag(wxPG_PROP_INVALID_VALUE
);
3017 bool wxPropertyGrid::DoOnValidationFailure( wxPGProperty
* property
, wxVariant
& WXUNUSED(invalidValue
) )
3019 int vfb
= m_validationInfo
.m_failureBehavior
;
3021 if ( vfb
& wxPG_VFB_BEEP
)
3024 if ( (vfb
& wxPG_VFB_MARK_CELL
) &&
3025 !property
->HasFlag(wxPG_PROP_INVALID_VALUE
) )
3027 unsigned int colCount
= m_pState
->GetColumnCount();
3029 // We need backup marked property's cells
3030 m_propCellsBackup
= property
->m_cells
;
3032 wxColour vfbFg
= *wxWHITE
;
3033 wxColour vfbBg
= *wxRED
;
3035 property
->EnsureCells(colCount
);
3037 for ( unsigned int i
=0; i
<colCount
; i
++ )
3039 wxPGCell
& cell
= property
->m_cells
[i
];
3040 cell
.SetFgCol(vfbFg
);
3041 cell
.SetBgCol(vfbBg
);
3044 DrawItemAndChildren(property
);
3046 if ( property
== GetSelection() )
3048 SetInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
);
3050 wxWindow
* editor
= GetEditorControl();
3053 editor
->SetForegroundColour(vfbFg
);
3054 editor
->SetBackgroundColour(vfbBg
);
3059 if ( vfb
& wxPG_VFB_SHOW_MESSAGE
)
3061 wxString msg
= m_validationInfo
.m_failureMessage
;
3063 if ( !msg
.length() )
3064 msg
= wxT("You have entered invalid value. Press ESC to cancel editing.");
3066 DoShowPropertyError(property
, msg
);
3069 return (vfb
& wxPG_VFB_STAY_IN_PROPERTY
) ? false : true;
3072 // -----------------------------------------------------------------------
3074 void wxPropertyGrid::DoOnValidationFailureReset( wxPGProperty
* property
)
3076 int vfb
= m_validationInfo
.m_failureBehavior
;
3078 if ( vfb
& wxPG_VFB_MARK_CELL
)
3081 property
->m_cells
= m_propCellsBackup
;
3083 ClearInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
);
3085 if ( property
== GetSelection() && GetEditorControl() )
3087 // Calling this will recreate the control, thus resetting its colour
3088 RefreshProperty(property
);
3092 DrawItemAndChildren(property
);
3097 // -----------------------------------------------------------------------
3099 // flags are same as with DoSelectProperty
3100 bool wxPropertyGrid::DoPropertyChanged( wxPGProperty
* p
, unsigned int selFlags
)
3102 if ( m_inDoPropertyChanged
)
3105 wxWindow
* editor
= GetEditorControl();
3106 wxPGProperty
* selected
= GetSelection();
3108 m_pState
->m_anyModified
= 1;
3110 m_inDoPropertyChanged
= 1;
3112 // Maybe need to update control
3113 wxASSERT( m_chgInfo_changedProperty
!= NULL
);
3115 // These values were calculated in PerformValidation()
3116 wxPGProperty
* changedProperty
= m_chgInfo_changedProperty
;
3117 wxVariant value
= m_chgInfo_pendingValue
;
3119 wxPGProperty
* topPaintedProperty
= changedProperty
;
3121 while ( !topPaintedProperty
->IsCategory() &&
3122 !topPaintedProperty
->IsRoot() )
3124 topPaintedProperty
= topPaintedProperty
->GetParent();
3127 changedProperty
->SetValue(value
, &m_chgInfo_valueList
, wxPG_SETVAL_BY_USER
);
3129 // Set as Modified (not if dragging just began)
3130 if ( !(p
->m_flags
& wxPG_PROP_MODIFIED
) )
3132 p
->m_flags
|= wxPG_PROP_MODIFIED
;
3133 if ( p
== selected
&& (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3136 SetCurControlBoldFont();
3142 // Propagate updates to parent(s)
3144 wxPGProperty
* prevPwc
= NULL
;
3146 while ( prevPwc
!= topPaintedProperty
)
3148 pwc
->m_flags
|= wxPG_PROP_MODIFIED
;
3150 if ( pwc
== selected
&& (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3153 SetCurControlBoldFont();
3157 pwc
= pwc
->GetParent();
3160 // Draw the actual property
3161 DrawItemAndChildren( topPaintedProperty
);
3164 // If value was set by wxPGProperty::OnEvent, then update the editor
3166 if ( selFlags
& wxPG_SEL_DIALOGVAL
)
3172 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
3173 if ( m_wndEditor
) m_wndEditor
->Refresh();
3174 if ( m_wndEditor2
) m_wndEditor2
->Refresh();
3179 wxASSERT( !changedProperty
->GetParent()->HasFlag(wxPG_PROP_AGGREGATE
) );
3181 // If top parent has composite string value, then send to child parents,
3182 // starting from baseChangedProperty.
3183 if ( changedProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
3185 pwc
= m_chgInfo_baseChangedProperty
;
3187 while ( pwc
!= changedProperty
)
3189 SendEvent( wxEVT_PG_CHANGED
, pwc
, NULL
);
3190 pwc
= pwc
->GetParent();
3194 SendEvent( wxEVT_PG_CHANGED
, changedProperty
, NULL
);
3196 m_inDoPropertyChanged
= 0;
3201 // -----------------------------------------------------------------------
3203 bool wxPropertyGrid::ChangePropertyValue( wxPGPropArg id
, wxVariant newValue
)
3205 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
3207 m_chgInfo_changedProperty
= NULL
;
3209 if ( PerformValidation(p
, newValue
) )
3211 DoPropertyChanged(p
);
3216 OnValidationFailure(p
, newValue
);
3222 // -----------------------------------------------------------------------
3224 wxVariant
wxPropertyGrid::GetUncommittedPropertyValue()
3226 wxPGProperty
* prop
= GetSelectedProperty();
3229 return wxNullVariant
;
3231 wxTextCtrl
* tc
= GetEditorTextCtrl();
3232 wxVariant value
= prop
->GetValue();
3234 if ( !tc
|| !IsEditorsValueModified() )
3237 if ( !prop
->StringToValue(value
, tc
->GetValue()) )
3240 if ( !PerformValidation(prop
, value
, IsStandaloneValidation
) )
3241 return prop
->GetValue();
3246 // -----------------------------------------------------------------------
3248 // Runs wxValidator for the selected property
3249 bool wxPropertyGrid::DoEditorValidate()
3254 // -----------------------------------------------------------------------
3256 void wxPropertyGrid::HandleCustomEditorEvent( wxEvent
&event
)
3258 wxPGProperty
* selected
= GetSelection();
3260 // Somehow, event is handled after property has been deselected.
3261 // Possibly, but very rare.
3263 selected
->HasFlag(wxPG_PROP_BEING_DELETED
) ||
3264 // Also don't handle editor event if wxEVT_PG_CHANGED or
3265 // similar is currently doing something (showing a
3266 // message box, for instance).
3270 if ( m_iFlags
& wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
)
3273 wxVariant
pendingValue(selected
->GetValueRef());
3274 wxWindow
* wnd
= GetEditorControl();
3275 wxWindow
* editorWnd
= wxDynamicCast(event
.GetEventObject(), wxWindow
);
3277 bool wasUnspecified
= selected
->IsValueUnspecified();
3278 int usesAutoUnspecified
= selected
->UsesAutoUnspecified();
3279 bool valueIsPending
= false;
3281 m_chgInfo_changedProperty
= NULL
;
3283 m_iFlags
&= ~(wxPG_FL_VALIDATION_FAILED
|wxPG_FL_VALUE_CHANGE_IN_EVENT
);
3286 // Filter out excess wxTextCtrl modified events
3287 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_UPDATED
&&
3289 wnd
->IsKindOf(CLASSINFO(wxTextCtrl
)) )
3291 wxTextCtrl
* tc
= (wxTextCtrl
*) wnd
;
3293 wxString newTcValue
= tc
->GetValue();
3294 if ( m_prevTcValue
== newTcValue
)
3297 m_prevTcValue
= newTcValue
;
3300 SetInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
);
3302 bool validationFailure
= false;
3303 bool buttonWasHandled
= false;
3306 // Try common button handling
3307 if ( m_wndEditor2
&& event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
3309 wxPGEditorDialogAdapter
* adapter
= selected
->GetEditorDialog();
3313 buttonWasHandled
= true;
3314 // Store as res2, as previously (and still currently alternatively)
3315 // dialogs can be shown by handling wxEVT_COMMAND_BUTTON_CLICKED
3316 // in wxPGProperty::OnEvent().
3317 adapter
->ShowDialog( this, selected
);
3322 if ( !buttonWasHandled
)
3324 if ( wnd
|| m_wndEditor2
)
3326 // First call editor class' event handler.
3327 const wxPGEditor
* editor
= selected
->GetEditorClass();
3329 if ( editor
->OnEvent( this, selected
, editorWnd
, event
) )
3331 // If changes, validate them
3332 if ( DoEditorValidate() )
3334 if ( editor
->GetValueFromControl( pendingValue
,
3337 valueIsPending
= true;
3341 validationFailure
= true;
3346 // Then the property's custom handler (must be always called, unless
3347 // validation failed).
3348 if ( !validationFailure
)
3349 buttonWasHandled
= selected
->OnEvent( this, editorWnd
, event
);
3352 // SetValueInEvent(), as called in one of the functions referred above
3353 // overrides editor's value.
3354 if ( m_iFlags
& wxPG_FL_VALUE_CHANGE_IN_EVENT
)
3356 valueIsPending
= true;
3357 pendingValue
= m_changeInEventValue
;
3358 selFlags
|= wxPG_SEL_DIALOGVAL
;
3361 if ( !validationFailure
&& valueIsPending
)
3362 if ( !PerformValidation(selected
, pendingValue
) )
3363 validationFailure
= true;
3365 if ( validationFailure
)
3367 OnValidationFailure(selected
, pendingValue
);
3369 else if ( valueIsPending
)
3371 selFlags
|= ( !wasUnspecified
&& selected
->IsValueUnspecified() && usesAutoUnspecified
) ? wxPG_SEL_SETUNSPEC
: 0;
3373 DoPropertyChanged(selected
, selFlags
);
3374 EditorsValueWasNotModified();
3376 // Regardless of editor type, unfocus editor on
3377 // text-editing related enter press.
3378 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_ENTER
)
3385 // No value after all
3387 // Regardless of editor type, unfocus editor on
3388 // text-editing related enter press.
3389 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_ENTER
)
3394 // Let unhandled button click events go to the parent
3395 if ( !buttonWasHandled
&& event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
3397 wxCommandEvent
evt(wxEVT_COMMAND_BUTTON_CLICKED
,GetId());
3398 GetEventHandler()->AddPendingEvent(evt
);
3402 ClearInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
);
3405 // -----------------------------------------------------------------------
3406 // wxPropertyGrid editor control helper methods
3407 // -----------------------------------------------------------------------
3409 wxRect
wxPropertyGrid::GetEditorWidgetRect( wxPGProperty
* p
, int column
) const
3411 int itemy
= p
->GetY2(m_lineHeight
);
3412 int splitterX
= m_pState
->DoGetSplitterPosition(column
-1);
3413 int colEnd
= splitterX
+ m_pState
->m_colWidths
[column
];
3414 int imageOffset
= 0;
3416 int vx
, vy
; // Top left corner of client
3417 GetViewStart(&vx
, &vy
);
3418 vy
*= wxPG_PIXELS_PER_UNIT
;
3420 // TODO: If custom image detection changes from current, change this.
3421 if ( m_iFlags
& wxPG_FL_CUR_USES_CUSTOM_IMAGE
)
3423 //m_iFlags |= wxPG_FL_CUR_USES_CUSTOM_IMAGE;
3424 int iw
= p
->OnMeasureImage().x
;
3426 iw
= wxPG_CUSTOM_IMAGE_WIDTH
;
3427 imageOffset
= p
->GetImageOffset(iw
);
3432 splitterX
+imageOffset
+wxPG_XBEFOREWIDGET
+wxPG_CONTROL_MARGIN
+1,
3434 colEnd
-splitterX
-wxPG_XBEFOREWIDGET
-wxPG_CONTROL_MARGIN
-imageOffset
-1,
3439 // -----------------------------------------------------------------------
3441 wxRect
wxPropertyGrid::GetImageRect( wxPGProperty
* p
, int item
) const
3443 wxSize sz
= GetImageSize(p
, item
);
3444 return wxRect(wxPG_CONTROL_MARGIN
+ wxCC_CUSTOM_IMAGE_MARGIN1
,
3445 wxPG_CUSTOM_IMAGE_SPACINGY
,
3450 // return size of custom paint image
3451 wxSize
wxPropertyGrid::GetImageSize( wxPGProperty
* p
, int item
) const
3453 // If called with NULL property, then return default image
3454 // size for properties that use image.
3456 return wxSize(wxPG_CUSTOM_IMAGE_WIDTH
,wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight
));
3458 wxSize cis
= p
->OnMeasureImage(item
);
3460 int choiceCount
= p
->m_choices
.GetCount();
3461 int comVals
= p
->GetDisplayedCommonValueCount();
3462 if ( item
>= choiceCount
&& comVals
> 0 )
3464 unsigned int cvi
= item
-choiceCount
;
3465 cis
= GetCommonValue(cvi
)->GetRenderer()->GetImageSize(NULL
, 1, cvi
);
3467 else if ( item
>= 0 && choiceCount
== 0 )
3468 return wxSize(0, 0);
3473 cis
.x
= wxPG_CUSTOM_IMAGE_WIDTH
;
3478 cis
.y
= wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight
);
3485 // -----------------------------------------------------------------------
3487 // takes scrolling into account
3488 void wxPropertyGrid::ImprovedClientToScreen( int* px
, int* py
)
3491 GetViewStart(&vx
,&vy
);
3492 vy
*=wxPG_PIXELS_PER_UNIT
;
3493 vx
*=wxPG_PIXELS_PER_UNIT
;
3496 ClientToScreen( px
, py
);
3499 // -----------------------------------------------------------------------
3501 wxPropertyGridHitTestResult
wxPropertyGrid::HitTest( const wxPoint
& pt
) const
3504 GetViewStart(&pt2
.x
,&pt2
.y
);
3505 pt2
.x
*= wxPG_PIXELS_PER_UNIT
;
3506 pt2
.y
*= wxPG_PIXELS_PER_UNIT
;
3510 return m_pState
->HitTest(pt2
);
3513 // -----------------------------------------------------------------------
3515 // custom set cursor
3516 void wxPropertyGrid::CustomSetCursor( int type
, bool override
)
3518 if ( type
== m_curcursor
&& !override
) return;
3520 wxCursor
* cursor
= &wxPG_DEFAULT_CURSOR
;
3522 if ( type
== wxCURSOR_SIZEWE
)
3523 cursor
= m_cursorSizeWE
;
3525 SetCursor( *cursor
);
3530 // -----------------------------------------------------------------------
3531 // wxPropertyGrid property selection, editor creation
3532 // -----------------------------------------------------------------------
3535 // This class forwards events from property editor controls to wxPropertyGrid.
3536 class wxPropertyGridEditorEventForwarder
: public wxEvtHandler
3539 wxPropertyGridEditorEventForwarder( wxPropertyGrid
* propGrid
)
3540 : wxEvtHandler(), m_propGrid(propGrid
)
3544 virtual ~wxPropertyGridEditorEventForwarder()
3549 bool ProcessEvent( wxEvent
& event
)
3554 m_propGrid
->HandleCustomEditorEvent(event
);
3556 return wxEvtHandler::ProcessEvent(event
);
3559 wxPropertyGrid
* m_propGrid
;
3562 // Setups event handling for child control
3563 void wxPropertyGrid::SetupChildEventHandling( wxWindow
* argWnd
)
3565 wxWindowID id
= argWnd
->GetId();
3567 if ( argWnd
== m_wndEditor
)
3569 argWnd
->Connect(id
, wxEVT_MOTION
,
3570 wxMouseEventHandler(wxPropertyGrid::OnMouseMoveChild
),
3572 argWnd
->Connect(id
, wxEVT_LEFT_UP
,
3573 wxMouseEventHandler(wxPropertyGrid::OnMouseUpChild
),
3575 argWnd
->Connect(id
, wxEVT_LEFT_DOWN
,
3576 wxMouseEventHandler(wxPropertyGrid::OnMouseClickChild
),
3578 argWnd
->Connect(id
, wxEVT_RIGHT_UP
,
3579 wxMouseEventHandler(wxPropertyGrid::OnMouseRightClickChild
),
3581 argWnd
->Connect(id
, wxEVT_ENTER_WINDOW
,
3582 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry
),
3584 argWnd
->Connect(id
, wxEVT_LEAVE_WINDOW
,
3585 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry
),
3589 wxPropertyGridEditorEventForwarder
* forwarder
;
3590 forwarder
= new wxPropertyGridEditorEventForwarder(this);
3591 argWnd
->PushEventHandler(forwarder
);
3593 argWnd
->Connect(id
, wxEVT_KEY_DOWN
,
3594 wxCharEventHandler(wxPropertyGrid::OnChildKeyDown
),
3598 void wxPropertyGrid::DestroyEditorWnd( wxWindow
* wnd
)
3605 // Do not free editors immediately (for sake of processing events)
3606 wxPendingDelete
.Append(wnd
);
3609 void wxPropertyGrid::FreeEditors()
3612 // Return focus back to canvas from children (this is required at least for
3613 // GTK+, which, unlike Windows, clears focus when control is destroyed
3614 // instead of moving it to closest parent).
3615 wxWindow
* focus
= wxWindow::FindFocus();
3618 wxWindow
* parent
= focus
->GetParent();
3621 if ( parent
== this )
3626 parent
= parent
->GetParent();
3630 // Do not free editors immediately if processing events
3633 wxEvtHandler
* handler
= m_wndEditor2
->PopEventHandler(false);
3634 m_wndEditor2
->Hide();
3635 wxPendingDelete
.Append( handler
);
3636 DestroyEditorWnd(m_wndEditor2
);
3637 m_wndEditor2
= NULL
;
3642 wxEvtHandler
* handler
= m_wndEditor
->PopEventHandler(false);
3643 m_wndEditor
->Hide();
3644 wxPendingDelete
.Append( handler
);
3645 DestroyEditorWnd(m_wndEditor
);
3650 // Call with NULL to de-select property
3651 bool wxPropertyGrid::DoSelectProperty( wxPGProperty
* p
, unsigned int flags
)
3656 wxLogDebug(wxT("SelectProperty( %s (%s[%i]) )"),p->m_label.c_str(),
3657 p->m_parent->m_label.c_str(),p->GetIndexInParent());
3661 wxLogDebug(wxT("SelectProperty( NULL, -1 )"));
3665 if ( m_inDoSelectProperty
)
3668 m_inDoSelectProperty
= 1;
3672 m_inDoSelectProperty
= 0;
3676 wxArrayPGProperty prevSelection
= m_pState
->m_selection
;
3677 wxPGProperty
* prevFirstSel
;
3679 if ( prevSelection
.size() > 0 )
3680 prevFirstSel
= prevSelection
[0];
3682 prevFirstSel
= NULL
;
3684 if ( prevFirstSel
&& prevFirstSel
->HasFlag(wxPG_PROP_BEING_DELETED
) )
3685 prevFirstSel
= NULL
;
3687 // Always send event, as this is indirect call
3688 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
);
3692 wxPrintf( "Selected %s\n", prevFirstSel->GetClassInfo()->GetClassName() );
3694 wxPrintf( "None selected\n" );
3697 wxPrintf( "P = %s\n", p->GetClassInfo()->GetClassName() );
3699 wxPrintf( "P = NULL\n" );
3702 // If we are frozen, then just set the values.
3705 m_iFlags
&= ~(wxPG_FL_ABNORMAL_EDITOR
);
3706 m_editorFocused
= 0;
3707 m_pState
->DoSetSelection(p
);
3709 // If frozen, always free controls. But don't worry, as Thaw will
3710 // recall SelectProperty to recreate them.
3713 // Prevent any further selection measures in this call
3719 if ( prevFirstSel
== p
&&
3720 prevSelection
.size() <= 1 &&
3721 !(flags
& wxPG_SEL_FORCE
) )
3723 // Only set focus if not deselecting
3726 if ( flags
& wxPG_SEL_FOCUS
)
3730 m_wndEditor
->SetFocus();
3731 m_editorFocused
= 1;
3740 m_inDoSelectProperty
= 0;
3745 // First, deactivate previous
3748 OnValidationFailureReset(prevFirstSel
);
3750 // Must double-check if this is an selected in case of forceswitch
3751 if ( p
!= prevFirstSel
)
3753 if ( !CommitChangesFromEditor(flags
) )
3755 // Validation has failed, so we can't exit the previous editor
3756 //::wxMessageBox(_("Please correct the value or press ESC to cancel the edit."),
3757 // _("Invalid Value"),wxOK|wxICON_ERROR);
3758 m_inDoSelectProperty
= 0;
3765 m_iFlags
&= ~(wxPG_FL_ABNORMAL_EDITOR
);
3766 EditorsValueWasNotModified();
3769 SetInternalFlag(wxPG_FL_IN_SELECT_PROPERTY
);
3771 m_pState
->DoSetSelection(p
);
3773 // Redraw unselected
3774 for ( unsigned int i
=0; i
<prevSelection
.size(); i
++ )
3776 DrawItem(prevSelection
[i
]);
3780 // Then, activate the one given.
3783 int propY
= p
->GetY2(m_lineHeight
);
3785 int splitterX
= GetSplitterPosition();
3786 m_editorFocused
= 0;
3787 m_iFlags
|= wxPG_FL_PRIMARY_FILLS_ENTIRE
;
3788 if ( p
!= prevFirstSel
)
3789 m_iFlags
&= ~(wxPG_FL_VALIDATION_FAILED
);
3791 wxASSERT( m_wndEditor
== NULL
);
3794 // Only create editor for non-disabled non-caption
3795 if ( !p
->IsCategory() && !(p
->m_flags
& wxPG_PROP_DISABLED
) )
3797 // do this for non-caption items
3801 // Do we need to paint the custom image, if any?
3802 m_iFlags
&= ~(wxPG_FL_CUR_USES_CUSTOM_IMAGE
);
3803 if ( (p
->m_flags
& wxPG_PROP_CUSTOMIMAGE
) &&
3804 !p
->GetEditorClass()->CanContainCustomImage()
3806 m_iFlags
|= wxPG_FL_CUR_USES_CUSTOM_IMAGE
;
3808 wxRect grect
= GetEditorWidgetRect(p
, m_selColumn
);
3809 wxPoint goodPos
= grect
.GetPosition();
3811 const wxPGEditor
* editor
= p
->GetEditorClass();
3812 wxCHECK_MSG(editor
, false,
3813 wxT("NULL editor class not allowed"));
3815 m_iFlags
&= ~wxPG_FL_FIXED_WIDTH_EDITOR
;
3817 wxPGWindowList wndList
=
3818 editor
->CreateControls(this,
3823 m_wndEditor
= wndList
.m_primary
;
3824 m_wndEditor2
= wndList
.m_secondary
;
3825 wxWindow
* primaryCtrl
= GetEditorControl();
3828 // Essentially, primaryCtrl == m_wndEditor
3831 // NOTE: It is allowed for m_wndEditor to be NULL - in this
3832 // case value is drawn as normal, and m_wndEditor2 is
3833 // assumed to be a right-aligned button that triggers
3834 // a separate editorCtrl window.
3838 wxASSERT_MSG( m_wndEditor
->GetParent() == GetPanel(),
3839 "CreateControls must use result of "
3840 "wxPropertyGrid::GetPanel() as parent "
3843 // Set validator, if any
3844 #if wxUSE_VALIDATORS
3845 wxValidator
* validator
= p
->GetValidator();
3847 primaryCtrl
->SetValidator(*validator
);
3850 if ( m_wndEditor
->GetSize().y
> (m_lineHeight
+6) )
3851 m_iFlags
|= wxPG_FL_ABNORMAL_EDITOR
;
3853 // If it has modified status, use bold font
3854 // (must be done before capturing m_ctrlXAdjust)
3855 if ( (p
->m_flags
& wxPG_PROP_MODIFIED
) &&
3856 (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3857 SetCurControlBoldFont();
3859 // Store x relative to splitter (we'll need it).
3860 m_ctrlXAdjust
= m_wndEditor
->GetPosition().x
- splitterX
;
3862 // Check if background clear is not necessary
3863 wxPoint pos
= m_wndEditor
->GetPosition();
3864 if ( pos
.x
> (splitterX
+1) || pos
.y
> propY
)
3866 m_iFlags
&= ~(wxPG_FL_PRIMARY_FILLS_ENTIRE
);
3869 m_wndEditor
->SetSizeHints(3, 3);
3871 SetupChildEventHandling(primaryCtrl
);
3873 // Focus and select all (wxTextCtrl, wxComboBox etc)
3874 if ( flags
& wxPG_SEL_FOCUS
)
3876 primaryCtrl
->SetFocus();
3878 p
->GetEditorClass()->OnFocus(p
, primaryCtrl
);
3884 wxASSERT_MSG( m_wndEditor2
->GetParent() == GetPanel(),
3885 "CreateControls must use result of "
3886 "wxPropertyGrid::GetPanel() as parent "
3889 // Get proper id for wndSecondary
3890 m_wndSecId
= m_wndEditor2
->GetId();
3891 wxWindowList children
= m_wndEditor2
->GetChildren();
3892 wxWindowList::iterator node
= children
.begin();
3893 if ( node
!= children
.end() )
3894 m_wndSecId
= ((wxWindow
*)*node
)->GetId();
3896 m_wndEditor2
->SetSizeHints(3,3);
3898 m_wndEditor2
->Show();
3900 SetupChildEventHandling(m_wndEditor2
);
3902 // If no primary editor, focus to button to allow
3903 // it to interprete ENTER etc.
3904 // NOTE: Due to problems focusing away from it, this
3905 // has been disabled.
3907 if ( (flags & wxPG_SEL_FOCUS) && !m_wndEditor )
3908 m_wndEditor2->SetFocus();
3912 if ( flags
& wxPG_SEL_FOCUS
)
3913 m_editorFocused
= 1;
3918 // Make sure focus is in grid canvas (important for wxGTK,
3923 EditorsValueWasNotModified();
3925 // If it's inside collapsed section, expand parent, scroll, etc.
3926 // Also, if it was partially visible, scroll it into view.
3927 if ( !(flags
& wxPG_SEL_NONVISIBLE
) )
3932 m_wndEditor
->Show(true);
3935 if ( !(flags
& wxPG_SEL_NO_REFRESH
) )
3940 // Make sure focus is in grid canvas
3944 ClearInternalFlag(wxPG_FL_IN_SELECT_PROPERTY
);
3950 // Show help text in status bar.
3951 // (if found and grid not embedded in manager with help box and
3952 // style wxPG_EX_HELP_AS_TOOLTIPS is not used).
3955 if ( !(GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS
) )
3957 wxStatusBar
* statusbar
= NULL
;
3958 if ( !(m_iFlags
& wxPG_FL_NOSTATUSBARHELP
) )
3960 wxFrame
* frame
= wxDynamicCast(::wxGetTopLevelParent(this),wxFrame
);
3962 statusbar
= frame
->GetStatusBar();
3967 const wxString
* pHelpString
= (const wxString
*) NULL
;
3971 pHelpString
= &p
->GetHelpString();
3972 if ( pHelpString
->length() )
3974 // Set help box text.
3975 statusbar
->SetStatusText( *pHelpString
);
3976 m_iFlags
|= wxPG_FL_STRING_IN_STATUSBAR
;
3980 if ( (!pHelpString
|| !pHelpString
->length()) &&
3981 (m_iFlags
& wxPG_FL_STRING_IN_STATUSBAR
) )
3983 // Clear help box - but only if it was written
3984 // by us at previous time.
3985 statusbar
->SetStatusText( m_emptyString
);
3986 m_iFlags
&= ~(wxPG_FL_STRING_IN_STATUSBAR
);
3992 m_inDoSelectProperty
= 0;
3994 // call wx event handler (here so that it also occurs on deselection)
3995 if ( !(flags
& wxPG_SEL_DONT_SEND_EVENT
) )
3996 SendEvent( wxEVT_PG_SELECTED
, p
, NULL
);
4001 // -----------------------------------------------------------------------
4003 bool wxPropertyGrid::UnfocusEditor()
4005 wxPGProperty
* selected
= GetSelection();
4007 if ( !selected
|| !m_wndEditor
|| m_frozen
)
4010 if ( !CommitChangesFromEditor(0) )
4019 // -----------------------------------------------------------------------
4021 void wxPropertyGrid::RefreshEditor()
4023 wxPGProperty
* p
= GetSelection();
4027 wxWindow
* wnd
= GetEditorControl();
4031 // Set editor font boldness - must do this before
4032 // calling UpdateControl().
4033 if ( HasFlag(wxPG_BOLD_MODIFIED
) )
4035 if ( p
->HasFlag(wxPG_PROP_MODIFIED
) )
4036 wnd
->SetFont(GetCaptionFont());
4038 wnd
->SetFont(GetFont());
4041 const wxPGEditor
* editorClass
= p
->GetEditorClass();
4043 editorClass
->UpdateControl(p
, wnd
);
4045 if ( p
->IsValueUnspecified() )
4046 editorClass
->SetValueToUnspecified(p
, wnd
);
4049 // -----------------------------------------------------------------------
4051 bool wxPropertyGrid::SelectProperty( wxPGPropArg id
, bool focus
)
4053 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
4055 int flags
= wxPG_SEL_DONT_SEND_EVENT
;
4057 flags
|= wxPG_SEL_FOCUS
;
4059 return DoSelectProperty(p
, flags
);
4062 // -----------------------------------------------------------------------
4063 // wxPropertyGrid expand/collapse state
4064 // -----------------------------------------------------------------------
4066 bool wxPropertyGrid::DoCollapse( wxPGProperty
* p
, bool sendEvents
)
4068 wxPGProperty
* pwc
= wxStaticCast(p
, wxPGProperty
);
4069 wxPGProperty
* selected
= GetSelection();
4071 // If active editor was inside collapsed section, then disable it
4072 if ( selected
&& selected
->IsSomeParent(p
) )
4077 // Store dont-center-splitter flag 'cause we need to temporarily set it
4078 wxUint32 old_flag
= m_iFlags
& wxPG_FL_DONT_CENTER_SPLITTER
;
4079 m_iFlags
|= wxPG_FL_DONT_CENTER_SPLITTER
;
4081 bool res
= m_pState
->DoCollapse(pwc
);
4086 SendEvent( wxEVT_PG_ITEM_COLLAPSED
, p
);
4088 RecalculateVirtualSize();
4090 // Redraw etc. only if collapsed was visible.
4091 if (pwc
->IsVisible() &&
4093 ( !pwc
->IsCategory() || !(m_windowStyle
& wxPG_HIDE_CATEGORIES
) ) )
4095 // When item is collapsed so that scrollbar would move,
4096 // graphics mess is about (unless we redraw everything).
4101 // Clear dont-center-splitter flag if it wasn't set
4102 m_iFlags
= (m_iFlags
& ~wxPG_FL_DONT_CENTER_SPLITTER
) | old_flag
;
4107 // -----------------------------------------------------------------------
4109 bool wxPropertyGrid::DoExpand( wxPGProperty
* p
, bool sendEvents
)
4111 wxCHECK_MSG( p
, false, wxT("invalid property id") );
4113 wxPGProperty
* pwc
= (wxPGProperty
*)p
;
4115 // Store dont-center-splitter flag 'cause we need to temporarily set it
4116 wxUint32 old_flag
= m_iFlags
& wxPG_FL_DONT_CENTER_SPLITTER
;
4117 m_iFlags
|= wxPG_FL_DONT_CENTER_SPLITTER
;
4119 bool res
= m_pState
->DoExpand(pwc
);
4124 SendEvent( wxEVT_PG_ITEM_EXPANDED
, p
);
4126 RecalculateVirtualSize();
4128 // Redraw etc. only if expanded was visible.
4129 if ( pwc
->IsVisible() && !m_frozen
&&
4130 ( !pwc
->IsCategory() || !(m_windowStyle
& wxPG_HIDE_CATEGORIES
) )
4134 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4137 DrawItems(pwc
, NULL
);
4142 // Clear dont-center-splitter flag if it wasn't set
4143 m_iFlags
= (m_iFlags
& ~wxPG_FL_DONT_CENTER_SPLITTER
) | old_flag
;
4148 // -----------------------------------------------------------------------
4150 bool wxPropertyGrid::DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
)
4153 return m_pState
->DoHideProperty(p
, hide
, flags
);
4155 wxArrayPGProperty selection
= m_pState
->m_selection
; // Must use a copy
4156 int selRemoveCount
= 0;
4157 for ( unsigned int i
=0; i
<selection
.size(); i
++ )
4159 wxPGProperty
* selected
= selection
[i
];
4160 if ( selected
== p
|| selected
->IsSomeParent(p
) )
4162 if ( !DoRemoveFromSelection(p
, flags
) )
4164 selRemoveCount
+= 1;
4168 m_pState
->DoHideProperty(p
, hide
, flags
);
4170 RecalculateVirtualSize();
4177 // -----------------------------------------------------------------------
4178 // wxPropertyGrid size related methods
4179 // -----------------------------------------------------------------------
4181 void wxPropertyGrid::RecalculateVirtualSize( int forceXPos
)
4183 if ( (m_iFlags
& wxPG_FL_RECALCULATING_VIRTUAL_SIZE
) || m_frozen
)
4187 // If virtual height was changed, then recalculate editor control position(s)
4188 if ( m_pState
->m_vhCalcPending
)
4189 CorrectEditorWidgetPosY();
4191 m_pState
->EnsureVirtualHeight();
4193 wxASSERT_LEVEL_2_MSG(
4194 m_pState
->GetVirtualHeight() == m_pState
->GetActualVirtualHeight(),
4195 "VirtualHeight and ActualVirtualHeight should match"
4198 m_iFlags
|= wxPG_FL_RECALCULATING_VIRTUAL_SIZE
;
4200 int x
= m_pState
->m_width
;
4201 int y
= m_pState
->m_virtualHeight
;
4204 GetClientSize(&width
,&height
);
4206 // Now adjust virtual size.
4207 SetVirtualSize(x
, y
);
4213 // Adjust scrollbars
4214 if ( HasVirtualWidth() )
4216 xAmount
= x
/wxPG_PIXELS_PER_UNIT
;
4217 xPos
= GetScrollPos( wxHORIZONTAL
);
4220 if ( forceXPos
!= -1 )
4223 else if ( xPos
> (xAmount
-(width
/wxPG_PIXELS_PER_UNIT
)) )
4226 int yAmount
= y
/ wxPG_PIXELS_PER_UNIT
;
4227 int yPos
= GetScrollPos( wxVERTICAL
);
4229 SetScrollbars( wxPG_PIXELS_PER_UNIT
, wxPG_PIXELS_PER_UNIT
,
4230 xAmount
, yAmount
, xPos
, yPos
, true );
4232 // Must re-get size now
4233 GetClientSize(&width
,&height
);
4235 if ( !HasVirtualWidth() )
4237 m_pState
->SetVirtualWidth(width
);
4244 m_pState
->CheckColumnWidths();
4246 if ( GetSelection() )
4247 CorrectEditorWidgetSizeX();
4249 m_iFlags
&= ~wxPG_FL_RECALCULATING_VIRTUAL_SIZE
;
4252 // -----------------------------------------------------------------------
4254 void wxPropertyGrid::OnResize( wxSizeEvent
& event
)
4256 if ( !(m_iFlags
& wxPG_FL_INITIALIZED
) )
4260 GetClientSize(&width
, &height
);
4265 #if wxPG_DOUBLE_BUFFER
4266 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING
) )
4268 int dblh
= (m_lineHeight
*2);
4269 if ( !m_doubleBuffer
)
4271 // Create double buffer bitmap to draw on, if none
4272 int w
= (width
>250)?width
:250;
4273 int h
= height
+ dblh
;
4275 m_doubleBuffer
= new wxBitmap( w
, h
);
4279 int w
= m_doubleBuffer
->GetWidth();
4280 int h
= m_doubleBuffer
->GetHeight();
4282 // Double buffer must be large enough
4283 if ( w
< width
|| h
< (height
+dblh
) )
4285 if ( w
< width
) w
= width
;
4286 if ( h
< (height
+dblh
) ) h
= height
+ dblh
;
4287 delete m_doubleBuffer
;
4288 m_doubleBuffer
= new wxBitmap( w
, h
);
4295 m_pState
->OnClientWidthChange( width
, event
.GetSize().x
- m_ncWidth
, true );
4296 m_ncWidth
= event
.GetSize().x
;
4300 if ( m_pState
->m_itemsAdded
)
4301 PrepareAfterItemsAdded();
4303 // Without this, virtual size (atleast under wxGTK) will be skewed
4304 RecalculateVirtualSize();
4310 // -----------------------------------------------------------------------
4312 void wxPropertyGrid::SetVirtualWidth( int width
)
4316 // Disable virtual width
4317 width
= GetClientSize().x
;
4318 ClearInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH
);
4322 // Enable virtual width
4323 SetInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH
);
4325 m_pState
->SetVirtualWidth( width
);
4328 void wxPropertyGrid::SetFocusOnCanvas()
4330 SetFocusIgnoringChildren();
4331 m_editorFocused
= 0;
4334 // -----------------------------------------------------------------------
4335 // wxPropertyGrid mouse event handling
4336 // -----------------------------------------------------------------------
4338 // selFlags uses same values DoSelectProperty's flags
4339 // Returns true if event was vetoed.
4340 bool wxPropertyGrid::SendEvent( int eventType
, wxPGProperty
* p
,
4342 unsigned int selFlags
,
4343 unsigned int column
)
4345 // Send property grid event of specific type and with specific property
4346 wxPropertyGridEvent
evt( eventType
, m_eventObject
->GetId() );
4347 evt
.SetPropertyGrid(this);
4348 evt
.SetEventObject(m_eventObject
);
4350 evt
.SetColumn(column
);
4351 if ( eventType
== wxEVT_PG_CHANGING
)
4354 evt
.SetCanVeto(true);
4355 m_validationInfo
.m_pValue
= pValue
;
4356 evt
.SetupValidationInfo();
4361 evt
.SetPropertyValue(p
->GetValue());
4363 if ( !(selFlags
& wxPG_SEL_NOVALIDATE
) )
4364 evt
.SetCanVeto(true);
4367 m_processedEvent
= &evt
;
4368 m_eventObject
->HandleWindowEvent(evt
);
4369 m_processedEvent
= NULL
;
4371 return evt
.WasVetoed();
4374 // -----------------------------------------------------------------------
4376 // Return false if should be skipped
4377 bool wxPropertyGrid::HandleMouseClick( int x
, unsigned int y
, wxMouseEvent
&event
)
4381 // Need to set focus?
4382 if ( !(m_iFlags
& wxPG_FL_FOCUSED
) )
4387 wxPropertyGridPageState
* state
= m_pState
;
4389 int splitterHitOffset
;
4390 int columnHit
= state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4392 wxPGProperty
* p
= DoGetItemAtY(y
);
4396 int depth
= (int)p
->GetDepth() - 1;
4398 int marginEnds
= m_marginWidth
+ ( depth
* m_subgroup_extramargin
);
4400 if ( x
>= marginEnds
)
4404 if ( p
->IsCategory() )
4406 // This is category.
4407 wxPropertyCategory
* pwc
= (wxPropertyCategory
*)p
;
4409 int textX
= m_marginWidth
+ ((unsigned int)((pwc
->m_depth
-1)*m_subgroup_extramargin
));
4411 // Expand, collapse, activate etc. if click on text or left of splitter.
4414 ( x
< (textX
+pwc
->GetTextExtent(this, m_captionFont
)+(wxPG_CAPRECTXMARGIN
*2)) ||
4419 if ( !AddToSelectionFromInputEvent( p
,
4424 // On double-click, expand/collapse.
4425 if ( event
.ButtonDClick() && !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
4427 if ( pwc
->IsExpanded() ) DoCollapse( p
, true );
4428 else DoExpand( p
, true );
4432 else if ( splitterHit
== -1 )
4435 unsigned int selFlag
= 0;
4436 if ( columnHit
== 1 )
4438 m_iFlags
|= wxPG_FL_ACTIVATION_BY_CLICK
;
4439 selFlag
= wxPG_SEL_FOCUS
;
4441 if ( !AddToSelectionFromInputEvent( p
,
4447 m_iFlags
&= ~(wxPG_FL_ACTIVATION_BY_CLICK
);
4449 if ( p
->GetChildCount() && !p
->IsCategory() )
4450 // On double-click, expand/collapse.
4451 if ( event
.ButtonDClick() && !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
4453 wxPGProperty
* pwc
= (wxPGProperty
*)p
;
4454 if ( pwc
->IsExpanded() ) DoCollapse( p
, true );
4455 else DoExpand( p
, true );
4462 // click on splitter
4463 if ( !(m_windowStyle
& wxPG_STATIC_SPLITTER
) )
4465 if ( event
.GetEventType() == wxEVT_LEFT_DCLICK
)
4467 // Double-clicking the splitter causes auto-centering
4468 CenterSplitter( true );
4470 else if ( m_dragStatus
== 0 )
4473 // Begin draggin the splitter
4477 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
);
4481 // Changes must be committed here or the
4482 // value won't be drawn correctly
4483 if ( !CommitChangesFromEditor() )
4486 m_wndEditor
->Show ( false );
4489 if ( !(m_iFlags
& wxPG_FL_MOUSE_CAPTURED
) )
4492 m_iFlags
|= wxPG_FL_MOUSE_CAPTURED
;
4496 m_draggedSplitter
= splitterHit
;
4497 m_dragOffset
= splitterHitOffset
;
4499 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4500 // Fixes button disappearance bug
4502 m_wndEditor2
->Show ( false );
4505 m_startingSplitterX
= x
- splitterHitOffset
;
4513 if ( p
->GetChildCount() )
4515 int nx
= x
+ m_marginWidth
- marginEnds
; // Normalize x.
4517 if ( (nx
>= m_gutterWidth
&& nx
< (m_gutterWidth
+m_iconWidth
)) )
4519 int y2
= y
% m_lineHeight
;
4520 if ( (y2
>= m_buttonSpacingY
&& y2
< (m_buttonSpacingY
+m_iconHeight
)) )
4522 // On click on expander button, expand/collapse
4523 if ( ((wxPGProperty
*)p
)->IsExpanded() )
4524 DoCollapse( p
, true );
4526 DoExpand( p
, true );
4535 // -----------------------------------------------------------------------
4537 bool wxPropertyGrid::HandleMouseRightClick( int WXUNUSED(x
),
4538 unsigned int WXUNUSED(y
),
4539 wxMouseEvent
& event
)
4543 // Select property here as well
4544 wxPGProperty
* p
= m_propHover
;
4545 AddToSelectionFromInputEvent(p
, m_colHover
, &event
);
4547 // Send right click event.
4548 SendEvent( wxEVT_PG_RIGHT_CLICK
, p
);
4555 // -----------------------------------------------------------------------
4557 bool wxPropertyGrid::HandleMouseDoubleClick( int WXUNUSED(x
),
4558 unsigned int WXUNUSED(y
),
4559 wxMouseEvent
& event
)
4563 // Select property here as well
4564 wxPGProperty
* p
= m_propHover
;
4566 AddToSelectionFromInputEvent(p
, m_colHover
, &event
);
4568 // Send double-click event.
4569 SendEvent( wxEVT_PG_DOUBLE_CLICK
, m_propHover
);
4576 // -----------------------------------------------------------------------
4578 #if wxPG_SUPPORT_TOOLTIPS
4580 void wxPropertyGrid::SetToolTip( const wxString
& tipString
)
4582 if ( tipString
.length() )
4584 wxScrolledWindow::SetToolTip(tipString
);
4588 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4589 wxScrolledWindow::SetToolTip( m_emptyString
);
4591 wxScrolledWindow::SetToolTip( NULL
);
4596 #endif // #if wxPG_SUPPORT_TOOLTIPS
4598 // -----------------------------------------------------------------------
4600 // Return false if should be skipped
4601 bool wxPropertyGrid::HandleMouseMove( int x
, unsigned int y
,
4602 wxMouseEvent
&event
)
4604 // Safety check (needed because mouse capturing may
4605 // otherwise freeze the control)
4606 if ( m_dragStatus
> 0 && !event
.Dragging() )
4608 HandleMouseUp(x
, y
, event
);
4611 wxPropertyGridPageState
* state
= m_pState
;
4613 int splitterHitOffset
;
4614 int columnHit
= state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4615 int splitterX
= x
- splitterHitOffset
;
4617 m_colHover
= columnHit
;
4619 if ( m_dragStatus
> 0 )
4621 if ( x
> (m_marginWidth
+ wxPG_DRAG_MARGIN
) &&
4622 x
< (m_pState
->m_width
- wxPG_DRAG_MARGIN
) )
4625 int newSplitterX
= x
- m_dragOffset
;
4626 int splitterX
= x
- splitterHitOffset
;
4628 // Splitter redraw required?
4629 if ( newSplitterX
!= splitterX
)
4632 SetInternalFlag(wxPG_FL_DONT_CENTER_SPLITTER
);
4633 state
->DoSetSplitterPosition(newSplitterX
,
4636 state
->m_fSplitterX
= (float) newSplitterX
;
4638 if ( GetSelection() )
4639 CorrectEditorWidgetSizeX();
4653 int ih
= m_lineHeight
;
4656 #if wxPG_SUPPORT_TOOLTIPS
4657 wxPGProperty
* prevHover
= m_propHover
;
4658 unsigned char prevSide
= m_mouseSide
;
4660 int curPropHoverY
= y
- (y
% ih
);
4662 // On which item it hovers
4665 ( sy
< m_propHoverY
|| sy
>= (m_propHoverY
+ih
) )
4668 // Mouse moves on another property
4670 m_propHover
= DoGetItemAtY(y
);
4671 m_propHoverY
= curPropHoverY
;
4674 SendEvent( wxEVT_PG_HIGHLIGHTED
, m_propHover
);
4677 #if wxPG_SUPPORT_TOOLTIPS
4678 // Store which side we are on
4680 if ( columnHit
== 1 )
4682 else if ( columnHit
== 0 )
4686 // If tooltips are enabled, show label or value as a tip
4687 // in case it doesn't otherwise show in full length.
4689 if ( m_windowStyle
& wxPG_TOOLTIPS
)
4691 wxToolTip
* tooltip
= GetToolTip();
4693 if ( m_propHover
!= prevHover
|| prevSide
!= m_mouseSide
)
4695 if ( m_propHover
&& !m_propHover
->IsCategory() )
4698 if ( GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS
)
4700 // Show help string as a tooltip
4701 wxString tipString
= m_propHover
->GetHelpString();
4703 SetToolTip(tipString
);
4707 // Show cropped value string as a tooltip
4711 if ( m_mouseSide
== 1 )
4713 tipString
= m_propHover
->m_label
;
4714 space
= splitterX
-m_marginWidth
-3;
4716 else if ( m_mouseSide
== 2 )
4718 tipString
= m_propHover
->GetDisplayedString();
4720 space
= m_width
- splitterX
;
4721 if ( m_propHover
->m_flags
& wxPG_PROP_CUSTOMIMAGE
)
4722 space
-= wxPG_CUSTOM_IMAGE_WIDTH
+
4723 wxCC_CUSTOM_IMAGE_MARGIN1
+
4724 wxCC_CUSTOM_IMAGE_MARGIN2
;
4730 GetTextExtent( tipString
, &tw
, &th
, 0, 0 );
4733 SetToolTip( tipString
);
4740 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4741 SetToolTip( m_emptyString
);
4743 wxScrolledWindow::SetToolTip( NULL
);
4754 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4755 SetToolTip( m_emptyString
);
4757 wxScrolledWindow::SetToolTip( NULL
);
4765 if ( splitterHit
== -1 ||
4767 HasFlag(wxPG_STATIC_SPLITTER
) )
4769 // hovering on something else
4770 if ( m_curcursor
!= wxCURSOR_ARROW
)
4771 CustomSetCursor( wxCURSOR_ARROW
);
4775 // Do not allow splitter cursor on caption items.
4776 // (also not if we were dragging and its started
4777 // outside the splitter region)
4779 if ( !m_propHover
->IsCategory() &&
4783 // hovering on splitter
4785 // NB: Condition disabled since MouseLeave event (from the
4786 // editor control) cannot be reliably detected.
4787 //if ( m_curcursor != wxCURSOR_SIZEWE )
4788 CustomSetCursor( wxCURSOR_SIZEWE
, true );
4794 // hovering on something else
4795 if ( m_curcursor
!= wxCURSOR_ARROW
)
4796 CustomSetCursor( wxCURSOR_ARROW
);
4801 // Multi select by dragging
4803 if ( (GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
) &&
4804 event
.LeftIsDown() &&
4808 !state
->DoIsPropertySelected(m_propHover
) )
4810 // Additional requirement is that the hovered property
4811 // is adjacent to edges of selection.
4812 const wxArrayPGProperty
& selection
= GetSelectedProperties();
4814 // Since categories cannot be selected along with 'other'
4815 // properties, exclude them from iterator flags.
4816 int iterFlags
= wxPG_ITERATE_VISIBLE
& (~wxPG_PROP_CATEGORY
);
4818 for ( int i
=(selection
.size()-1); i
>=0; i
-- )
4820 // TODO: This could be optimized by keeping track of
4821 // which properties are at the edges of selection.
4822 wxPGProperty
* selProp
= selection
[i
];
4823 if ( state
->ArePropertiesAdjacent(m_propHover
, selProp
,
4826 DoAddToSelection(m_propHover
);
4835 // -----------------------------------------------------------------------
4837 // Also handles Leaving event
4838 bool wxPropertyGrid::HandleMouseUp( int x
, unsigned int WXUNUSED(y
),
4839 wxMouseEvent
&WXUNUSED(event
) )
4841 wxPropertyGridPageState
* state
= m_pState
;
4845 int splitterHitOffset
;
4846 state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4848 // No event type check - basicly calling this method should
4849 // just stop dragging.
4850 // Left up after dragged?
4851 if ( m_dragStatus
>= 1 )
4854 // End Splitter Dragging
4856 // DO NOT ENABLE FOLLOWING LINE!
4857 // (it is only here as a reminder to not to do it)
4860 // Disable splitter auto-centering
4861 m_iFlags
|= wxPG_FL_DONT_CENTER_SPLITTER
;
4863 // This is necessary to return cursor
4864 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
4867 m_iFlags
&= ~(wxPG_FL_MOUSE_CAPTURED
);
4870 // Set back the default cursor, if necessary
4871 if ( splitterHit
== -1 ||
4874 CustomSetCursor( wxCURSOR_ARROW
);
4879 // Control background needs to be cleared
4880 wxPGProperty
* selected
= GetSelection();
4881 if ( !(m_iFlags
& wxPG_FL_PRIMARY_FILLS_ENTIRE
) && selected
)
4882 DrawItem( selected
);
4886 m_wndEditor
->Show ( true );
4889 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4890 // Fixes button disappearance bug
4892 m_wndEditor2
->Show ( true );
4895 // This clears the focus.
4896 m_editorFocused
= 0;
4902 // -----------------------------------------------------------------------
4904 bool wxPropertyGrid::OnMouseCommon( wxMouseEvent
& event
, int* px
, int* py
)
4906 int splitterX
= GetSplitterPosition();
4909 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &ux
, &uy
);
4911 wxWindow
* wnd
= GetEditorControl();
4913 // Hide popup on clicks
4914 if ( event
.GetEventType() != wxEVT_MOTION
)
4915 if ( wnd
&& wnd
->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox
)) )
4917 ((wxOwnerDrawnComboBox
*)wnd
)->HidePopup();
4923 if ( wnd
== NULL
|| m_dragStatus
||
4925 ux
<= (splitterX
+ wxPG_SPLITTERX_DETECTMARGIN2
) ||
4926 ux
>= (r
.x
+r
.width
) ||
4928 event
.m_y
>= (r
.y
+r
.height
)
4938 if ( m_curcursor
!= wxCURSOR_ARROW
) CustomSetCursor ( wxCURSOR_ARROW
);
4943 // -----------------------------------------------------------------------
4945 void wxPropertyGrid::OnMouseClick( wxMouseEvent
&event
)
4948 if ( OnMouseCommon( event
, &x
, &y
) )
4950 HandleMouseClick(x
,y
,event
);
4955 // -----------------------------------------------------------------------
4957 void wxPropertyGrid::OnMouseRightClick( wxMouseEvent
&event
)
4960 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &x
, &y
);
4961 HandleMouseRightClick(x
,y
,event
);
4965 // -----------------------------------------------------------------------
4967 void wxPropertyGrid::OnMouseDoubleClick( wxMouseEvent
&event
)
4969 // Always run standard mouse-down handler as well
4970 OnMouseClick(event
);
4973 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &x
, &y
);
4974 HandleMouseDoubleClick(x
,y
,event
);
4978 // -----------------------------------------------------------------------
4980 void wxPropertyGrid::OnMouseMove( wxMouseEvent
&event
)
4983 if ( OnMouseCommon( event
, &x
, &y
) )
4985 HandleMouseMove(x
,y
,event
);
4990 // -----------------------------------------------------------------------
4992 void wxPropertyGrid::OnMouseUp( wxMouseEvent
&event
)
4995 if ( OnMouseCommon( event
, &x
, &y
) )
4997 HandleMouseUp(x
,y
,event
);
5002 // -----------------------------------------------------------------------
5004 void wxPropertyGrid::OnMouseEntry( wxMouseEvent
&event
)
5006 // This may get called from child control as well, so event's
5007 // mouse position cannot be relied on.
5009 if ( event
.Entering() )
5011 if ( !(m_iFlags
& wxPG_FL_MOUSE_INSIDE
) )
5013 // TODO: Fix this (detect parent and only do
5014 // cursor trick if it is a manager).
5015 wxASSERT( GetParent() );
5016 GetParent()->SetCursor(wxNullCursor
);
5018 m_iFlags
|= wxPG_FL_MOUSE_INSIDE
;
5021 GetParent()->SetCursor(wxNullCursor
);
5023 else if ( event
.Leaving() )
5025 // Without this, wxSpinCtrl editor will sometimes have wrong cursor
5026 SetCursor( wxNullCursor
);
5028 // Get real cursor position
5029 wxPoint pt
= ScreenToClient(::wxGetMousePosition());
5031 if ( ( pt
.x
<= 0 || pt
.y
<= 0 || pt
.x
>= m_width
|| pt
.y
>= m_height
) )
5034 if ( (m_iFlags
& wxPG_FL_MOUSE_INSIDE
) )
5036 m_iFlags
&= ~(wxPG_FL_MOUSE_INSIDE
);
5040 wxPropertyGrid::HandleMouseUp ( -1, 10000, event
);
5048 // -----------------------------------------------------------------------
5050 // Common code used by various OnMouseXXXChild methods.
5051 bool wxPropertyGrid::OnMouseChildCommon( wxMouseEvent
&event
, int* px
, int *py
)
5053 wxWindow
* topCtrlWnd
= (wxWindow
*)event
.GetEventObject();
5054 wxASSERT( topCtrlWnd
);
5056 event
.GetPosition(&x
,&y
);
5058 int splitterX
= GetSplitterPosition();
5060 wxRect r
= topCtrlWnd
->GetRect();
5061 if ( !m_dragStatus
&&
5062 x
> (splitterX
-r
.x
+wxPG_SPLITTERX_DETECTMARGIN2
) &&
5063 y
>= 0 && y
< r
.height \
5066 if ( m_curcursor
!= wxCURSOR_ARROW
) CustomSetCursor ( wxCURSOR_ARROW
);
5071 CalcUnscrolledPosition( event
.m_x
+ r
.x
, event
.m_y
+ r
.y
, \
5078 void wxPropertyGrid::OnMouseClickChild( wxMouseEvent
&event
)
5081 if ( OnMouseChildCommon(event
,&x
,&y
) )
5083 bool res
= HandleMouseClick(x
,y
,event
);
5084 if ( !res
) event
.Skip();
5088 void wxPropertyGrid::OnMouseRightClickChild( wxMouseEvent
&event
)
5091 wxASSERT( m_wndEditor
);
5092 // These coords may not be exact (about +-2),
5093 // but that should not matter (right click is about item, not position).
5094 wxPoint pt
= m_wndEditor
->GetPosition();
5095 CalcUnscrolledPosition( event
.m_x
+ pt
.x
, event
.m_y
+ pt
.y
, &x
, &y
);
5097 // FIXME: Used to set m_propHover to selection here. Was it really
5100 bool res
= HandleMouseRightClick(x
,y
,event
);
5101 if ( !res
) event
.Skip();
5104 void wxPropertyGrid::OnMouseMoveChild( wxMouseEvent
&event
)
5107 if ( OnMouseChildCommon(event
,&x
,&y
) )
5109 bool res
= HandleMouseMove(x
,y
,event
);
5110 if ( !res
) event
.Skip();
5114 void wxPropertyGrid::OnMouseUpChild( wxMouseEvent
&event
)
5117 if ( OnMouseChildCommon(event
,&x
,&y
) )
5119 bool res
= HandleMouseUp(x
,y
,event
);
5120 if ( !res
) event
.Skip();
5124 // -----------------------------------------------------------------------
5125 // wxPropertyGrid keyboard event handling
5126 // -----------------------------------------------------------------------
5128 int wxPropertyGrid::KeyEventToActions(wxKeyEvent
&event
, int* pSecond
) const
5130 // Translates wxKeyEvent to wxPG_ACTION_XXX
5132 int keycode
= event
.GetKeyCode();
5133 int modifiers
= event
.GetModifiers();
5135 wxASSERT( !(modifiers
&~(0xFFFF)) );
5137 int hashMapKey
= (keycode
& 0xFFFF) | ((modifiers
& 0xFFFF) << 16);
5139 wxPGHashMapI2I::const_iterator it
= m_actionTriggers
.find(hashMapKey
);
5141 if ( it
== m_actionTriggers
.end() )
5146 int second
= (it
->second
>>16) & 0xFFFF;
5150 return (it
->second
& 0xFFFF);
5153 void wxPropertyGrid::AddActionTrigger( int action
, int keycode
, int modifiers
)
5155 wxASSERT( !(modifiers
&~(0xFFFF)) );
5157 int hashMapKey
= (keycode
& 0xFFFF) | ((modifiers
& 0xFFFF) << 16);
5159 wxPGHashMapI2I::iterator it
= m_actionTriggers
.find(hashMapKey
);
5161 if ( it
!= m_actionTriggers
.end() )
5163 // This key combination is already used
5165 // Can add secondary?
5166 wxASSERT_MSG( !(it
->second
&~(0xFFFF)),
5167 wxT("You can only add up to two separate actions per key combination.") );
5169 action
= it
->second
| (action
<<16);
5172 m_actionTriggers
[hashMapKey
] = action
;
5175 void wxPropertyGrid::ClearActionTriggers( int action
)
5177 wxPGHashMapI2I::iterator it
;
5182 didSomething
= false;
5184 for ( it
= m_actionTriggers
.begin();
5185 it
!= m_actionTriggers
.end();
5188 if ( it
->second
== action
)
5190 m_actionTriggers
.erase(it
);
5191 didSomething
= true;
5196 while ( didSomething
);
5199 void wxPropertyGrid::HandleKeyEvent( wxKeyEvent
&event
, bool fromChild
)
5202 // Handles key event when editor control is not focused.
5205 wxCHECK2(!m_frozen
, return);
5207 // Travelsal between items, collapsing/expanding, etc.
5208 wxPGProperty
* selected
= GetSelection();
5209 int keycode
= event
.GetKeyCode();
5210 bool editorFocused
= IsEditorFocused();
5212 if ( keycode
== WXK_TAB
)
5214 wxWindow
* mainControl
;
5216 if ( HasInternalFlag(wxPG_FL_IN_MANAGER
) )
5217 mainControl
= GetParent();
5221 if ( !event
.ShiftDown() )
5223 if ( !editorFocused
&& m_wndEditor
)
5225 DoSelectProperty( selected
, wxPG_SEL_FOCUS
);
5229 // Tab traversal workaround for platforms on which
5230 // wxWindow::Navigate() may navigate into first child
5231 // instead of next sibling. Does not work perfectly
5232 // in every scenario (for instance, when property grid
5233 // is either first or last control).
5234 #if defined(__WXGTK__)
5235 wxWindow
* sibling
= mainControl
->GetNextSibling();
5237 sibling
->SetFocusFromKbd();
5239 Navigate(wxNavigationKeyEvent::IsForward
);
5245 if ( editorFocused
)
5251 #if defined(__WXGTK__)
5252 wxWindow
* sibling
= mainControl
->GetPrevSibling();
5254 sibling
->SetFocusFromKbd();
5256 Navigate(wxNavigationKeyEvent::IsBackward
);
5264 // Ignore Alt and Control when they are down alone
5265 if ( keycode
== WXK_ALT
||
5266 keycode
== WXK_CONTROL
)
5273 int action
= KeyEventToActions(event
, &secondAction
);
5275 if ( editorFocused
&& action
== wxPG_ACTION_CANCEL_EDIT
)
5278 // Esc cancels any changes
5279 if ( IsEditorsValueModified() )
5281 EditorsValueWasNotModified();
5283 // Update the control as well
5284 selected
->GetEditorClass()->
5285 SetControlStringValue( selected
,
5287 selected
->GetDisplayedString() );
5290 OnValidationFailureReset(selected
);
5296 // Except for TAB and ESC, handle child control events in child control
5299 // Only propagate event if it had modifiers
5300 if ( !event
.HasModifiers() )
5302 event
.StopPropagation();
5308 bool wasHandled
= false;
5313 if ( ButtonTriggerKeyTest(action
, event
) )
5316 wxPGProperty
* p
= selected
;
5318 // Travel and expand/collapse
5321 if ( p
->GetChildCount() )
5323 if ( action
== wxPG_ACTION_COLLAPSE_PROPERTY
|| secondAction
== wxPG_ACTION_COLLAPSE_PROPERTY
)
5325 if ( (m_windowStyle
& wxPG_HIDE_MARGIN
) || Collapse(p
) )
5328 else if ( action
== wxPG_ACTION_EXPAND_PROPERTY
|| secondAction
== wxPG_ACTION_EXPAND_PROPERTY
)
5330 if ( (m_windowStyle
& wxPG_HIDE_MARGIN
) || Expand(p
) )
5337 if ( action
== wxPG_ACTION_PREV_PROPERTY
|| secondAction
== wxPG_ACTION_PREV_PROPERTY
)
5341 else if ( action
== wxPG_ACTION_NEXT_PROPERTY
|| secondAction
== wxPG_ACTION_NEXT_PROPERTY
)
5347 if ( selectDir
>= -1 )
5349 p
= wxPropertyGridIterator::OneStep( m_pState
, wxPG_ITERATE_VISIBLE
, p
, selectDir
);
5351 DoSelectProperty(p
);
5357 // If nothing was selected, select the first item now
5358 // (or navigate out of tab).
5359 if ( action
!= wxPG_ACTION_CANCEL_EDIT
&& secondAction
!= wxPG_ACTION_CANCEL_EDIT
)
5361 wxPGProperty
* p
= wxPropertyGridInterface::GetFirst();
5362 if ( p
) DoSelectProperty(p
);
5371 // -----------------------------------------------------------------------
5373 void wxPropertyGrid::OnKey( wxKeyEvent
&event
)
5375 // If there was editor open and focused, then this event should not
5376 // really be processed here.
5377 if ( IsEditorFocused() )
5379 // However, if event had modifiers, it is probably still best
5381 if ( event
.HasModifiers() )
5384 event
.StopPropagation();
5388 HandleKeyEvent(event
, false);
5391 // -----------------------------------------------------------------------
5393 bool wxPropertyGrid::ButtonTriggerKeyTest( int action
, wxKeyEvent
& event
)
5398 action
= KeyEventToActions(event
, &secondAction
);
5401 // Does the keycode trigger button?
5402 if ( action
== wxPG_ACTION_PRESS_BUTTON
&&
5405 wxCommandEvent
evt(wxEVT_COMMAND_BUTTON_CLICKED
, m_wndEditor2
->GetId());
5406 GetEventHandler()->AddPendingEvent(evt
);
5413 // -----------------------------------------------------------------------
5415 void wxPropertyGrid::OnChildKeyDown( wxKeyEvent
&event
)
5417 HandleKeyEvent(event
, true);
5420 // -----------------------------------------------------------------------
5421 // wxPropertyGrid miscellaneous event handling
5422 // -----------------------------------------------------------------------
5424 void wxPropertyGrid::OnIdle( wxIdleEvent
& WXUNUSED(event
) )
5427 // Check if the focus is in this control or one of its children
5428 wxWindow
* newFocused
= wxWindow::FindFocus();
5430 if ( newFocused
!= m_curFocused
)
5431 HandleFocusChange( newFocused
);
5434 // Check if top-level parent has changed
5435 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING
)
5437 wxWindow
* tlp
= ::wxGetTopLevelParent(this);
5443 bool wxPropertyGrid::IsEditorFocused() const
5445 wxWindow
* focus
= wxWindow::FindFocus();
5447 if ( focus
== m_wndEditor
|| focus
== m_wndEditor2
||
5448 focus
== GetEditorControl() )
5454 // Called by focus event handlers. newFocused is the window that becomes focused.
5455 void wxPropertyGrid::HandleFocusChange( wxWindow
* newFocused
)
5457 unsigned int oldFlags
= m_iFlags
;
5459 m_iFlags
&= ~(wxPG_FL_FOCUSED
);
5461 wxWindow
* parent
= newFocused
;
5463 // This must be one of nextFocus' parents.
5466 // Use m_eventObject, which is either wxPropertyGrid or
5467 // wxPropertyGridManager, as appropriate.
5468 if ( parent
== m_eventObject
)
5470 m_iFlags
|= wxPG_FL_FOCUSED
;
5473 parent
= parent
->GetParent();
5476 m_curFocused
= newFocused
;
5478 if ( (m_iFlags
& wxPG_FL_FOCUSED
) !=
5479 (oldFlags
& wxPG_FL_FOCUSED
) )
5481 if ( !(m_iFlags
& wxPG_FL_FOCUSED
) )
5483 // Need to store changed value
5484 CommitChangesFromEditor();
5490 // Preliminary code for tab-order respecting
5491 // tab-traversal (but should be moved to
5494 wxWindow* prevFocus = event.GetWindow();
5495 wxWindow* useThis = this;
5496 if ( m_iFlags & wxPG_FL_IN_MANAGER )
5497 useThis = GetParent();
5500 prevFocus->GetParent() == useThis->GetParent() )
5502 wxList& children = useThis->GetParent()->GetChildren();
5504 wxNode* node = children.Find(prevFocus);
5506 if ( node->GetNext() &&
5507 useThis == node->GetNext()->GetData() )
5508 DoSelectProperty(GetFirst());
5509 else if ( node->GetPrevious () &&
5510 useThis == node->GetPrevious()->GetData() )
5511 DoSelectProperty(GetLastProperty());
5518 wxPGProperty
* selected
= GetSelection();
5519 if ( selected
&& (m_iFlags
& wxPG_FL_INITIALIZED
) )
5520 DrawItem( selected
);
5524 void wxPropertyGrid::OnFocusEvent( wxFocusEvent
& event
)
5526 if ( event
.GetEventType() == wxEVT_SET_FOCUS
)
5527 HandleFocusChange((wxWindow
*)event
.GetEventObject());
5528 // Line changed to "else" when applying wxPropertyGrid patch #1675902
5529 //else if ( event.GetWindow() )
5531 HandleFocusChange(event
.GetWindow());
5536 // -----------------------------------------------------------------------
5538 void wxPropertyGrid::OnChildFocusEvent( wxChildFocusEvent
& event
)
5540 HandleFocusChange((wxWindow
*)event
.GetEventObject());
5544 // -----------------------------------------------------------------------
5546 void wxPropertyGrid::OnScrollEvent( wxScrollWinEvent
&event
)
5548 m_iFlags
|= wxPG_FL_SCROLLED
;
5553 // -----------------------------------------------------------------------
5555 void wxPropertyGrid::OnCaptureChange( wxMouseCaptureChangedEvent
& WXUNUSED(event
) )
5557 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
5559 m_iFlags
&= ~(wxPG_FL_MOUSE_CAPTURED
);
5563 // -----------------------------------------------------------------------
5564 // Property editor related functions
5565 // -----------------------------------------------------------------------
5567 // noDefCheck = true prevents infinite recursion.
5568 wxPGEditor
* wxPropertyGrid::DoRegisterEditorClass( wxPGEditor
* editorClass
,
5569 const wxString
& editorName
,
5572 wxASSERT( editorClass
);
5574 if ( !noDefCheck
&& wxPGGlobalVars
->m_mapEditorClasses
.empty() )
5575 RegisterDefaultEditors();
5577 wxString name
= editorName
;
5578 if ( name
.length() == 0 )
5579 name
= editorClass
->GetName();
5581 // Existing editor under this name?
5582 wxPGHashMapS2P::iterator vt_it
= wxPGGlobalVars
->m_mapEditorClasses
.find(name
);
5584 if ( vt_it
!= wxPGGlobalVars
->m_mapEditorClasses
.end() )
5586 // If this name was already used, try class name.
5587 name
= editorClass
->GetClassInfo()->GetClassName();
5588 vt_it
= wxPGGlobalVars
->m_mapEditorClasses
.find(name
);
5591 wxCHECK_MSG( vt_it
== wxPGGlobalVars
->m_mapEditorClasses
.end(),
5592 (wxPGEditor
*) vt_it
->second
,
5593 "Editor with given name was already registered" );
5595 wxPGGlobalVars
->m_mapEditorClasses
[name
] = (void*)editorClass
;
5600 // Use this in RegisterDefaultEditors.
5601 #define wxPGRegisterDefaultEditorClass(EDITOR) \
5602 if ( wxPGEditor_##EDITOR == NULL ) \
5604 wxPGEditor_##EDITOR = wxPropertyGrid::RegisterEditorClass( \
5605 new wxPG##EDITOR##Editor, true ); \
5608 // Registers all default editor classes
5609 void wxPropertyGrid::RegisterDefaultEditors()
5611 wxPGRegisterDefaultEditorClass( TextCtrl
);
5612 wxPGRegisterDefaultEditorClass( Choice
);
5613 wxPGRegisterDefaultEditorClass( ComboBox
);
5614 wxPGRegisterDefaultEditorClass( TextCtrlAndButton
);
5615 #if wxPG_INCLUDE_CHECKBOX
5616 wxPGRegisterDefaultEditorClass( CheckBox
);
5618 wxPGRegisterDefaultEditorClass( ChoiceAndButton
);
5620 // Register SpinCtrl etc. editors before use
5621 RegisterAdditionalEditors();
5624 // -----------------------------------------------------------------------
5625 // wxPGStringTokenizer
5626 // Needed to handle C-style string lists (e.g. "str1" "str2")
5627 // -----------------------------------------------------------------------
5629 wxPGStringTokenizer::wxPGStringTokenizer( const wxString
& str
, wxChar delimeter
)
5630 : m_str(&str
), m_curPos(str
.begin()), m_delimeter(delimeter
)
5634 wxPGStringTokenizer::~wxPGStringTokenizer()
5638 bool wxPGStringTokenizer::HasMoreTokens()
5640 const wxString
& str
= *m_str
;
5642 wxString::const_iterator i
= m_curPos
;
5644 wxUniChar delim
= m_delimeter
;
5646 wxUniChar prev_a
= wxT('\0');
5648 bool inToken
= false;
5650 while ( i
!= str
.end() )
5659 m_readyToken
.clear();
5664 if ( prev_a
!= wxT('\\') )
5668 if ( a
!= wxT('\\') )
5688 m_curPos
= str
.end();
5696 wxString
wxPGStringTokenizer::GetNextToken()
5698 return m_readyToken
;
5701 // -----------------------------------------------------------------------
5703 // -----------------------------------------------------------------------
5705 wxPGChoiceEntry::wxPGChoiceEntry()
5706 : wxPGCell(), m_value(wxPG_INVALID_VALUE
)
5710 // -----------------------------------------------------------------------
5712 // -----------------------------------------------------------------------
5714 wxPGChoicesData::wxPGChoicesData()
5718 wxPGChoicesData::~wxPGChoicesData()
5723 void wxPGChoicesData::Clear()
5728 void wxPGChoicesData::CopyDataFrom( wxPGChoicesData
* data
)
5730 wxASSERT( m_items
.size() == 0 );
5732 m_items
= data
->m_items
;
5735 wxPGChoiceEntry
& wxPGChoicesData::Insert( int index
,
5736 const wxPGChoiceEntry
& item
)
5738 wxVector
<wxPGChoiceEntry
>::iterator it
;
5742 index
= (int) m_items
.size();
5746 it
= m_items
.begin() + index
;
5749 m_items
.insert(it
, item
);
5751 wxPGChoiceEntry
& ownEntry
= m_items
[index
];
5753 // Need to fix value?
5754 if ( ownEntry
.GetValue() == wxPG_INVALID_VALUE
)
5755 ownEntry
.SetValue(index
);
5760 // -----------------------------------------------------------------------
5761 // wxPropertyGridEvent
5762 // -----------------------------------------------------------------------
5764 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGridEvent
, wxCommandEvent
)
5767 wxDEFINE_EVENT( wxEVT_PG_SELECTED
, wxPropertyGridEvent
);
5768 wxDEFINE_EVENT( wxEVT_PG_CHANGING
, wxPropertyGridEvent
);
5769 wxDEFINE_EVENT( wxEVT_PG_CHANGED
, wxPropertyGridEvent
);
5770 wxDEFINE_EVENT( wxEVT_PG_HIGHLIGHTED
, wxPropertyGridEvent
);
5771 wxDEFINE_EVENT( wxEVT_PG_RIGHT_CLICK
, wxPropertyGridEvent
);
5772 wxDEFINE_EVENT( wxEVT_PG_PAGE_CHANGED
, wxPropertyGridEvent
);
5773 wxDEFINE_EVENT( wxEVT_PG_ITEM_EXPANDED
, wxPropertyGridEvent
);
5774 wxDEFINE_EVENT( wxEVT_PG_ITEM_COLLAPSED
, wxPropertyGridEvent
);
5775 wxDEFINE_EVENT( wxEVT_PG_DOUBLE_CLICK
, wxPropertyGridEvent
);
5776 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_BEGIN
, wxPropertyGridEvent
);
5777 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_ENDING
, wxPropertyGridEvent
);
5779 // -----------------------------------------------------------------------
5781 void wxPropertyGridEvent::Init()
5783 m_validationInfo
= NULL
;
5786 m_wasVetoed
= false;
5789 // -----------------------------------------------------------------------
5791 wxPropertyGridEvent::wxPropertyGridEvent(wxEventType commandType
, int id
)
5792 : wxCommandEvent(commandType
,id
)
5798 // -----------------------------------------------------------------------
5800 wxPropertyGridEvent::wxPropertyGridEvent(const wxPropertyGridEvent
& event
)
5801 : wxCommandEvent(event
)
5803 m_eventType
= event
.GetEventType();
5804 m_eventObject
= event
.m_eventObject
;
5806 OnPropertyGridSet();
5807 m_property
= event
.m_property
;
5808 m_validationInfo
= event
.m_validationInfo
;
5809 m_canVeto
= event
.m_canVeto
;
5810 m_wasVetoed
= event
.m_wasVetoed
;
5813 // -----------------------------------------------------------------------
5815 void wxPropertyGridEvent::OnPropertyGridSet()
5821 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
5823 m_pg
->m_liveEvents
.push_back(this);
5826 // -----------------------------------------------------------------------
5828 wxPropertyGridEvent::~wxPropertyGridEvent()
5833 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
5836 // Use iterate from the back since it is more likely that the event
5837 // being desroyed is at the end of the array.
5838 wxVector
<wxPropertyGridEvent
*>& liveEvents
= m_pg
->m_liveEvents
;
5840 for ( int i
= liveEvents
.size()-1; i
>= 0; i
-- )
5842 if ( liveEvents
[i
] == this )
5844 liveEvents
.erase(liveEvents
.begin() + i
);
5851 // -----------------------------------------------------------------------
5853 wxEvent
* wxPropertyGridEvent::Clone() const
5855 return new wxPropertyGridEvent( *this );
5858 // -----------------------------------------------------------------------
5859 // wxPropertyGridPopulator
5860 // -----------------------------------------------------------------------
5862 wxPropertyGridPopulator::wxPropertyGridPopulator()
5866 wxPGGlobalVars
->m_offline
++;
5869 // -----------------------------------------------------------------------
5871 void wxPropertyGridPopulator::SetState( wxPropertyGridPageState
* state
)
5874 m_propHierarchy
.clear();
5877 // -----------------------------------------------------------------------
5879 void wxPropertyGridPopulator::SetGrid( wxPropertyGrid
* pg
)
5885 // -----------------------------------------------------------------------
5887 wxPropertyGridPopulator::~wxPropertyGridPopulator()
5890 // Free unused sets of choices
5891 wxPGHashMapS2P::iterator it
;
5893 for( it
= m_dictIdChoices
.begin(); it
!= m_dictIdChoices
.end(); ++it
)
5895 wxPGChoicesData
* data
= (wxPGChoicesData
*) it
->second
;
5902 m_pg
->GetPanel()->Refresh();
5904 wxPGGlobalVars
->m_offline
--;
5907 // -----------------------------------------------------------------------
5909 wxPGProperty
* wxPropertyGridPopulator::Add( const wxString
& propClass
,
5910 const wxString
& propLabel
,
5911 const wxString
& propName
,
5912 const wxString
* propValue
,
5913 wxPGChoices
* pChoices
)
5915 wxClassInfo
* classInfo
= wxClassInfo::FindClass(propClass
);
5916 wxPGProperty
* parent
= GetCurParent();
5918 if ( parent
->HasFlag(wxPG_PROP_AGGREGATE
) )
5920 ProcessError(wxString::Format(wxT("new children cannot be added to '%s'"),parent
->GetName().c_str()));
5924 if ( !classInfo
|| !classInfo
->IsKindOf(CLASSINFO(wxPGProperty
)) )
5926 ProcessError(wxString::Format(wxT("'%s' is not valid property class"),propClass
.c_str()));
5930 wxPGProperty
* property
= (wxPGProperty
*) classInfo
->CreateObject();
5932 property
->SetLabel(propLabel
);
5933 property
->DoSetName(propName
);
5935 if ( pChoices
&& pChoices
->IsOk() )
5936 property
->SetChoices(*pChoices
);
5938 m_state
->DoInsert(parent
, -1, property
);
5941 property
->SetValueFromString( *propValue
, wxPG_FULL_VALUE
|
5942 wxPG_PROGRAMMATIC_VALUE
);
5947 // -----------------------------------------------------------------------
5949 void wxPropertyGridPopulator::AddChildren( wxPGProperty
* property
)
5951 m_propHierarchy
.push_back(property
);
5952 DoScanForChildren();
5953 m_propHierarchy
.pop_back();
5956 // -----------------------------------------------------------------------
5958 wxPGChoices
wxPropertyGridPopulator::ParseChoices( const wxString
& choicesString
,
5959 const wxString
& idString
)
5961 wxPGChoices choices
;
5964 if ( choicesString
[0] == wxT('@') )
5966 wxString ids
= choicesString
.substr(1);
5967 wxPGHashMapS2P::iterator it
= m_dictIdChoices
.find(ids
);
5968 if ( it
== m_dictIdChoices
.end() )
5969 ProcessError(wxString::Format(wxT("No choices defined for id '%s'"),ids
.c_str()));
5971 choices
.AssignData((wxPGChoicesData
*)it
->second
);
5976 if ( idString
.length() )
5978 wxPGHashMapS2P::iterator it
= m_dictIdChoices
.find(idString
);
5979 if ( it
!= m_dictIdChoices
.end() )
5981 choices
.AssignData((wxPGChoicesData
*)it
->second
);
5988 // Parse choices string
5989 wxString::const_iterator it
= choicesString
.begin();
5993 bool labelValid
= false;
5995 for ( ; it
!= choicesString
.end(); ++it
)
6001 if ( c
== wxT('"') )
6006 if ( !value
.ToLong(&l
, 0) ) l
= wxPG_INVALID_VALUE
;
6007 choices
.Add(label
, l
);
6010 //wxLogDebug(wxT("%s, %s"),label.c_str(),value.c_str());
6015 else if ( c
== wxT('=') )
6022 else if ( state
== 2 && (wxIsalnum(c
) || c
== wxT('x')) )
6029 if ( c
== wxT('"') )
6042 if ( !value
.ToLong(&l
, 0) ) l
= wxPG_INVALID_VALUE
;
6043 choices
.Add(label
, l
);
6046 if ( !choices
.IsOk() )
6048 choices
.EnsureData();
6052 if ( idString
.length() )
6053 m_dictIdChoices
[idString
] = choices
.GetData();
6060 // -----------------------------------------------------------------------
6062 bool wxPropertyGridPopulator::ToLongPCT( const wxString
& s
, long* pval
, long max
)
6064 if ( s
.Last() == wxT('%') )
6066 wxString s2
= s
.substr(0,s
.length()-1);
6068 if ( s2
.ToLong(&val
, 10) )
6070 *pval
= (val
*max
)/100;
6076 return s
.ToLong(pval
, 10);
6079 // -----------------------------------------------------------------------
6081 bool wxPropertyGridPopulator::AddAttribute( const wxString
& name
,
6082 const wxString
& type
,
6083 const wxString
& value
)
6085 int l
= m_propHierarchy
.size();
6089 wxPGProperty
* p
= m_propHierarchy
[l
-1];
6090 wxString valuel
= value
.Lower();
6093 if ( type
.length() == 0 )
6098 if ( valuel
== wxT("true") || valuel
== wxT("yes") || valuel
== wxT("1") )
6100 else if ( valuel
== wxT("false") || valuel
== wxT("no") || valuel
== wxT("0") )
6102 else if ( value
.ToLong(&v
, 0) )
6109 if ( type
== wxT("string") )
6113 else if ( type
== wxT("int") )
6116 value
.ToLong(&v
, 0);
6119 else if ( type
== wxT("bool") )
6121 if ( valuel
== wxT("true") || valuel
== wxT("yes") || valuel
== wxT("1") )
6128 ProcessError(wxString::Format(wxT("Invalid attribute type '%s'"),type
.c_str()));
6133 p
->SetAttribute( name
, variant
);
6138 // -----------------------------------------------------------------------
6140 void wxPropertyGridPopulator::ProcessError( const wxString
& msg
)
6142 wxLogError(_("Error in resource: %s"),msg
.c_str());
6145 // -----------------------------------------------------------------------
6147 #endif // wxUSE_PROPGRID