1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/propgrid/propgrid.cpp
3 // Purpose: wxPropertyGrid
4 // Author: Jaakko Salli
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx/wx.h".
13 #include "wx/wxprec.h"
23 #include "wx/object.h"
25 #include "wx/string.h"
28 #include "wx/window.h"
31 #include "wx/dcmemory.h"
32 #include "wx/button.h"
35 #include "wx/cursor.h"
36 #include "wx/dialog.h"
37 #include "wx/settings.h"
38 #include "wx/msgdlg.h"
39 #include "wx/choice.h"
40 #include "wx/stattext.h"
41 #include "wx/scrolwin.h"
42 #include "wx/dirdlg.h"
44 #include "wx/textdlg.h"
45 #include "wx/filedlg.h"
46 #include "wx/statusbr.h"
52 // This define is necessary to prevent macro clearing
53 #define __wxPG_SOURCE_FILE__
55 #include "wx/propgrid/propgrid.h"
56 #include "wx/propgrid/editors.h"
58 #if wxPG_USE_RENDERER_NATIVE
59 #include "wx/renderer.h"
62 #include "wx/odcombo.h"
65 #include "wx/dcbuffer.h"
67 // Two pics for the expand / collapse buttons.
68 // Files are not supplied with this project (since it is
69 // recommended to use either custom or native rendering).
70 // If you want them, get wxTreeMultiCtrl by Jorgen Bodde,
71 // and copy xpm files from archive to wxPropertyGrid src directory
72 // (and also comment/undef wxPG_ICON_WIDTH in propGrid.h
73 // and set wxPG_USE_RENDERER_NATIVE to 0).
74 #ifndef wxPG_ICON_WIDTH
75 #if defined(__WXMAC__)
76 #include "mac_collapse.xpm"
77 #include "mac_expand.xpm"
78 #elif defined(__WXGTK__)
79 #include "linux_collapse.xpm"
80 #include "linux_expand.xpm"
82 #include "default_collapse.xpm"
83 #include "default_expand.xpm"
88 //#define wxPG_TEXT_INDENT 4 // For the wxComboControl
89 //#define wxPG_ALLOW_CLIPPING 1 // If 1, GetUpdateRegion() in OnPaint event handler is not ignored
90 #define wxPG_GUTTER_DIV 3 // gutter is max(iconwidth/gutter_div,gutter_min)
91 #define wxPG_GUTTER_MIN 3 // gutter before and after image of [+] or [-]
92 #define wxPG_YSPACING_MIN 1
93 #define wxPG_DEFAULT_VSPACING 2 // This matches .NET propertygrid's value,
94 // but causes normal combobox to spill out under MSW
96 //#define wxPG_OPTIMAL_WIDTH 200 // Arbitrary
98 //#define wxPG_MIN_SCROLLBAR_WIDTH 10 // Smallest scrollbar width on any platform
99 // Must be larger than largest control border
103 #define wxPG_DEFAULT_CURSOR wxNullCursor
106 //#define wxPG_NAT_CHOICE_BORDER_ANY 0
108 //#define wxPG_HIDER_BUTTON_HEIGHT 25
110 #define wxPG_PIXELS_PER_UNIT m_lineHeight
112 #ifdef wxPG_ICON_WIDTH
113 #define m_iconHeight m_iconWidth
116 //#define wxPG_TOOLTIP_DELAY 1000
118 // This is the number of pixels the expander button inside
119 // property cells (i.e. not in the grey margin area are
121 #define IN_CELL_EXPANDER_BUTTON_X_ADJUST 2
123 // -----------------------------------------------------------------------
126 void wxPropertyGrid::AutoGetTranslation ( bool enable
)
128 wxPGGlobalVars
->m_autoGetTranslation
= enable
;
131 void wxPropertyGrid::AutoGetTranslation ( bool ) { }
134 // -----------------------------------------------------------------------
136 const char wxPropertyGridNameStr
[] = "wxPropertyGrid";
138 // -----------------------------------------------------------------------
139 // Statics in one class for easy destruction.
140 // -----------------------------------------------------------------------
142 #include "wx/module.h"
144 class wxPGGlobalVarsClassManager
: public wxModule
146 DECLARE_DYNAMIC_CLASS(wxPGGlobalVarsClassManager
)
148 wxPGGlobalVarsClassManager() {}
149 virtual bool OnInit() { wxPGGlobalVars
= new wxPGGlobalVarsClass(); return true; }
150 virtual void OnExit() { delete wxPGGlobalVars
; wxPGGlobalVars
= NULL
; }
153 IMPLEMENT_DYNAMIC_CLASS(wxPGGlobalVarsClassManager
, wxModule
)
156 // When wxPG is loaded dynamically after the application is already running
157 // then the built-in module system won't pick this one up. Add it manually.
158 void wxPGInitResourceModule()
160 wxModule
* module = new wxPGGlobalVarsClassManager
;
162 wxModule::RegisterModule(module);
165 wxPGGlobalVarsClass
* wxPGGlobalVars
= NULL
;
168 wxPGGlobalVarsClass::wxPGGlobalVarsClass()
170 wxPGProperty::sm_wxPG_LABEL
= new wxString(wxPG_LABEL_STRING
);
172 m_boolChoices
.Add(_("False"));
173 m_boolChoices
.Add(_("True"));
175 m_fontFamilyChoices
= NULL
;
177 m_defaultRenderer
= new wxPGDefaultRenderer();
179 m_autoGetTranslation
= false;
187 // Prepare some shared variants
188 m_vEmptyString
= wxString();
190 m_vMinusOne
= (long) -1;
194 // Prepare cached string constants
195 m_strstring
= wxS("string");
196 m_strlong
= wxS("long");
197 m_strbool
= wxS("bool");
198 m_strlist
= wxS("list");
199 m_strDefaultValue
= wxS("DefaultValue");
200 m_strMin
= wxS("Min");
201 m_strMax
= wxS("Max");
202 m_strUnits
= wxS("Units");
203 m_strInlineHelp
= wxS("InlineHelp");
209 wxPGGlobalVarsClass::~wxPGGlobalVarsClass()
213 delete m_defaultRenderer
;
215 // This will always have one ref
216 delete m_fontFamilyChoices
;
219 for ( i
=0; i
<m_arrValidators
.size(); i
++ )
220 delete ((wxValidator
*)m_arrValidators
[i
]);
224 // Destroy value type class instances.
225 wxPGHashMapS2P::iterator vt_it
;
227 // Destroy editor class instances.
228 // iterate over all the elements in the class
229 for( vt_it
= m_mapEditorClasses
.begin(); vt_it
!= m_mapEditorClasses
.end(); ++vt_it
)
231 delete ((wxPGEditor
*)vt_it
->second
);
234 delete wxPGProperty::sm_wxPG_LABEL
;
237 void wxPropertyGridInitGlobalsIfNeeded()
241 // -----------------------------------------------------------------------
243 // -----------------------------------------------------------------------
245 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGrid
, wxScrolledWindow
)
247 BEGIN_EVENT_TABLE(wxPropertyGrid
, wxScrolledWindow
)
248 EVT_IDLE(wxPropertyGrid::OnIdle
)
249 EVT_PAINT(wxPropertyGrid::OnPaint
)
250 EVT_SIZE(wxPropertyGrid::OnResize
)
251 EVT_ENTER_WINDOW(wxPropertyGrid::OnMouseEntry
)
252 EVT_LEAVE_WINDOW(wxPropertyGrid::OnMouseEntry
)
253 EVT_MOUSE_CAPTURE_CHANGED(wxPropertyGrid::OnCaptureChange
)
254 EVT_SCROLLWIN(wxPropertyGrid::OnScrollEvent
)
255 EVT_CHILD_FOCUS(wxPropertyGrid::OnChildFocusEvent
)
256 EVT_SET_FOCUS(wxPropertyGrid::OnFocusEvent
)
257 EVT_KILL_FOCUS(wxPropertyGrid::OnFocusEvent
)
258 EVT_SYS_COLOUR_CHANGED(wxPropertyGrid::OnSysColourChanged
)
259 EVT_MOTION(wxPropertyGrid::OnMouseMove
)
260 EVT_LEFT_DOWN(wxPropertyGrid::OnMouseClick
)
261 EVT_LEFT_UP(wxPropertyGrid::OnMouseUp
)
262 EVT_RIGHT_UP(wxPropertyGrid::OnMouseRightClick
)
263 EVT_LEFT_DCLICK(wxPropertyGrid::OnMouseDoubleClick
)
264 EVT_KEY_DOWN(wxPropertyGrid::OnKey
)
267 // -----------------------------------------------------------------------
269 wxPropertyGrid::wxPropertyGrid()
275 // -----------------------------------------------------------------------
277 wxPropertyGrid::wxPropertyGrid( wxWindow
*parent
,
282 const wxString
& name
)
286 Create(parent
,id
,pos
,size
,style
,name
);
289 // -----------------------------------------------------------------------
291 bool wxPropertyGrid::Create( wxWindow
*parent
,
296 const wxString
& name
)
299 if (!(style
&wxBORDER_MASK
))
301 style
|= wxBORDER_THEME
;
306 // Filter out wxTAB_TRAVERSAL - we will handle TABs manually
307 style
&= ~(wxTAB_TRAVERSAL
);
308 style
|= wxWANTS_CHARS
;
310 wxScrolledWindow::Create(parent
,id
,pos
,size
,style
,name
);
317 // -----------------------------------------------------------------------
320 // Initialize values to defaults
322 void wxPropertyGrid::Init1()
324 // Register editor classes, if necessary.
325 if ( wxPGGlobalVars
->m_mapEditorClasses
.empty() )
326 wxPropertyGrid::RegisterDefaultEditors();
330 m_wndEditor
= m_wndEditor2
= NULL
;
334 m_labelEditor
= NULL
;
335 m_labelEditorProperty
= NULL
;
336 m_eventObject
= this;
338 m_processedEvent
= NULL
;
339 m_sortFunction
= NULL
;
340 m_inDoPropertyChanged
= 0;
341 m_inCommitChangesFromEditor
= 0;
342 m_inDoSelectProperty
= 0;
343 m_permanentValidationFailureBehavior
= wxPG_VFB_DEFAULT
;
349 AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY
, WXK_RIGHT
);
350 AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY
, WXK_DOWN
);
351 AddActionTrigger( wxPG_ACTION_PREV_PROPERTY
, WXK_LEFT
);
352 AddActionTrigger( wxPG_ACTION_PREV_PROPERTY
, WXK_UP
);
353 AddActionTrigger( wxPG_ACTION_EXPAND_PROPERTY
, WXK_RIGHT
);
354 AddActionTrigger( wxPG_ACTION_COLLAPSE_PROPERTY
, WXK_LEFT
);
355 AddActionTrigger( wxPG_ACTION_CANCEL_EDIT
, WXK_ESCAPE
);
356 AddActionTrigger( wxPG_ACTION_PRESS_BUTTON
, WXK_DOWN
, wxMOD_ALT
);
357 AddActionTrigger( wxPG_ACTION_PRESS_BUTTON
, WXK_F4
);
359 m_coloursCustomized
= 0;
362 #if wxPG_DOUBLE_BUFFER
363 m_doubleBuffer
= NULL
;
366 #ifndef wxPG_ICON_WIDTH
372 m_iconWidth
= wxPG_ICON_WIDTH
;
377 m_gutterWidth
= wxPG_GUTTER_MIN
;
378 m_subgroup_extramargin
= 10;
382 m_width
= m_height
= 0;
384 m_commonValues
.push_back(new wxPGCommonValue(_("Unspecified"), wxPGGlobalVars
->m_defaultRenderer
) );
387 m_chgInfo_changedProperty
= NULL
;
390 // -----------------------------------------------------------------------
393 // Initialize after parent etc. set
395 void wxPropertyGrid::Init2()
397 wxASSERT( !(m_iFlags
& wxPG_FL_INITIALIZED
) );
400 // Smaller controls on Mac
401 SetWindowVariant(wxWINDOW_VARIANT_SMALL
);
404 // Now create state, if one didn't exist already
405 // (wxPropertyGridManager might have created it for us).
408 m_pState
= CreateState();
409 m_pState
->m_pPropGrid
= this;
410 m_iFlags
|= wxPG_FL_CREATEDSTATE
;
413 if ( !(m_windowStyle
& wxPG_SPLITTER_AUTO_CENTER
) )
414 m_pState
->m_dontCenterSplitter
= true;
416 if ( m_windowStyle
& wxPG_HIDE_CATEGORIES
)
418 m_pState
->InitNonCatMode();
420 m_pState
->m_properties
= m_pState
->m_abcArray
;
423 GetClientSize(&m_width
,&m_height
);
425 #ifndef wxPG_ICON_WIDTH
426 // create two bitmap nodes for drawing
427 m_expandbmp
= new wxBitmap(expand_xpm
);
428 m_collbmp
= new wxBitmap(collapse_xpm
);
430 // calculate average font height for bitmap centering
432 m_iconWidth
= m_expandbmp
->GetWidth();
433 m_iconHeight
= m_expandbmp
->GetHeight();
436 m_curcursor
= wxCURSOR_ARROW
;
437 m_cursorSizeWE
= new wxCursor( wxCURSOR_SIZEWE
);
439 // adjust bitmap icon y position so they are centered
440 m_vspacing
= wxPG_DEFAULT_VSPACING
;
442 CalculateFontAndBitmapStuff( wxPG_DEFAULT_VSPACING
);
444 // Allocate cell datas indirectly by calling setter
445 m_propertyDefaultCell
.SetBgCol(*wxBLACK
);
446 m_categoryDefaultCell
.SetBgCol(*wxBLACK
);
450 // This helps with flicker
451 SetBackgroundStyle( wxBG_STYLE_CUSTOM
);
453 // Hook the top-level parent
458 // set virtual size to this window size
459 wxSize wndsize
= GetSize();
460 SetVirtualSize(wndsize
.GetWidth(), wndsize
.GetWidth());
462 m_timeCreated
= ::wxGetLocalTimeMillis();
464 //m_canvas->Create(this, wxID_ANY, wxPoint(0, 0), GetClientSize(),
465 // wxWANTS_CHARS | wxCLIP_CHILDREN);
466 SetBackgroundStyle( wxBG_STYLE_CUSTOM
);
468 m_iFlags
|= wxPG_FL_INITIALIZED
;
470 m_ncWidth
= wndsize
.GetWidth();
472 // Need to call OnResize handler or size given in constructor/Create
474 wxSizeEvent
sizeEvent(wndsize
,0);
478 // -----------------------------------------------------------------------
480 wxPropertyGrid::~wxPropertyGrid()
485 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
489 // Remove grid and property pointers from live wxPropertyGridEvents.
490 for ( i
=0; i
<m_liveEvents
.size(); i
++ )
492 wxPropertyGridEvent
* evt
= m_liveEvents
[i
];
493 evt
->SetPropertyGrid(NULL
);
494 evt
->SetProperty(NULL
);
496 m_liveEvents
.clear();
498 if ( m_processedEvent
)
500 // All right... we are being deleted while wxPropertyGrid event
501 // is being sent. Make sure that event propagates as little
502 // as possible (although usually this is not enough to prevent
504 m_processedEvent
->Skip(false);
505 m_processedEvent
->StopPropagation();
507 // Let's use wxMessageBox to make the message appear more
508 // reliably (and *before* the crash can happen).
509 ::wxMessageBox("wxPropertyGrid was being destroyed in an event "
510 "generated by it. This usually leads to a crash "
511 "so it is recommended to destroy the control "
512 "at idle time instead.");
515 DoSelectProperty(NULL
, wxPG_SEL_NOVALIDATE
|wxPG_SEL_DONT_SEND_EVENT
);
517 // This should do prevent things from going too badly wrong
518 m_iFlags
&= ~(wxPG_FL_INITIALIZED
);
520 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
523 // Call with NULL to disconnect event handling
524 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING
)
528 wxASSERT_MSG( !IsEditorsValueModified(),
529 wxS("Most recent change in property editor was ")
530 wxS("lost!!! (if you don't want this to happen, ")
531 wxS("close your frames and dialogs using ")
532 wxS("Close(false).)") );
535 #if wxPG_DOUBLE_BUFFER
536 if ( m_doubleBuffer
)
537 delete m_doubleBuffer
;
540 if ( m_iFlags
& wxPG_FL_CREATEDSTATE
)
543 delete m_cursorSizeWE
;
545 #ifndef wxPG_ICON_WIDTH
550 // Delete common value records
551 for ( i
=0; i
<m_commonValues
.size(); i
++ )
553 // Use temporary variable to work around possible strange VC6 (asserts because m_size is zero)
554 wxPGCommonValue
* value
= m_commonValues
[i
];
559 // -----------------------------------------------------------------------
561 bool wxPropertyGrid::Destroy()
563 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
566 return wxScrolledWindow::Destroy();
569 // -----------------------------------------------------------------------
571 wxPropertyGridPageState
* wxPropertyGrid::CreateState() const
573 return new wxPropertyGridPageState();
576 // -----------------------------------------------------------------------
577 // wxPropertyGrid overridden wxWindow methods
578 // -----------------------------------------------------------------------
580 void wxPropertyGrid::SetWindowStyleFlag( long style
)
582 long old_style
= m_windowStyle
;
584 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
586 wxASSERT( m_pState
);
588 if ( !(style
& wxPG_HIDE_CATEGORIES
) && (old_style
& wxPG_HIDE_CATEGORIES
) )
591 EnableCategories( true );
593 else if ( (style
& wxPG_HIDE_CATEGORIES
) && !(old_style
& wxPG_HIDE_CATEGORIES
) )
595 // Disable categories
596 EnableCategories( false );
598 if ( !(old_style
& wxPG_AUTO_SORT
) && (style
& wxPG_AUTO_SORT
) )
604 PrepareAfterItemsAdded();
606 m_pState
->m_itemsAdded
= 1;
608 #if wxPG_SUPPORT_TOOLTIPS
609 if ( !(old_style
& wxPG_TOOLTIPS
) && (style
& wxPG_TOOLTIPS
) )
615 wxToolTip* tooltip = new wxToolTip ( wxEmptyString );
616 SetToolTip ( tooltip );
617 tooltip->SetDelay ( wxPG_TOOLTIP_DELAY );
620 else if ( (old_style
& wxPG_TOOLTIPS
) && !(style
& wxPG_TOOLTIPS
) )
625 wxScrolledWindow::SetToolTip( NULL
);
630 wxScrolledWindow::SetWindowStyleFlag ( style
);
632 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
634 if ( (old_style
& wxPG_HIDE_MARGIN
) != (style
& wxPG_HIDE_MARGIN
) )
636 CalculateFontAndBitmapStuff( m_vspacing
);
642 // -----------------------------------------------------------------------
644 void wxPropertyGrid::Freeze()
648 wxScrolledWindow::Freeze();
653 // -----------------------------------------------------------------------
655 void wxPropertyGrid::Thaw()
661 wxScrolledWindow::Thaw();
662 RecalculateVirtualSize();
663 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
667 // Force property re-selection
668 // NB: We must copy the selection.
669 wxArrayPGProperty selection
= m_pState
->m_selection
;
670 DoSetSelection(selection
, wxPG_SEL_FORCE
| wxPG_SEL_NONVISIBLE
);
674 // -----------------------------------------------------------------------
676 bool wxPropertyGrid::DoAddToSelection( wxPGProperty
* prop
, int selFlags
)
678 wxCHECK( prop
, false );
680 if ( !(GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
) )
681 return DoSelectProperty(prop
, selFlags
);
683 wxArrayPGProperty
& selection
= m_pState
->m_selection
;
685 if ( !selection
.size() )
687 return DoSelectProperty(prop
, selFlags
);
691 // For categories, only one can be selected at a time
692 if ( prop
->IsCategory() || selection
[0]->IsCategory() )
695 selection
.push_back(prop
);
697 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
699 SendEvent( wxEVT_PG_SELECTED
, prop
, NULL
);
708 // -----------------------------------------------------------------------
710 bool wxPropertyGrid::DoRemoveFromSelection( wxPGProperty
* prop
, int selFlags
)
712 wxCHECK( prop
, false );
715 wxArrayPGProperty
& selection
= m_pState
->m_selection
;
716 if ( selection
.size() <= 1 )
718 res
= DoSelectProperty(NULL
, selFlags
);
722 m_pState
->DoRemoveFromSelection(prop
);
730 // -----------------------------------------------------------------------
732 bool wxPropertyGrid::DoSelectAndEdit( wxPGProperty
* prop
,
733 unsigned int colIndex
,
734 unsigned int selFlags
)
737 // NB: Enable following if label editor background colour is
738 // ever changed to any other than m_colSelBack.
740 // We use this workaround to prevent visible flicker when editing
741 // a cell. Atleast on wxMSW, there is a difficult to find
742 // (and perhaps prevent) redraw somewhere between making property
743 // selected and enabling label editing.
745 //wxColour prevColSelBack = m_colSelBack;
746 //m_colSelBack = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
752 res
= DoSelectProperty(prop
, selFlags
);
757 DoClearSelection(false, wxPG_SEL_NO_REFRESH
);
759 if ( m_pState
->m_editableColumns
.Index(colIndex
) == wxNOT_FOUND
)
761 res
= DoAddToSelection(prop
, selFlags
);
765 res
= DoAddToSelection(prop
, selFlags
|wxPG_SEL_NO_REFRESH
);
767 DoBeginLabelEdit(colIndex
, selFlags
);
771 //m_colSelBack = prevColSelBack;
775 // -----------------------------------------------------------------------
777 bool wxPropertyGrid::AddToSelectionFromInputEvent( wxPGProperty
* prop
,
778 unsigned int colIndex
,
779 wxMouseEvent
* mouseEvent
,
782 bool alreadySelected
= m_pState
->DoIsPropertySelected(prop
);
784 bool addToExistingSelection
;
786 if ( GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
)
790 if ( mouseEvent
->GetEventType() == wxEVT_RIGHT_DOWN
||
791 mouseEvent
->GetEventType() == wxEVT_RIGHT_UP
)
793 // Allow right-click for context menu without
794 // disturbing the selection.
795 if ( GetSelectedProperties().size() <= 1 ||
797 return DoSelectAndEdit(prop
, colIndex
, selFlags
);
802 addToExistingSelection
= mouseEvent
->ShiftDown();
807 addToExistingSelection
= false;
812 addToExistingSelection
= false;
815 if ( addToExistingSelection
)
817 if ( !alreadySelected
)
819 res
= DoAddToSelection(prop
, selFlags
);
821 else if ( GetSelectedProperties().size() > 1 )
823 res
= DoRemoveFromSelection(prop
, selFlags
);
828 res
= DoSelectAndEdit(prop
, colIndex
, selFlags
);
834 // -----------------------------------------------------------------------
836 void wxPropertyGrid::DoSetSelection( const wxArrayPGProperty
& newSelection
,
839 if ( newSelection
.size() > 0 )
841 if ( !DoSelectProperty(newSelection
[0], selFlags
) )
846 DoClearSelection(false, selFlags
);
849 for ( unsigned int i
= 1; i
< newSelection
.size(); i
++ )
851 DoAddToSelection(newSelection
[i
], selFlags
);
857 // -----------------------------------------------------------------------
859 void wxPropertyGrid::MakeColumnEditable( unsigned int column
,
862 wxASSERT( column
!= 1 );
864 wxArrayInt
& cols
= m_pState
->m_editableColumns
;
868 cols
.push_back(column
);
872 for ( int i
= cols
.size() - 1; i
> 0; i
-- )
874 if ( cols
[i
] == (int)column
)
875 cols
.erase( cols
.begin() + i
);
880 // -----------------------------------------------------------------------
882 void wxPropertyGrid::DoBeginLabelEdit( unsigned int colIndex
,
885 wxPGProperty
* selected
= GetSelection();
886 wxCHECK_RET(selected
, wxT("No property selected"));
887 wxCHECK_RET(colIndex
!= 1, wxT("Do not use this for column 1"));
889 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
891 if ( SendEvent( wxEVT_PG_LABEL_EDIT_BEGIN
,
898 const wxPGCell
* cell
= NULL
;
899 if ( selected
->HasCell(colIndex
) )
901 cell
= &selected
->GetCell(colIndex
);
902 if ( !cell
->HasText() && colIndex
== 0 )
903 text
= selected
->GetLabel();
909 text
= selected
->GetLabel();
911 cell
= &selected
->GetOrCreateCell(colIndex
);
914 if ( cell
&& cell
->HasText() )
915 text
= cell
->GetText();
917 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
); // send event
919 m_selColumn
= colIndex
;
921 wxRect r
= GetEditorWidgetRect(selected
, m_selColumn
);
923 wxWindow
* tc
= GenerateEditorTextCtrl(r
.GetPosition(),
931 wxWindowID id
= tc
->GetId();
932 tc
->Connect(id
, wxEVT_COMMAND_TEXT_ENTER
,
933 wxCommandEventHandler(wxPropertyGrid::OnLabelEditorEnterPress
),
935 tc
->Connect(id
, wxEVT_KEY_DOWN
,
936 wxKeyEventHandler(wxPropertyGrid::OnLabelEditorKeyPress
),
941 m_labelEditor
= wxStaticCast(tc
, wxTextCtrl
);
942 m_labelEditorProperty
= selected
;
945 // -----------------------------------------------------------------------
948 wxPropertyGrid::OnLabelEditorEnterPress( wxCommandEvent
& WXUNUSED(event
) )
950 DoEndLabelEdit(true);
953 // -----------------------------------------------------------------------
955 void wxPropertyGrid::OnLabelEditorKeyPress( wxKeyEvent
& event
)
957 int keycode
= event
.GetKeyCode();
959 if ( keycode
== WXK_ESCAPE
)
961 DoEndLabelEdit(false);
969 // -----------------------------------------------------------------------
971 void wxPropertyGrid::DoEndLabelEdit( bool commit
, int selFlags
)
973 if ( !m_labelEditor
)
976 wxPGProperty
* prop
= m_labelEditorProperty
;
981 if ( !(selFlags
& wxPG_SEL_DONT_SEND_EVENT
) )
983 // wxPG_SEL_NOVALIDATE is passed correctly in selFlags
984 if ( SendEvent( wxEVT_PG_LABEL_EDIT_ENDING
,
985 prop
, NULL
, selFlags
,
990 wxString text
= m_labelEditor
->GetValue();
991 wxPGCell
* cell
= NULL
;
992 if ( prop
->HasCell(m_selColumn
) )
994 cell
= &prop
->GetCell(m_selColumn
);
998 if ( m_selColumn
== 0 )
999 prop
->SetLabel(text
);
1001 cell
= &prop
->GetOrCreateCell(m_selColumn
);
1005 cell
->SetText(text
);
1010 DestroyEditorWnd(m_labelEditor
);
1011 m_labelEditor
= NULL
;
1012 m_labelEditorProperty
= NULL
;
1017 // -----------------------------------------------------------------------
1019 void wxPropertyGrid::SetExtraStyle( long exStyle
)
1021 if ( exStyle
& wxPG_EX_ENABLE_TLP_TRACKING
)
1022 OnTLPChanging(::wxGetTopLevelParent(this));
1024 OnTLPChanging(NULL
);
1026 if ( exStyle
& wxPG_EX_NATIVE_DOUBLE_BUFFERING
)
1028 #if defined(__WXMSW__)
1031 // Don't use WS_EX_COMPOSITED just now.
1034 if ( m_iFlags & wxPG_FL_IN_MANAGER )
1035 hWnd = (HWND)GetParent()->GetHWND();
1037 hWnd = (HWND)GetHWND();
1039 ::SetWindowLong( hWnd, GWL_EXSTYLE,
1040 ::GetWindowLong(hWnd, GWL_EXSTYLE) | WS_EX_COMPOSITED );
1043 //#elif defined(__WXGTK20__)
1045 // Only apply wxPG_EX_NATIVE_DOUBLE_BUFFERING if the window
1046 // truly was double-buffered.
1047 if ( !this->IsDoubleBuffered() )
1049 exStyle
&= ~(wxPG_EX_NATIVE_DOUBLE_BUFFERING
);
1053 #if wxPG_DOUBLE_BUFFER
1054 delete m_doubleBuffer
;
1055 m_doubleBuffer
= NULL
;
1060 wxScrolledWindow::SetExtraStyle( exStyle
);
1062 if ( exStyle
& wxPG_EX_INIT_NOCAT
)
1063 m_pState
->InitNonCatMode();
1065 if ( exStyle
& wxPG_EX_HELP_AS_TOOLTIPS
)
1066 m_windowStyle
|= wxPG_TOOLTIPS
;
1069 wxPGGlobalVars
->m_extraStyle
= exStyle
;
1072 // -----------------------------------------------------------------------
1074 // returns the best acceptable minimal size
1075 wxSize
wxPropertyGrid::DoGetBestSize() const
1077 int lineHeight
= wxMax(15, m_lineHeight
);
1079 // don't make the grid too tall (limit height to 10 items) but don't
1080 // make it too small neither
1081 int numLines
= wxMin
1083 wxMax(m_pState
->m_properties
->GetChildCount(), 3),
1087 wxClientDC
dc(const_cast<wxPropertyGrid
*>(this));
1088 int width
= m_marginWidth
;
1089 for ( unsigned int i
= 0; i
< m_pState
->m_colWidths
.size(); i
++ )
1091 width
+= m_pState
->GetColumnFitWidth(dc
, m_pState
->DoGetRoot(), i
, true);
1094 const wxSize sz
= wxSize(width
, lineHeight
*numLines
+ 40);
1100 // -----------------------------------------------------------------------
1102 void wxPropertyGrid::OnTLPChanging( wxWindow
* newTLP
)
1104 if ( newTLP
== m_tlp
)
1107 wxLongLong currentTime
= ::wxGetLocalTimeMillis();
1110 // Parent changed so let's redetermine and re-hook the
1111 // correct top-level window.
1114 m_tlp
->Disconnect( wxEVT_CLOSE_WINDOW
,
1115 wxCloseEventHandler(wxPropertyGrid::OnTLPClose
),
1117 m_tlpClosed
= m_tlp
;
1118 m_tlpClosedTime
= currentTime
;
1123 // Only accept new tlp if same one was not just dismissed.
1124 if ( newTLP
!= m_tlpClosed
||
1125 m_tlpClosedTime
+250 < currentTime
)
1127 newTLP
->Connect( wxEVT_CLOSE_WINDOW
,
1128 wxCloseEventHandler(wxPropertyGrid::OnTLPClose
),
1141 // -----------------------------------------------------------------------
1143 void wxPropertyGrid::OnTLPClose( wxCloseEvent
& event
)
1145 // ClearSelection forces value validation/commit.
1146 if ( event
.CanVeto() && !DoClearSelection() )
1152 // Ok, it can close, set tlp pointer to NULL. Some other event
1153 // handler can of course veto the close, but our OnIdle() should
1154 // then be able to regain the tlp pointer.
1155 OnTLPChanging(NULL
);
1160 // -----------------------------------------------------------------------
1162 bool wxPropertyGrid::Reparent( wxWindowBase
*newParent
)
1164 OnTLPChanging((wxWindow
*)newParent
);
1166 bool res
= wxScrolledWindow::Reparent(newParent
);
1171 // -----------------------------------------------------------------------
1172 // wxPropertyGrid Font and Colour Methods
1173 // -----------------------------------------------------------------------
1175 void wxPropertyGrid::CalculateFontAndBitmapStuff( int vspacing
)
1179 m_captionFont
= wxScrolledWindow::GetFont();
1181 GetTextExtent(wxS("jG"), &x
, &y
, 0, 0, &m_captionFont
);
1182 m_subgroup_extramargin
= x
+ (x
/2);
1185 #if wxPG_USE_RENDERER_NATIVE
1186 m_iconWidth
= wxPG_ICON_WIDTH
;
1187 #elif wxPG_ICON_WIDTH
1189 m_iconWidth
= (m_fontHeight
* wxPG_ICON_WIDTH
) / 13;
1190 if ( m_iconWidth
< 5 ) m_iconWidth
= 5;
1191 else if ( !(m_iconWidth
& 0x01) ) m_iconWidth
++; // must be odd
1195 m_gutterWidth
= m_iconWidth
/ wxPG_GUTTER_DIV
;
1196 if ( m_gutterWidth
< wxPG_GUTTER_MIN
)
1197 m_gutterWidth
= wxPG_GUTTER_MIN
;
1200 if ( vspacing
<= 1 ) vdiv
= 12;
1201 else if ( vspacing
>= 3 ) vdiv
= 3;
1203 m_spacingy
= m_fontHeight
/ vdiv
;
1204 if ( m_spacingy
< wxPG_YSPACING_MIN
)
1205 m_spacingy
= wxPG_YSPACING_MIN
;
1208 if ( !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
1209 m_marginWidth
= m_gutterWidth
*2 + m_iconWidth
;
1211 m_captionFont
.SetWeight(wxBOLD
);
1212 GetTextExtent(wxS("jG"), &x
, &y
, 0, 0, &m_captionFont
);
1214 m_lineHeight
= m_fontHeight
+(2*m_spacingy
)+1;
1217 m_buttonSpacingY
= (m_lineHeight
- m_iconHeight
) / 2;
1218 if ( m_buttonSpacingY
< 0 ) m_buttonSpacingY
= 0;
1221 m_pState
->CalculateFontAndBitmapStuff(vspacing
);
1223 if ( m_iFlags
& wxPG_FL_INITIALIZED
)
1224 RecalculateVirtualSize();
1226 InvalidateBestSize();
1229 // -----------------------------------------------------------------------
1231 void wxPropertyGrid::OnSysColourChanged( wxSysColourChangedEvent
&WXUNUSED(event
) )
1237 // -----------------------------------------------------------------------
1239 static wxColour
wxPGAdjustColour(const wxColour
& src
, int ra
,
1240 int ga
= 1000, int ba
= 1000,
1241 bool forceDifferent
= false)
1248 // Recursion guard (allow 2 max)
1249 static int isinside
= 0;
1251 wxCHECK_MSG( isinside
< 3,
1253 wxT("wxPGAdjustColour should not be recursively called more than once") );
1258 int g
= src
.Green();
1261 if ( r2
>255 ) r2
= 255;
1262 else if ( r2
<0) r2
= 0;
1264 if ( g2
>255 ) g2
= 255;
1265 else if ( g2
<0) g2
= 0;
1267 if ( b2
>255 ) b2
= 255;
1268 else if ( b2
<0) b2
= 0;
1270 // Make sure they are somewhat different
1271 if ( forceDifferent
&& (abs((r
+g
+b
)-(r2
+g2
+b2
)) < abs(ra
/2)) )
1272 dst
= wxPGAdjustColour(src
,-(ra
*2));
1274 dst
= wxColour(r2
,g2
,b2
);
1276 // Recursion guard (allow 2 max)
1283 static int wxPGGetColAvg( const wxColour
& col
)
1285 return (col
.Red() + col
.Green() + col
.Blue()) / 3;
1289 void wxPropertyGrid::RegainColours()
1291 if ( !(m_coloursCustomized
& 0x0002) )
1293 wxColour col
= wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE
);
1295 // Make sure colour is dark enough
1297 int colDec
= wxPGGetColAvg(col
) - 230;
1299 int colDec
= wxPGGetColAvg(col
) - 200;
1302 m_colCapBack
= wxPGAdjustColour(col
,-colDec
);
1305 m_categoryDefaultCell
.GetData()->SetBgCol(m_colCapBack
);
1308 if ( !(m_coloursCustomized
& 0x0001) )
1309 m_colMargin
= m_colCapBack
;
1311 if ( !(m_coloursCustomized
& 0x0004) )
1318 wxColour capForeCol
= wxPGAdjustColour(m_colCapBack
,colDec
,5000,5000,true);
1319 m_colCapFore
= capForeCol
;
1320 m_categoryDefaultCell
.GetData()->SetFgCol(capForeCol
);
1323 if ( !(m_coloursCustomized
& 0x0008) )
1325 wxColour bgCol
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW
);
1326 m_colPropBack
= bgCol
;
1327 m_propertyDefaultCell
.GetData()->SetBgCol(bgCol
);
1330 if ( !(m_coloursCustomized
& 0x0010) )
1332 wxColour fgCol
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT
);
1333 m_colPropFore
= fgCol
;
1334 m_propertyDefaultCell
.GetData()->SetFgCol(fgCol
);
1337 if ( !(m_coloursCustomized
& 0x0020) )
1338 m_colSelBack
= wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT
);
1340 if ( !(m_coloursCustomized
& 0x0040) )
1341 m_colSelFore
= wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHTTEXT
);
1343 if ( !(m_coloursCustomized
& 0x0080) )
1344 m_colLine
= m_colCapBack
;
1346 if ( !(m_coloursCustomized
& 0x0100) )
1347 m_colDisPropFore
= m_colCapFore
;
1349 m_colEmptySpace
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW
);
1352 // -----------------------------------------------------------------------
1354 void wxPropertyGrid::ResetColours()
1356 m_coloursCustomized
= 0;
1363 // -----------------------------------------------------------------------
1365 bool wxPropertyGrid::SetFont( const wxFont
& font
)
1367 // Must disable active editor.
1370 bool res
= wxScrolledWindow::SetFont( font
);
1371 if ( res
&& GetParent()) // may not have been Create()ed yet if SetFont called from SetWindowVariant
1373 CalculateFontAndBitmapStuff( m_vspacing
);
1380 // -----------------------------------------------------------------------
1382 void wxPropertyGrid::SetLineColour( const wxColour
& col
)
1385 m_coloursCustomized
|= 0x80;
1389 // -----------------------------------------------------------------------
1391 void wxPropertyGrid::SetMarginColour( const wxColour
& col
)
1394 m_coloursCustomized
|= 0x01;
1398 // -----------------------------------------------------------------------
1400 void wxPropertyGrid::SetCellBackgroundColour( const wxColour
& col
)
1402 m_colPropBack
= col
;
1403 m_coloursCustomized
|= 0x08;
1405 m_propertyDefaultCell
.GetData()->SetBgCol(col
);
1410 // -----------------------------------------------------------------------
1412 void wxPropertyGrid::SetCellTextColour( const wxColour
& col
)
1414 m_colPropFore
= col
;
1415 m_coloursCustomized
|= 0x10;
1417 m_propertyDefaultCell
.GetData()->SetFgCol(col
);
1422 // -----------------------------------------------------------------------
1424 void wxPropertyGrid::SetEmptySpaceColour( const wxColour
& col
)
1426 m_colEmptySpace
= col
;
1431 // -----------------------------------------------------------------------
1433 void wxPropertyGrid::SetCellDisabledTextColour( const wxColour
& col
)
1435 m_colDisPropFore
= col
;
1436 m_coloursCustomized
|= 0x100;
1440 // -----------------------------------------------------------------------
1442 void wxPropertyGrid::SetSelectionBackgroundColour( const wxColour
& col
)
1445 m_coloursCustomized
|= 0x20;
1449 // -----------------------------------------------------------------------
1451 void wxPropertyGrid::SetSelectionTextColour( const wxColour
& col
)
1454 m_coloursCustomized
|= 0x40;
1458 // -----------------------------------------------------------------------
1460 void wxPropertyGrid::SetCaptionBackgroundColour( const wxColour
& col
)
1463 m_coloursCustomized
|= 0x02;
1465 m_categoryDefaultCell
.GetData()->SetBgCol(col
);
1470 // -----------------------------------------------------------------------
1472 void wxPropertyGrid::SetCaptionTextColour( const wxColour
& col
)
1475 m_coloursCustomized
|= 0x04;
1477 m_categoryDefaultCell
.GetData()->SetFgCol(col
);
1482 // -----------------------------------------------------------------------
1483 // wxPropertyGrid property adding and removal
1484 // -----------------------------------------------------------------------
1486 void wxPropertyGrid::PrepareAfterItemsAdded()
1488 if ( !m_pState
|| !m_pState
->m_itemsAdded
) return;
1490 m_pState
->m_itemsAdded
= 0;
1492 if ( m_windowStyle
& wxPG_AUTO_SORT
)
1493 Sort(wxPG_SORT_TOP_LEVEL_ONLY
);
1495 RecalculateVirtualSize();
1498 // -----------------------------------------------------------------------
1499 // wxPropertyGrid property operations
1500 // -----------------------------------------------------------------------
1502 bool wxPropertyGrid::EnsureVisible( wxPGPropArg id
)
1504 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
1508 bool changed
= false;
1510 // Is it inside collapsed section?
1511 if ( !p
->IsVisible() )
1514 wxPGProperty
* parent
= p
->GetParent();
1515 wxPGProperty
* grandparent
= parent
->GetParent();
1517 if ( grandparent
&& grandparent
!= m_pState
->m_properties
)
1518 Expand( grandparent
);
1526 GetViewStart(&vx
,&vy
);
1527 vy
*=wxPG_PIXELS_PER_UNIT
;
1533 Scroll(vx
, y
/wxPG_PIXELS_PER_UNIT
);
1534 m_iFlags
|= wxPG_FL_SCROLLED
;
1537 else if ( (y
+m_lineHeight
) > (vy
+m_height
) )
1539 Scroll(vx
, (y
-m_height
+(m_lineHeight
*2))/wxPG_PIXELS_PER_UNIT
);
1540 m_iFlags
|= wxPG_FL_SCROLLED
;
1550 // -----------------------------------------------------------------------
1551 // wxPropertyGrid helper methods called by properties
1552 // -----------------------------------------------------------------------
1554 // Control font changer helper.
1555 void wxPropertyGrid::SetCurControlBoldFont()
1557 wxASSERT( m_wndEditor
);
1558 m_wndEditor
->SetFont( m_captionFont
);
1561 // -----------------------------------------------------------------------
1563 wxPoint
wxPropertyGrid::GetGoodEditorDialogPosition( wxPGProperty
* p
,
1566 #if wxPG_SMALL_SCREEN
1567 // On small-screen devices, always show dialogs with default position and size.
1568 return wxDefaultPosition
;
1570 int splitterX
= GetSplitterPosition();
1574 wxCHECK_MSG( y
>= 0, wxPoint(-1,-1), wxT("invalid y?") );
1576 ImprovedClientToScreen( &x
, &y
);
1578 int sw
= wxSystemSettings::GetMetric( ::wxSYS_SCREEN_X
);
1579 int sh
= wxSystemSettings::GetMetric( ::wxSYS_SCREEN_Y
);
1586 new_x
= x
+ (m_width
-splitterX
) - sz
.x
;
1596 new_y
= y
+ m_lineHeight
;
1598 return wxPoint(new_x
,new_y
);
1602 // -----------------------------------------------------------------------
1604 wxString
& wxPropertyGrid::ExpandEscapeSequences( wxString
& dst_str
, wxString
& src_str
)
1606 if ( src_str
.length() == 0 )
1612 bool prev_is_slash
= false;
1614 wxString::const_iterator i
= src_str
.begin();
1618 for ( ; i
!= src_str
.end(); ++i
)
1622 if ( a
!= wxS('\\') )
1624 if ( !prev_is_slash
)
1630 if ( a
== wxS('n') )
1633 dst_str
<< wxS('\n');
1635 dst_str
<< wxS('\n');
1638 else if ( a
== wxS('t') )
1639 dst_str
<< wxS('\t');
1643 prev_is_slash
= false;
1647 if ( prev_is_slash
)
1649 dst_str
<< wxS('\\');
1650 prev_is_slash
= false;
1654 prev_is_slash
= true;
1661 // -----------------------------------------------------------------------
1663 wxString
& wxPropertyGrid::CreateEscapeSequences( wxString
& dst_str
, wxString
& src_str
)
1665 if ( src_str
.length() == 0 )
1671 wxString::const_iterator i
= src_str
.begin();
1672 wxUniChar prev_a
= wxS('\0');
1676 for ( ; i
!= src_str
.end(); ++i
)
1680 if ( a
>= wxS(' ') )
1682 // This surely is not something that requires an escape sequence.
1687 // This might need...
1688 if ( a
== wxS('\r') )
1690 // DOS style line end.
1691 // Already taken care below
1693 else if ( a
== wxS('\n') )
1694 // UNIX style line end.
1695 dst_str
<< wxS("\\n");
1696 else if ( a
== wxS('\t') )
1698 dst_str
<< wxS('\t');
1701 //wxLogDebug(wxT("WARNING: Could not create escape sequence for character #%i"),(int)a);
1711 // -----------------------------------------------------------------------
1713 wxPGProperty
* wxPropertyGrid::DoGetItemAtY( int y
) const
1720 return m_pState
->m_properties
->GetItemAtY(y
, m_lineHeight
, &a
);
1723 // -----------------------------------------------------------------------
1724 // wxPropertyGrid graphics related methods
1725 // -----------------------------------------------------------------------
1727 void wxPropertyGrid::OnPaint( wxPaintEvent
& WXUNUSED(event
) )
1732 // Don't paint after destruction has begun
1733 if ( !HasInternalFlag(wxPG_FL_INITIALIZED
) )
1736 // Find out where the window is scrolled to
1737 int vx
,vy
; // Top left corner of client
1738 GetViewStart(&vx
,&vy
);
1739 vy
*= wxPG_PIXELS_PER_UNIT
;
1741 // Update everything inside the box
1742 wxRect r
= GetUpdateRegion().GetBox();
1746 // FIXME: This is just a workaround for a bug that causes splitters not
1747 // to paint when other windows are being dragged over the grid.
1748 wxRect fullRect
= GetRect();
1750 r
.width
= fullRect
.width
;
1752 // Repaint this rectangle
1753 DrawItems( dc
, r
.y
, r
.y
+ r
.height
, &r
);
1755 // We assume that the size set when grid is shown
1756 // is what is desired.
1757 SetInternalFlag(wxPG_FL_GOOD_SIZE_SET
);
1760 // -----------------------------------------------------------------------
1762 void wxPropertyGrid::DrawExpanderButton( wxDC
& dc
, const wxRect
& rect
,
1763 wxPGProperty
* property
) const
1765 // Prepare rectangle to be used
1767 r
.x
+= m_gutterWidth
; r
.y
+= m_buttonSpacingY
;
1768 r
.width
= m_iconWidth
; r
.height
= m_iconHeight
;
1770 #if (wxPG_USE_RENDERER_NATIVE)
1772 #elif wxPG_ICON_WIDTH
1773 // Drawing expand/collapse button manually
1774 dc
.SetPen(m_colPropFore
);
1775 if ( property
->IsCategory() )
1776 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
1778 dc
.SetBrush(m_colPropBack
);
1780 dc
.DrawRectangle( r
);
1781 int _y
= r
.y
+(m_iconWidth
/2);
1782 dc
.DrawLine(r
.x
+2,_y
,r
.x
+m_iconWidth
-2,_y
);
1787 if ( property
->IsExpanded() )
1789 // wxRenderer functions are non-mutating in nature, so it
1790 // should be safe to cast "const wxPropertyGrid*" to "wxWindow*".
1791 // Hopefully this does not cause problems.
1792 #if (wxPG_USE_RENDERER_NATIVE)
1793 wxRendererNative::Get().DrawTreeItemButton(
1799 #elif wxPG_ICON_WIDTH
1808 #if (wxPG_USE_RENDERER_NATIVE)
1809 wxRendererNative::Get().DrawTreeItemButton(
1815 #elif wxPG_ICON_WIDTH
1816 int _x
= r
.x
+(m_iconWidth
/2);
1817 dc
.DrawLine(_x
,r
.y
+2,_x
,r
.y
+m_iconWidth
-2);
1823 #if (wxPG_USE_RENDERER_NATIVE)
1825 #elif wxPG_ICON_WIDTH
1828 dc
.DrawBitmap( *bmp
, r
.x
, r
.y
, true );
1832 // -----------------------------------------------------------------------
1835 // This is the one called by OnPaint event handler and others.
1836 // topy and bottomy are already unscrolled (ie. physical)
1838 void wxPropertyGrid::DrawItems( wxDC
& dc
,
1839 unsigned int topItemY
,
1840 unsigned int bottomItemY
,
1841 const wxRect
* drawRect
)
1845 bottomItemY
< topItemY
||
1849 m_pState
->EnsureVirtualHeight();
1851 wxRect tempDrawRect
;
1854 tempDrawRect
= wxRect(0, topItemY
,
1857 drawRect
= &tempDrawRect
;
1860 // items added check
1861 if ( m_pState
->m_itemsAdded
) PrepareAfterItemsAdded();
1863 int paintFinishY
= 0;
1865 if ( m_pState
->m_properties
->GetChildCount() > 0 )
1868 bool isBuffered
= false;
1870 #if wxPG_DOUBLE_BUFFER
1871 wxMemoryDC
* bufferDC
= NULL
;
1873 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING
) )
1875 if ( !m_doubleBuffer
)
1877 paintFinishY
= drawRect
->y
;
1882 bufferDC
= new wxMemoryDC();
1884 // If nothing was changed, then just copy from double-buffer
1885 bufferDC
->SelectObject( *m_doubleBuffer
);
1895 dc
.SetClippingRegion( *drawRect
);
1896 paintFinishY
= DoDrawItems( *dcPtr
, drawRect
, isBuffered
);
1897 int drawBottomY
= drawRect
->y
+ drawRect
->height
;
1899 // Clear area beyond last painted property
1900 if ( paintFinishY
< drawBottomY
)
1902 dcPtr
->SetPen(m_colEmptySpace
);
1903 dcPtr
->SetBrush(m_colEmptySpace
);
1904 dcPtr
->DrawRectangle(0, paintFinishY
,
1909 dc
.DestroyClippingRegion();
1912 #if wxPG_DOUBLE_BUFFER
1915 dc
.Blit( drawRect
->x
, drawRect
->y
, drawRect
->width
,
1917 bufferDC
, 0, 0, wxCOPY
);
1924 // Just clear the area
1925 dc
.SetPen(m_colEmptySpace
);
1926 dc
.SetBrush(m_colEmptySpace
);
1927 dc
.DrawRectangle(*drawRect
);
1931 // -----------------------------------------------------------------------
1933 int wxPropertyGrid::DoDrawItems( wxDC
& dc
,
1934 const wxRect
* drawRect
,
1935 bool isBuffered
) const
1937 const wxPGProperty
* firstItem
;
1938 const wxPGProperty
* lastItem
;
1940 firstItem
= DoGetItemAtY(drawRect
->y
);
1941 lastItem
= DoGetItemAtY(drawRect
->y
+drawRect
->height
-1);
1944 lastItem
= GetLastItem( wxPG_ITERATE_VISIBLE
);
1946 if ( m_frozen
|| m_height
< 1 || firstItem
== NULL
)
1949 wxCHECK_MSG( !m_pState
->m_itemsAdded
, drawRect
->y
,
1951 wxASSERT( m_pState
->m_properties
->GetChildCount() );
1953 int lh
= m_lineHeight
;
1956 int lastItemBottomY
;
1958 firstItemTopY
= drawRect
->y
;
1959 lastItemBottomY
= drawRect
->y
+ drawRect
->height
;
1961 // Align y coordinates to item boundaries
1962 firstItemTopY
-= firstItemTopY
% lh
;
1963 lastItemBottomY
+= lh
- (lastItemBottomY
% lh
);
1964 lastItemBottomY
-= 1;
1966 // Entire range outside scrolled, visible area?
1967 if ( firstItemTopY
>= (int)m_pState
->GetVirtualHeight() ||
1968 lastItemBottomY
<= 0 )
1971 wxCHECK_MSG( firstItemTopY
< lastItemBottomY
,
1973 "invalid y values" );
1976 wxLogDebug(" -> DoDrawItems ( \"%s\" -> \"%s\"
1977 "height=%i (ch=%i), drawRect = 0x%lX )",
1978 firstItem->GetLabel().c_str(),
1979 lastItem->GetLabel().c_str(),
1980 (int)(lastItemBottomY - firstItemTopY),
1982 (unsigned long)drawRect );
1987 long windowStyle
= m_windowStyle
;
1992 // With wxPG_DOUBLE_BUFFER, do double buffering
1993 // - buffer's y = 0, so align drawRect and coordinates to that
1995 #if wxPG_DOUBLE_BUFFER
2002 xRelMod
= drawRect
->x
;
2003 yRelMod
= drawRect
->y
;
2006 // drawRect conversion
2011 firstItemTopY
-= yRelMod
;
2012 lastItemBottomY
-= yRelMod
;
2015 wxUnusedVar(isBuffered
);
2018 int x
= m_marginWidth
- xRelMod
;
2020 wxFont normalFont
= GetFont();
2022 bool reallyFocused
= (m_iFlags
& wxPG_FL_FOCUSED
) != 0;
2024 bool isPgEnabled
= IsEnabled();
2027 // Prepare some pens and brushes that are often changed to.
2030 wxBrush
marginBrush(m_colMargin
);
2031 wxPen
marginPen(m_colMargin
);
2032 wxBrush
capbgbrush(m_colCapBack
,wxSOLID
);
2033 wxPen
linepen(m_colLine
,1,wxSOLID
);
2035 wxColour selBackCol
;
2037 selBackCol
= m_colSelBack
;
2039 selBackCol
= m_colMargin
;
2041 // pen that has same colour as text
2042 wxPen
outlinepen(m_colPropFore
,1,wxSOLID
);
2045 // Clear margin with background colour
2047 dc
.SetBrush( marginBrush
);
2048 if ( !(windowStyle
& wxPG_HIDE_MARGIN
) )
2050 dc
.SetPen( *wxTRANSPARENT_PEN
);
2051 dc
.DrawRectangle(-1-xRelMod
,firstItemTopY
-1,x
+2,lastItemBottomY
-firstItemTopY
+2);
2054 const wxPGProperty
* firstSelected
= GetSelection();
2055 const wxPropertyGridPageState
* state
= m_pState
;
2057 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2058 bool wasSelectedPainted
= false;
2061 // TODO: Only render columns that are within clipping region.
2063 dc
.SetFont(normalFont
);
2065 wxPropertyGridConstIterator
it( state
, wxPG_ITERATE_VISIBLE
, firstItem
);
2066 int endScanBottomY
= lastItemBottomY
+ lh
;
2067 int y
= firstItemTopY
;
2070 // Pregenerate list of visible properties.
2071 wxArrayPGProperty visPropArray
;
2072 visPropArray
.reserve((m_height
/m_lineHeight
)+6);
2074 for ( ; !it
.AtEnd(); it
.Next() )
2076 const wxPGProperty
* p
= *it
;
2078 if ( !p
->HasFlag(wxPG_PROP_HIDDEN
) )
2080 visPropArray
.push_back((wxPGProperty
*)p
);
2082 if ( y
> endScanBottomY
)
2089 visPropArray
.push_back(NULL
);
2091 wxPGProperty
* nextP
= visPropArray
[0];
2093 int gridWidth
= state
->m_width
;
2096 for ( unsigned int arrInd
=1;
2097 nextP
&& y
<= lastItemBottomY
;
2100 wxPGProperty
* p
= nextP
;
2101 nextP
= visPropArray
[arrInd
];
2103 int rowHeight
= m_fontHeight
+(m_spacingy
*2)+1;
2104 int textMarginHere
= x
;
2105 int renderFlags
= 0;
2107 int greyDepth
= m_marginWidth
;
2108 if ( !(windowStyle
& wxPG_HIDE_CATEGORIES
) )
2109 greyDepth
= (((int)p
->m_depthBgCol
)-1) * m_subgroup_extramargin
+ m_marginWidth
;
2111 int greyDepthX
= greyDepth
- xRelMod
;
2113 // Use basic depth if in non-categoric mode and parent is base array.
2114 if ( !(windowStyle
& wxPG_HIDE_CATEGORIES
) || p
->GetParent() != m_pState
->m_properties
)
2116 textMarginHere
+= ((unsigned int)((p
->m_depth
-1)*m_subgroup_extramargin
));
2119 // Paint margin area
2120 dc
.SetBrush(marginBrush
);
2121 dc
.SetPen(marginPen
);
2122 dc
.DrawRectangle( -xRelMod
, y
, greyDepth
, lh
);
2124 dc
.SetPen( linepen
);
2130 // Modified by JACS to not draw a margin if wxPG_HIDE_MARGIN is specified, since it
2131 // looks better, at least under Windows when we have a themed border (the themed-window-specific
2132 // whitespace between the real border and the propgrid margin exacerbates the double-border look).
2134 // Is this or its parent themed?
2135 bool suppressMarginEdge
= (GetWindowStyle() & wxPG_HIDE_MARGIN
) &&
2136 (((GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_THEME
) ||
2137 (((GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_NONE
) && ((GetParent()->GetWindowStyle() & wxBORDER_MASK
) == wxBORDER_THEME
)));
2139 bool suppressMarginEdge
= false;
2141 if (!suppressMarginEdge
)
2142 dc
.DrawLine( greyDepthX
, y
, greyDepthX
, y2
);
2145 // Blank out the margin edge
2146 dc
.SetPen(wxPen(GetBackgroundColour()));
2147 dc
.DrawLine( greyDepthX
, y
, greyDepthX
, y2
);
2148 dc
.SetPen( linepen
);
2155 for ( si
=0; si
<state
->m_colWidths
.size(); si
++ )
2157 sx
+= state
->m_colWidths
[si
];
2158 dc
.DrawLine( sx
, y
, sx
, y2
);
2161 // Horizontal Line, below
2162 // (not if both this and next is category caption)
2163 if ( p
->IsCategory() &&
2164 nextP
&& nextP
->IsCategory() )
2165 dc
.SetPen(m_colCapBack
);
2167 dc
.DrawLine( greyDepthX
, y2
-1, gridWidth
-xRelMod
, y2
-1 );
2170 // Need to override row colours?
2174 bool isSelected
= state
->DoIsPropertySelected(p
);
2178 // Disabled may get different colour.
2179 if ( !p
->IsEnabled() )
2181 renderFlags
|= wxPGCellRenderer::Disabled
|
2182 wxPGCellRenderer::DontUseCellFgCol
;
2183 rowFgCol
= m_colDisPropFore
;
2188 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2189 if ( p
== firstSelected
)
2190 wasSelectedPainted
= true;
2193 renderFlags
|= wxPGCellRenderer::Selected
;
2195 if ( !p
->IsCategory() )
2197 renderFlags
|= wxPGCellRenderer::DontUseCellFgCol
|
2198 wxPGCellRenderer::DontUseCellBgCol
;
2200 if ( reallyFocused
&& p
== firstSelected
)
2202 rowFgCol
= m_colSelFore
;
2203 rowBgCol
= selBackCol
;
2205 else if ( isPgEnabled
)
2207 rowFgCol
= m_colPropFore
;
2208 if ( p
== firstSelected
)
2209 rowBgCol
= m_colMargin
;
2211 rowBgCol
= selBackCol
;
2215 rowFgCol
= m_colDisPropFore
;
2216 rowBgCol
= selBackCol
;
2223 if ( rowBgCol
.IsOk() )
2224 rowBgBrush
= wxBrush(rowBgCol
);
2226 if ( HasInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
) )
2227 renderFlags
= renderFlags
& ~wxPGCellRenderer::DontUseCellColours
;
2230 // Fill additional margin area with background colour of first cell
2231 if ( greyDepthX
< textMarginHere
)
2233 if ( !(renderFlags
& wxPGCellRenderer::DontUseCellBgCol
) )
2235 wxPGCell
& cell
= p
->GetCell(0);
2236 rowBgCol
= cell
.GetBgCol();
2237 rowBgBrush
= wxBrush(rowBgCol
);
2239 dc
.SetBrush(rowBgBrush
);
2240 dc
.SetPen(rowBgCol
);
2241 dc
.DrawRectangle(greyDepthX
+1, y
,
2242 textMarginHere
-greyDepthX
, lh
-1);
2245 bool fontChanged
= false;
2247 // Expander button rectangle
2248 wxRect
butRect( ((p
->m_depth
- 1) * m_subgroup_extramargin
) - xRelMod
,
2253 if ( p
->IsCategory() )
2255 // Captions have their cell areas merged as one
2256 dc
.SetFont(m_captionFont
);
2258 wxRect
cellRect(greyDepthX
, y
, gridWidth
- greyDepth
+ 2, rowHeight
-1 );
2260 if ( renderFlags
& wxPGCellRenderer::DontUseCellBgCol
)
2262 dc
.SetBrush(rowBgBrush
);
2263 dc
.SetPen(rowBgCol
);
2266 if ( renderFlags
& wxPGCellRenderer::DontUseCellFgCol
)
2268 dc
.SetTextForeground(rowFgCol
);
2271 wxPGCellRenderer
* renderer
= p
->GetCellRenderer(0);
2272 renderer
->Render( dc
, cellRect
, this, p
, 0, -1, renderFlags
);
2275 if ( !HasFlag(wxPG_HIDE_MARGIN
) && p
->HasVisibleChildren() )
2276 DrawExpanderButton( dc
, butRect
, p
);
2280 // Fine tune button rectangle to actually fit the cell
2281 if ( butRect
.x
> 0 )
2282 butRect
.x
+= IN_CELL_EXPANDER_BUTTON_X_ADJUST
;
2284 if ( p
->m_flags
& wxPG_PROP_MODIFIED
&& (windowStyle
& wxPG_BOLD_MODIFIED
) )
2286 dc
.SetFont(m_captionFont
);
2292 int nextCellWidth
= state
->m_colWidths
[0] -
2293 (greyDepthX
- m_marginWidth
);
2294 wxRect
cellRect(greyDepthX
+1, y
, 0, rowHeight
-1);
2295 int textXAdd
= textMarginHere
- greyDepthX
;
2297 for ( ci
=0; ci
<state
->m_colWidths
.size(); ci
++ )
2299 cellRect
.width
= nextCellWidth
- 1;
2301 wxWindow
* cellEditor
= NULL
;
2302 int cellRenderFlags
= renderFlags
;
2304 // Tree Item Button (must be drawn before clipping is set up)
2305 if ( ci
== 0 && !HasFlag(wxPG_HIDE_MARGIN
) && p
->HasVisibleChildren() )
2306 DrawExpanderButton( dc
, butRect
, p
);
2309 if ( isSelected
&& (ci
== 1 || ci
== m_selColumn
) )
2311 if ( p
== firstSelected
)
2313 if ( ci
== 1 && m_wndEditor
)
2314 cellEditor
= m_wndEditor
;
2315 else if ( ci
== m_selColumn
&& m_labelEditor
)
2316 cellEditor
= m_labelEditor
;
2321 wxColour editorBgCol
=
2322 cellEditor
->GetBackgroundColour();
2323 dc
.SetBrush(editorBgCol
);
2324 dc
.SetPen(editorBgCol
);
2325 dc
.SetTextForeground(m_colPropFore
);
2326 dc
.DrawRectangle(cellRect
);
2328 if ( m_dragStatus
!= 0 ||
2329 (m_iFlags
& wxPG_FL_CUR_USES_CUSTOM_IMAGE
) )
2334 dc
.SetBrush(m_colPropBack
);
2335 dc
.SetPen(m_colPropBack
);
2336 dc
.SetTextForeground(m_colDisPropFore
);
2337 if ( p
->IsEnabled() )
2338 dc
.SetTextForeground(rowFgCol
);
2340 dc
.SetTextForeground(m_colDisPropFore
);
2345 if ( renderFlags
& wxPGCellRenderer::DontUseCellBgCol
)
2347 dc
.SetBrush(rowBgBrush
);
2348 dc
.SetPen(rowBgCol
);
2351 if ( renderFlags
& wxPGCellRenderer::DontUseCellFgCol
)
2353 dc
.SetTextForeground(rowFgCol
);
2357 dc
.SetClippingRegion(cellRect
);
2359 cellRect
.x
+= textXAdd
;
2360 cellRect
.width
-= textXAdd
;
2365 wxPGCellRenderer
* renderer
;
2366 int cmnVal
= p
->GetCommonValue();
2367 if ( cmnVal
== -1 || ci
!= 1 )
2369 renderer
= p
->GetCellRenderer(ci
);
2370 renderer
->Render( dc
, cellRect
, this, p
, ci
, -1,
2375 renderer
= GetCommonValue(cmnVal
)->GetRenderer();
2376 renderer
->Render( dc
, cellRect
, this, p
, ci
, -1,
2381 cellX
+= state
->m_colWidths
[ci
];
2382 if ( ci
< (state
->m_colWidths
.size()-1) )
2383 nextCellWidth
= state
->m_colWidths
[ci
+1];
2385 dc
.DestroyClippingRegion(); // Is this really necessary?
2391 dc
.SetFont(normalFont
);
2396 // Refresh editor controls (seems not needed on msw)
2397 // NOTE: This code is mandatory for GTK!
2398 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2399 if ( wasSelectedPainted
)
2402 m_wndEditor
->Refresh();
2404 m_wndEditor2
->Refresh();
2411 // -----------------------------------------------------------------------
2413 wxRect
wxPropertyGrid::GetPropertyRect( const wxPGProperty
* p1
, const wxPGProperty
* p2
) const
2417 if ( m_width
< 10 || m_height
< 10 ||
2418 !m_pState
->m_properties
->GetChildCount() ||
2420 return wxRect(0,0,0,0);
2425 // Return rect which encloses the given property range
2427 int visTop
= p1
->GetY();
2430 visBottom
= p2
->GetY() + m_lineHeight
;
2432 visBottom
= m_height
+ visTop
;
2434 // If seleced property is inside the range, we'll extend the range to include
2436 wxPGProperty
* selected
= GetSelection();
2439 int selectedY
= selected
->GetY();
2440 if ( selectedY
>= visTop
&& selectedY
< visBottom
)
2442 wxWindow
* editor
= GetEditorControl();
2445 int visBottom2
= selectedY
+ editor
->GetSize().y
;
2446 if ( visBottom2
> visBottom
)
2447 visBottom
= visBottom2
;
2452 return wxRect(0,visTop
-vy
,m_pState
->m_width
,visBottom
-visTop
);
2455 // -----------------------------------------------------------------------
2457 void wxPropertyGrid::DrawItems( const wxPGProperty
* p1
, const wxPGProperty
* p2
)
2462 if ( m_pState
->m_itemsAdded
)
2463 PrepareAfterItemsAdded();
2465 wxRect r
= GetPropertyRect(p1
, p2
);
2472 // -----------------------------------------------------------------------
2474 void wxPropertyGrid::RefreshProperty( wxPGProperty
* p
)
2476 if ( m_pState
->DoIsPropertySelected(p
) )
2478 // NB: We must copy the selection.
2479 wxArrayPGProperty selection
= m_pState
->m_selection
;
2480 DoSetSelection(selection
, wxPG_SEL_FORCE
);
2483 DrawItemAndChildren(p
);
2486 // -----------------------------------------------------------------------
2488 void wxPropertyGrid::DrawItemAndValueRelated( wxPGProperty
* p
)
2493 // Draw item, children, and parent too, if it is not category
2494 wxPGProperty
* parent
= p
->GetParent();
2497 !parent
->IsCategory() &&
2498 parent
->GetParent() )
2501 parent
= parent
->GetParent();
2504 DrawItemAndChildren(p
);
2507 void wxPropertyGrid::DrawItemAndChildren( wxPGProperty
* p
)
2509 wxCHECK_RET( p
, wxT("invalid property id") );
2511 // Do not draw if in non-visible page
2512 if ( p
->GetParentState() != m_pState
)
2515 // do not draw a single item if multiple pending
2516 if ( m_pState
->m_itemsAdded
|| m_frozen
)
2519 // Update child control.
2520 wxPGProperty
* selected
= GetSelection();
2521 if ( selected
&& selected
->GetParent() == p
)
2524 const wxPGProperty
* lastDrawn
= p
->GetLastVisibleSubItem();
2526 DrawItems(p
, lastDrawn
);
2529 // -----------------------------------------------------------------------
2531 void wxPropertyGrid::Refresh( bool WXUNUSED(eraseBackground
),
2532 const wxRect
*rect
)
2534 PrepareAfterItemsAdded();
2536 wxWindow::Refresh(false, rect
);
2538 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2539 // I think this really helps only GTK+1.2
2540 if ( m_wndEditor
) m_wndEditor
->Refresh();
2541 if ( m_wndEditor2
) m_wndEditor2
->Refresh();
2545 // -----------------------------------------------------------------------
2546 // wxPropertyGrid global operations
2547 // -----------------------------------------------------------------------
2549 void wxPropertyGrid::Clear()
2551 m_pState
->DoClear();
2557 RecalculateVirtualSize();
2559 // Need to clear some area at the end
2561 RefreshRect(wxRect(0, 0, m_width
, m_height
));
2564 // -----------------------------------------------------------------------
2566 bool wxPropertyGrid::EnableCategories( bool enable
)
2573 // Enable categories
2576 m_windowStyle
&= ~(wxPG_HIDE_CATEGORIES
);
2581 // Disable categories
2583 m_windowStyle
|= wxPG_HIDE_CATEGORIES
;
2586 if ( !m_pState
->EnableCategories(enable
) )
2591 if ( m_windowStyle
& wxPG_AUTO_SORT
)
2593 m_pState
->m_itemsAdded
= 1; // force
2594 PrepareAfterItemsAdded();
2598 m_pState
->m_itemsAdded
= 1;
2600 // No need for RecalculateVirtualSize() here - it is already called in
2601 // wxPropertyGridPageState method above.
2608 // -----------------------------------------------------------------------
2610 void wxPropertyGrid::SwitchState( wxPropertyGridPageState
* pNewState
)
2612 wxASSERT( pNewState
);
2613 wxASSERT( pNewState
->GetGrid() );
2615 if ( pNewState
== m_pState
)
2618 wxArrayPGProperty oldSelection
= m_pState
->m_selection
;
2620 // Call ClearSelection() instead of DoClearSelection()
2621 // so that selection clear events are not sent.
2624 m_pState
->m_selection
= oldSelection
;
2626 bool orig_mode
= m_pState
->IsInNonCatMode();
2627 bool new_state_mode
= pNewState
->IsInNonCatMode();
2629 m_pState
= pNewState
;
2632 int pgWidth
= GetClientSize().x
;
2633 if ( HasVirtualWidth() )
2635 int minWidth
= pgWidth
;
2636 if ( pNewState
->m_width
< minWidth
)
2638 pNewState
->m_width
= minWidth
;
2639 pNewState
->CheckColumnWidths();
2645 // Just in case, fully re-center splitter
2646 //if ( HasFlag( wxPG_SPLITTER_AUTO_CENTER ) )
2647 // pNewState->m_fSplitterX = -1.0;
2649 pNewState
->OnClientWidthChange(pgWidth
,
2650 pgWidth
- pNewState
->m_width
);
2655 // If necessary, convert state to correct mode.
2656 if ( orig_mode
!= new_state_mode
)
2658 // This should refresh as well.
2659 EnableCategories( orig_mode
?false:true );
2661 else if ( !m_frozen
)
2663 // Refresh, if not frozen.
2664 m_pState
->PrepareAfterItemsAdded();
2666 // Reselect (Use SetSelection() instead of Do-variant so that
2667 // events won't be sent).
2668 SetSelection(m_pState
->m_selection
);
2670 RecalculateVirtualSize(0);
2674 m_pState
->m_itemsAdded
= 1;
2677 // -----------------------------------------------------------------------
2679 // Call to SetSplitterPosition will always disable splitter auto-centering
2680 // if parent window is shown.
2681 void wxPropertyGrid::DoSetSplitterPosition_( int newxpos
, bool refresh
,
2685 if ( ( newxpos
< wxPG_DRAG_MARGIN
) )
2688 wxPropertyGridPageState
* state
= m_pState
;
2690 state
->DoSetSplitterPosition( newxpos
, splitterIndex
, allPages
);
2694 if ( GetSelection() )
2695 CorrectEditorWidgetSizeX();
2701 // -----------------------------------------------------------------------
2703 void wxPropertyGrid::CenterSplitter( bool enableAutoCentering
)
2705 SetSplitterPosition( m_width
/2 );
2706 if ( enableAutoCentering
&& HasFlag(wxPG_SPLITTER_AUTO_CENTER
) )
2707 m_pState
->m_dontCenterSplitter
= false;
2710 // -----------------------------------------------------------------------
2711 // wxPropertyGrid item iteration (GetNextProperty etc.) methods
2712 // -----------------------------------------------------------------------
2714 // Returns nearest paint visible property (such that will be painted unless
2715 // window is scrolled or resized). If given property is paint visible, then
2716 // it itself will be returned
2717 wxPGProperty
* wxPropertyGrid::GetNearestPaintVisible( wxPGProperty
* p
) const
2719 int vx
,vy1
;// Top left corner of client
2720 GetViewStart(&vx
,&vy1
);
2721 vy1
*= wxPG_PIXELS_PER_UNIT
;
2723 int vy2
= vy1
+ m_height
;
2724 int propY
= p
->GetY2(m_lineHeight
);
2726 if ( (propY
+ m_lineHeight
) < vy1
)
2729 return DoGetItemAtY( vy1
);
2731 else if ( propY
> vy2
)
2734 return DoGetItemAtY( vy2
);
2737 // Itself paint visible
2742 // -----------------------------------------------------------------------
2743 // Methods related to change in value, value modification and sending events
2744 // -----------------------------------------------------------------------
2746 // commits any changes in editor of selected property
2747 // return true if validation did not fail
2748 // flags are same as with DoSelectProperty
2749 bool wxPropertyGrid::CommitChangesFromEditor( wxUint32 flags
)
2751 // Committing already?
2752 if ( m_inCommitChangesFromEditor
)
2755 // Don't do this if already processing editor event. It might
2756 // induce recursive dialogs and crap like that.
2757 if ( m_iFlags
& wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
)
2759 if ( m_inDoPropertyChanged
)
2765 wxPGProperty
* selected
= GetSelection();
2768 IsEditorsValueModified() &&
2769 (m_iFlags
& wxPG_FL_INITIALIZED
) &&
2772 m_inCommitChangesFromEditor
= 1;
2774 wxVariant
variant(selected
->GetValueRef());
2775 bool valueIsPending
= false;
2777 // JACS - necessary to avoid new focus being found spuriously within OnIdle
2778 // due to another window getting focus
2779 wxWindow
* oldFocus
= m_curFocused
;
2781 bool validationFailure
= false;
2782 bool forceSuccess
= (flags
& (wxPG_SEL_NOVALIDATE
|wxPG_SEL_FORCE
)) ? true : false;
2784 m_chgInfo_changedProperty
= NULL
;
2786 // If truly modified, schedule value as pending.
2787 if ( selected
->GetEditorClass()->
2788 GetValueFromControl( variant
,
2790 GetEditorControl() ) )
2792 if ( DoEditorValidate() &&
2793 PerformValidation(selected
, variant
) )
2795 valueIsPending
= true;
2799 validationFailure
= true;
2804 EditorsValueWasNotModified();
2809 m_inCommitChangesFromEditor
= 0;
2811 if ( validationFailure
&& !forceSuccess
)
2815 oldFocus
->SetFocus();
2816 m_curFocused
= oldFocus
;
2819 res
= OnValidationFailure(selected
, variant
);
2821 // Now prevent further validation failure messages
2824 EditorsValueWasNotModified();
2825 OnValidationFailureReset(selected
);
2828 else if ( valueIsPending
)
2830 DoPropertyChanged( selected
, flags
);
2831 EditorsValueWasNotModified();
2840 // -----------------------------------------------------------------------
2842 bool wxPropertyGrid::PerformValidation( wxPGProperty
* p
, wxVariant
& pendingValue
,
2846 // Runs all validation functionality.
2847 // Returns true if value passes all tests.
2850 m_validationInfo
.m_failureBehavior
= m_permanentValidationFailureBehavior
;
2853 // Variant list a special value that cannot be validated
2855 if ( pendingValue
.GetType() != wxPG_VARIANT_TYPE_LIST
)
2857 if ( !p
->ValidateValue(pendingValue
, m_validationInfo
) )
2862 // Adapt list to child values, if necessary
2863 wxVariant listValue
= pendingValue
;
2864 wxVariant
* pPendingValue
= &pendingValue
;
2865 wxVariant
* pList
= NULL
;
2867 // If parent has wxPG_PROP_AGGREGATE flag, or uses composite
2868 // string value, then we need treat as it was changed instead
2869 // (or, in addition, as is the case with composite string parent).
2870 // This includes creating list variant for child values.
2872 wxPGProperty
* pwc
= p
->GetParent();
2873 wxPGProperty
* changedProperty
= p
;
2874 wxPGProperty
* baseChangedProperty
= changedProperty
;
2875 wxVariant bcpPendingList
;
2877 listValue
= pendingValue
;
2878 listValue
.SetName(p
->GetBaseName());
2881 (pwc
->HasFlag(wxPG_PROP_AGGREGATE
) || pwc
->HasFlag(wxPG_PROP_COMPOSED_VALUE
)) )
2883 wxVariantList tempList
;
2884 wxVariant
lv(tempList
, pwc
->GetBaseName());
2885 lv
.Append(listValue
);
2887 pPendingValue
= &listValue
;
2889 if ( pwc
->HasFlag(wxPG_PROP_AGGREGATE
) )
2891 baseChangedProperty
= pwc
;
2892 bcpPendingList
= lv
;
2895 changedProperty
= pwc
;
2896 pwc
= pwc
->GetParent();
2900 wxPGProperty
* evtChangingProperty
= changedProperty
;
2902 if ( pPendingValue
->GetType() != wxPG_VARIANT_TYPE_LIST
)
2904 value
= *pPendingValue
;
2908 // Convert list to child values
2909 pList
= pPendingValue
;
2910 changedProperty
->AdaptListToValue( *pPendingValue
, &value
);
2913 wxVariant evtChangingValue
= value
;
2915 if ( flags
& SendEvtChanging
)
2917 // FIXME: After proper ValueToString()s added, remove
2918 // this. It is just a temporary fix, as evt_changing
2919 // will simply not work for wxPG_PROP_COMPOSED_VALUE
2920 // (unless it is selected, and textctrl editor is open).
2921 if ( changedProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
2923 evtChangingProperty
= baseChangedProperty
;
2924 if ( evtChangingProperty
!= p
)
2926 evtChangingProperty
->AdaptListToValue( bcpPendingList
, &evtChangingValue
);
2930 evtChangingValue
= pendingValue
;
2934 if ( evtChangingProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
2936 if ( changedProperty
== GetSelection() )
2938 wxWindow
* editor
= GetEditorControl();
2939 wxASSERT( editor
->IsKindOf(CLASSINFO(wxTextCtrl
)) );
2940 evtChangingValue
= wxStaticCast(editor
, wxTextCtrl
)->GetValue();
2944 wxLogDebug(wxT("WARNING: wxEVT_PG_CHANGING is about to happen with old value."));
2949 wxASSERT( m_chgInfo_changedProperty
== NULL
);
2950 m_chgInfo_changedProperty
= changedProperty
;
2951 m_chgInfo_baseChangedProperty
= baseChangedProperty
;
2952 m_chgInfo_pendingValue
= value
;
2955 m_chgInfo_valueList
= *pList
;
2957 m_chgInfo_valueList
.MakeNull();
2959 // If changedProperty is not property which value was edited,
2960 // then call wxPGProperty::ValidateValue() for that as well.
2961 if ( p
!= changedProperty
&& value
.GetType() != wxPG_VARIANT_TYPE_LIST
)
2963 if ( !changedProperty
->ValidateValue(value
, m_validationInfo
) )
2967 if ( flags
& SendEvtChanging
)
2969 // SendEvent returns true if event was vetoed
2970 if ( SendEvent( wxEVT_PG_CHANGING
, evtChangingProperty
,
2971 &evtChangingValue
) )
2975 if ( flags
& IsStandaloneValidation
)
2977 // If called in 'generic' context, we need to reset
2978 // m_chgInfo_changedProperty and write back translated value.
2979 m_chgInfo_changedProperty
= NULL
;
2980 pendingValue
= value
;
2986 // -----------------------------------------------------------------------
2988 void wxPropertyGrid::DoShowPropertyError( wxPGProperty
* WXUNUSED(property
), const wxString
& msg
)
2990 if ( !msg
.length() )
2994 if ( !wxPGGlobalVars
->m_offline
)
2996 wxWindow
* topWnd
= ::wxGetTopLevelParent(this);
2999 wxFrame
* pFrame
= wxDynamicCast(topWnd
, wxFrame
);
3002 wxStatusBar
* pStatusBar
= pFrame
->GetStatusBar();
3005 pStatusBar
->SetStatusText(msg
);
3013 ::wxMessageBox(msg
, wxT("Property Error"));
3016 // -----------------------------------------------------------------------
3018 bool wxPropertyGrid::OnValidationFailure( wxPGProperty
* property
,
3019 wxVariant
& invalidValue
)
3021 wxWindow
* editor
= GetEditorControl();
3023 // First call property's handler
3024 property
->OnValidationFailure(invalidValue
);
3026 bool res
= DoOnValidationFailure(property
, invalidValue
);
3029 // For non-wxTextCtrl editors, we do need to revert the value
3030 if ( !editor
->IsKindOf(CLASSINFO(wxTextCtrl
)) &&
3031 property
== GetSelection() )
3033 property
->GetEditorClass()->UpdateControl(property
, editor
);
3036 property
->SetFlag(wxPG_PROP_INVALID_VALUE
);
3041 bool wxPropertyGrid::DoOnValidationFailure( wxPGProperty
* property
, wxVariant
& WXUNUSED(invalidValue
) )
3043 int vfb
= m_validationInfo
.m_failureBehavior
;
3045 if ( vfb
& wxPG_VFB_BEEP
)
3048 if ( (vfb
& wxPG_VFB_MARK_CELL
) &&
3049 !property
->HasFlag(wxPG_PROP_INVALID_VALUE
) )
3051 unsigned int colCount
= m_pState
->GetColumnCount();
3053 // We need backup marked property's cells
3054 m_propCellsBackup
= property
->m_cells
;
3056 wxColour vfbFg
= *wxWHITE
;
3057 wxColour vfbBg
= *wxRED
;
3059 property
->EnsureCells(colCount
);
3061 for ( unsigned int i
=0; i
<colCount
; i
++ )
3063 wxPGCell
& cell
= property
->m_cells
[i
];
3064 cell
.SetFgCol(vfbFg
);
3065 cell
.SetBgCol(vfbBg
);
3068 DrawItemAndChildren(property
);
3070 if ( property
== GetSelection() )
3072 SetInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
);
3074 wxWindow
* editor
= GetEditorControl();
3077 editor
->SetForegroundColour(vfbFg
);
3078 editor
->SetBackgroundColour(vfbBg
);
3083 if ( vfb
& wxPG_VFB_SHOW_MESSAGE
)
3085 wxString msg
= m_validationInfo
.m_failureMessage
;
3087 if ( !msg
.length() )
3088 msg
= wxT("You have entered invalid value. Press ESC to cancel editing.");
3090 DoShowPropertyError(property
, msg
);
3093 return (vfb
& wxPG_VFB_STAY_IN_PROPERTY
) ? false : true;
3096 // -----------------------------------------------------------------------
3098 void wxPropertyGrid::DoOnValidationFailureReset( wxPGProperty
* property
)
3100 int vfb
= m_validationInfo
.m_failureBehavior
;
3102 if ( vfb
& wxPG_VFB_MARK_CELL
)
3105 property
->m_cells
= m_propCellsBackup
;
3107 ClearInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL
);
3109 if ( property
== GetSelection() && GetEditorControl() )
3111 // Calling this will recreate the control, thus resetting its colour
3112 RefreshProperty(property
);
3116 DrawItemAndChildren(property
);
3121 // -----------------------------------------------------------------------
3123 // flags are same as with DoSelectProperty
3124 bool wxPropertyGrid::DoPropertyChanged( wxPGProperty
* p
, unsigned int selFlags
)
3126 if ( m_inDoPropertyChanged
)
3129 wxWindow
* editor
= GetEditorControl();
3130 wxPGProperty
* selected
= GetSelection();
3132 m_pState
->m_anyModified
= 1;
3134 m_inDoPropertyChanged
= 1;
3136 // Maybe need to update control
3137 wxASSERT( m_chgInfo_changedProperty
!= NULL
);
3139 // These values were calculated in PerformValidation()
3140 wxPGProperty
* changedProperty
= m_chgInfo_changedProperty
;
3141 wxVariant value
= m_chgInfo_pendingValue
;
3143 wxPGProperty
* topPaintedProperty
= changedProperty
;
3145 while ( !topPaintedProperty
->IsCategory() &&
3146 !topPaintedProperty
->IsRoot() )
3148 topPaintedProperty
= topPaintedProperty
->GetParent();
3151 changedProperty
->SetValue(value
, &m_chgInfo_valueList
, wxPG_SETVAL_BY_USER
);
3153 // Set as Modified (not if dragging just began)
3154 if ( !(p
->m_flags
& wxPG_PROP_MODIFIED
) )
3156 p
->m_flags
|= wxPG_PROP_MODIFIED
;
3157 if ( p
== selected
&& (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3160 SetCurControlBoldFont();
3166 // Propagate updates to parent(s)
3168 wxPGProperty
* prevPwc
= NULL
;
3170 while ( prevPwc
!= topPaintedProperty
)
3172 pwc
->m_flags
|= wxPG_PROP_MODIFIED
;
3174 if ( pwc
== selected
&& (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3177 SetCurControlBoldFont();
3181 pwc
= pwc
->GetParent();
3184 // Draw the actual property
3185 DrawItemAndChildren( topPaintedProperty
);
3188 // If value was set by wxPGProperty::OnEvent, then update the editor
3190 if ( selFlags
& wxPG_SEL_DIALOGVAL
)
3196 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
3197 if ( m_wndEditor
) m_wndEditor
->Refresh();
3198 if ( m_wndEditor2
) m_wndEditor2
->Refresh();
3203 wxASSERT( !changedProperty
->GetParent()->HasFlag(wxPG_PROP_AGGREGATE
) );
3205 // If top parent has composite string value, then send to child parents,
3206 // starting from baseChangedProperty.
3207 if ( changedProperty
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
3209 pwc
= m_chgInfo_baseChangedProperty
;
3211 while ( pwc
!= changedProperty
)
3213 SendEvent( wxEVT_PG_CHANGED
, pwc
, NULL
);
3214 pwc
= pwc
->GetParent();
3218 SendEvent( wxEVT_PG_CHANGED
, changedProperty
, NULL
);
3220 m_inDoPropertyChanged
= 0;
3225 // -----------------------------------------------------------------------
3227 bool wxPropertyGrid::ChangePropertyValue( wxPGPropArg id
, wxVariant newValue
)
3229 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
3231 m_chgInfo_changedProperty
= NULL
;
3233 if ( PerformValidation(p
, newValue
) )
3235 DoPropertyChanged(p
);
3240 OnValidationFailure(p
, newValue
);
3246 // -----------------------------------------------------------------------
3248 wxVariant
wxPropertyGrid::GetUncommittedPropertyValue()
3250 wxPGProperty
* prop
= GetSelectedProperty();
3253 return wxNullVariant
;
3255 wxTextCtrl
* tc
= GetEditorTextCtrl();
3256 wxVariant value
= prop
->GetValue();
3258 if ( !tc
|| !IsEditorsValueModified() )
3261 if ( !prop
->StringToValue(value
, tc
->GetValue()) )
3264 if ( !PerformValidation(prop
, value
, IsStandaloneValidation
) )
3265 return prop
->GetValue();
3270 // -----------------------------------------------------------------------
3272 // Runs wxValidator for the selected property
3273 bool wxPropertyGrid::DoEditorValidate()
3278 // -----------------------------------------------------------------------
3280 void wxPropertyGrid::HandleCustomEditorEvent( wxEvent
&event
)
3282 wxPGProperty
* selected
= GetSelection();
3284 // Somehow, event is handled after property has been deselected.
3285 // Possibly, but very rare.
3287 selected
->HasFlag(wxPG_PROP_BEING_DELETED
) ||
3288 // Also don't handle editor event if wxEVT_PG_CHANGED or
3289 // similar is currently doing something (showing a
3290 // message box, for instance).
3294 if ( m_iFlags
& wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
)
3297 wxVariant
pendingValue(selected
->GetValueRef());
3298 wxWindow
* wnd
= GetEditorControl();
3299 wxWindow
* editorWnd
= wxDynamicCast(event
.GetEventObject(), wxWindow
);
3301 bool wasUnspecified
= selected
->IsValueUnspecified();
3302 int usesAutoUnspecified
= selected
->UsesAutoUnspecified();
3303 bool valueIsPending
= false;
3305 m_chgInfo_changedProperty
= NULL
;
3307 m_iFlags
&= ~(wxPG_FL_VALIDATION_FAILED
|wxPG_FL_VALUE_CHANGE_IN_EVENT
);
3310 // Filter out excess wxTextCtrl modified events
3311 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_UPDATED
&&
3313 wnd
->IsKindOf(CLASSINFO(wxTextCtrl
)) )
3315 wxTextCtrl
* tc
= (wxTextCtrl
*) wnd
;
3317 wxString newTcValue
= tc
->GetValue();
3318 if ( m_prevTcValue
== newTcValue
)
3321 m_prevTcValue
= newTcValue
;
3324 SetInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
);
3326 bool validationFailure
= false;
3327 bool buttonWasHandled
= false;
3330 // Try common button handling
3331 if ( m_wndEditor2
&& event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
3333 wxPGEditorDialogAdapter
* adapter
= selected
->GetEditorDialog();
3337 buttonWasHandled
= true;
3338 // Store as res2, as previously (and still currently alternatively)
3339 // dialogs can be shown by handling wxEVT_COMMAND_BUTTON_CLICKED
3340 // in wxPGProperty::OnEvent().
3341 adapter
->ShowDialog( this, selected
);
3346 if ( !buttonWasHandled
)
3348 if ( wnd
|| m_wndEditor2
)
3350 // First call editor class' event handler.
3351 const wxPGEditor
* editor
= selected
->GetEditorClass();
3353 if ( editor
->OnEvent( this, selected
, editorWnd
, event
) )
3355 // If changes, validate them
3356 if ( DoEditorValidate() )
3358 if ( editor
->GetValueFromControl( pendingValue
,
3361 valueIsPending
= true;
3365 validationFailure
= true;
3370 // Then the property's custom handler (must be always called, unless
3371 // validation failed).
3372 if ( !validationFailure
)
3373 buttonWasHandled
= selected
->OnEvent( this, editorWnd
, event
);
3376 // SetValueInEvent(), as called in one of the functions referred above
3377 // overrides editor's value.
3378 if ( m_iFlags
& wxPG_FL_VALUE_CHANGE_IN_EVENT
)
3380 valueIsPending
= true;
3381 pendingValue
= m_changeInEventValue
;
3382 selFlags
|= wxPG_SEL_DIALOGVAL
;
3385 if ( !validationFailure
&& valueIsPending
)
3386 if ( !PerformValidation(selected
, pendingValue
) )
3387 validationFailure
= true;
3389 if ( validationFailure
)
3391 OnValidationFailure(selected
, pendingValue
);
3393 else if ( valueIsPending
)
3395 selFlags
|= ( !wasUnspecified
&& selected
->IsValueUnspecified() && usesAutoUnspecified
) ? wxPG_SEL_SETUNSPEC
: 0;
3397 DoPropertyChanged(selected
, selFlags
);
3398 EditorsValueWasNotModified();
3400 // Regardless of editor type, unfocus editor on
3401 // text-editing related enter press.
3402 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_ENTER
)
3409 // No value after all
3411 // Regardless of editor type, unfocus editor on
3412 // text-editing related enter press.
3413 if ( event
.GetEventType() == wxEVT_COMMAND_TEXT_ENTER
)
3418 // Let unhandled button click events go to the parent
3419 if ( !buttonWasHandled
&& event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
3421 wxCommandEvent
evt(wxEVT_COMMAND_BUTTON_CLICKED
,GetId());
3422 GetEventHandler()->AddPendingEvent(evt
);
3426 ClearInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT
);
3429 // -----------------------------------------------------------------------
3430 // wxPropertyGrid editor control helper methods
3431 // -----------------------------------------------------------------------
3433 wxRect
wxPropertyGrid::GetEditorWidgetRect( wxPGProperty
* p
, int column
) const
3435 int itemy
= p
->GetY2(m_lineHeight
);
3436 int splitterX
= m_pState
->DoGetSplitterPosition(column
-1);
3437 int colEnd
= splitterX
+ m_pState
->m_colWidths
[column
];
3438 int imageOffset
= 0;
3440 int vx
, vy
; // Top left corner of client
3441 GetViewStart(&vx
, &vy
);
3442 vy
*= wxPG_PIXELS_PER_UNIT
;
3444 // TODO: If custom image detection changes from current, change this.
3445 if ( m_iFlags
& wxPG_FL_CUR_USES_CUSTOM_IMAGE
)
3447 //m_iFlags |= wxPG_FL_CUR_USES_CUSTOM_IMAGE;
3448 int iw
= p
->OnMeasureImage().x
;
3450 iw
= wxPG_CUSTOM_IMAGE_WIDTH
;
3451 imageOffset
= p
->GetImageOffset(iw
);
3456 splitterX
+imageOffset
+wxPG_XBEFOREWIDGET
+wxPG_CONTROL_MARGIN
+1,
3458 colEnd
-splitterX
-wxPG_XBEFOREWIDGET
-wxPG_CONTROL_MARGIN
-imageOffset
-1,
3463 // -----------------------------------------------------------------------
3465 wxRect
wxPropertyGrid::GetImageRect( wxPGProperty
* p
, int item
) const
3467 wxSize sz
= GetImageSize(p
, item
);
3468 return wxRect(wxPG_CONTROL_MARGIN
+ wxCC_CUSTOM_IMAGE_MARGIN1
,
3469 wxPG_CUSTOM_IMAGE_SPACINGY
,
3474 // return size of custom paint image
3475 wxSize
wxPropertyGrid::GetImageSize( wxPGProperty
* p
, int item
) const
3477 // If called with NULL property, then return default image
3478 // size for properties that use image.
3480 return wxSize(wxPG_CUSTOM_IMAGE_WIDTH
,wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight
));
3482 wxSize cis
= p
->OnMeasureImage(item
);
3484 int choiceCount
= p
->m_choices
.GetCount();
3485 int comVals
= p
->GetDisplayedCommonValueCount();
3486 if ( item
>= choiceCount
&& comVals
> 0 )
3488 unsigned int cvi
= item
-choiceCount
;
3489 cis
= GetCommonValue(cvi
)->GetRenderer()->GetImageSize(NULL
, 1, cvi
);
3491 else if ( item
>= 0 && choiceCount
== 0 )
3492 return wxSize(0, 0);
3497 cis
.x
= wxPG_CUSTOM_IMAGE_WIDTH
;
3502 cis
.y
= wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight
);
3509 // -----------------------------------------------------------------------
3511 // takes scrolling into account
3512 void wxPropertyGrid::ImprovedClientToScreen( int* px
, int* py
)
3515 GetViewStart(&vx
,&vy
);
3516 vy
*=wxPG_PIXELS_PER_UNIT
;
3517 vx
*=wxPG_PIXELS_PER_UNIT
;
3520 ClientToScreen( px
, py
);
3523 // -----------------------------------------------------------------------
3525 wxPropertyGridHitTestResult
wxPropertyGrid::HitTest( const wxPoint
& pt
) const
3528 GetViewStart(&pt2
.x
,&pt2
.y
);
3529 pt2
.x
*= wxPG_PIXELS_PER_UNIT
;
3530 pt2
.y
*= wxPG_PIXELS_PER_UNIT
;
3534 return m_pState
->HitTest(pt2
);
3537 // -----------------------------------------------------------------------
3539 // custom set cursor
3540 void wxPropertyGrid::CustomSetCursor( int type
, bool override
)
3542 if ( type
== m_curcursor
&& !override
) return;
3544 wxCursor
* cursor
= &wxPG_DEFAULT_CURSOR
;
3546 if ( type
== wxCURSOR_SIZEWE
)
3547 cursor
= m_cursorSizeWE
;
3549 SetCursor( *cursor
);
3554 // -----------------------------------------------------------------------
3555 // wxPropertyGrid property selection, editor creation
3556 // -----------------------------------------------------------------------
3559 // This class forwards events from property editor controls to wxPropertyGrid.
3560 class wxPropertyGridEditorEventForwarder
: public wxEvtHandler
3563 wxPropertyGridEditorEventForwarder( wxPropertyGrid
* propGrid
)
3564 : wxEvtHandler(), m_propGrid(propGrid
)
3568 virtual ~wxPropertyGridEditorEventForwarder()
3573 bool ProcessEvent( wxEvent
& event
)
3578 m_propGrid
->HandleCustomEditorEvent(event
);
3580 return wxEvtHandler::ProcessEvent(event
);
3583 wxPropertyGrid
* m_propGrid
;
3586 // Setups event handling for child control
3587 void wxPropertyGrid::SetupChildEventHandling( wxWindow
* argWnd
)
3589 wxWindowID id
= argWnd
->GetId();
3591 if ( argWnd
== m_wndEditor
)
3593 argWnd
->Connect(id
, wxEVT_MOTION
,
3594 wxMouseEventHandler(wxPropertyGrid::OnMouseMoveChild
),
3596 argWnd
->Connect(id
, wxEVT_LEFT_UP
,
3597 wxMouseEventHandler(wxPropertyGrid::OnMouseUpChild
),
3599 argWnd
->Connect(id
, wxEVT_LEFT_DOWN
,
3600 wxMouseEventHandler(wxPropertyGrid::OnMouseClickChild
),
3602 argWnd
->Connect(id
, wxEVT_RIGHT_UP
,
3603 wxMouseEventHandler(wxPropertyGrid::OnMouseRightClickChild
),
3605 argWnd
->Connect(id
, wxEVT_ENTER_WINDOW
,
3606 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry
),
3608 argWnd
->Connect(id
, wxEVT_LEAVE_WINDOW
,
3609 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry
),
3613 wxPropertyGridEditorEventForwarder
* forwarder
;
3614 forwarder
= new wxPropertyGridEditorEventForwarder(this);
3615 argWnd
->PushEventHandler(forwarder
);
3617 argWnd
->Connect(id
, wxEVT_KEY_DOWN
,
3618 wxCharEventHandler(wxPropertyGrid::OnChildKeyDown
),
3622 void wxPropertyGrid::DestroyEditorWnd( wxWindow
* wnd
)
3629 // Do not free editors immediately (for sake of processing events)
3630 wxPendingDelete
.Append(wnd
);
3633 void wxPropertyGrid::FreeEditors()
3636 // Return focus back to canvas from children (this is required at least for
3637 // GTK+, which, unlike Windows, clears focus when control is destroyed
3638 // instead of moving it to closest parent).
3639 wxWindow
* focus
= wxWindow::FindFocus();
3642 wxWindow
* parent
= focus
->GetParent();
3645 if ( parent
== this )
3650 parent
= parent
->GetParent();
3654 // Do not free editors immediately if processing events
3657 wxEvtHandler
* handler
= m_wndEditor2
->PopEventHandler(false);
3658 m_wndEditor2
->Hide();
3659 wxPendingDelete
.Append( handler
);
3660 DestroyEditorWnd(m_wndEditor2
);
3661 m_wndEditor2
= NULL
;
3666 wxEvtHandler
* handler
= m_wndEditor
->PopEventHandler(false);
3667 m_wndEditor
->Hide();
3668 wxPendingDelete
.Append( handler
);
3669 DestroyEditorWnd(m_wndEditor
);
3674 // Call with NULL to de-select property
3675 bool wxPropertyGrid::DoSelectProperty( wxPGProperty
* p
, unsigned int flags
)
3680 wxLogDebug(wxT("SelectProperty( %s (%s[%i]) )"),p->m_label.c_str(),
3681 p->m_parent->m_label.c_str(),p->GetIndexInParent());
3685 wxLogDebug(wxT("SelectProperty( NULL, -1 )"));
3689 if ( m_inDoSelectProperty
)
3692 m_inDoSelectProperty
= 1;
3696 m_inDoSelectProperty
= 0;
3700 wxArrayPGProperty prevSelection
= m_pState
->m_selection
;
3701 wxPGProperty
* prevFirstSel
;
3703 if ( prevSelection
.size() > 0 )
3704 prevFirstSel
= prevSelection
[0];
3706 prevFirstSel
= NULL
;
3708 if ( prevFirstSel
&& prevFirstSel
->HasFlag(wxPG_PROP_BEING_DELETED
) )
3709 prevFirstSel
= NULL
;
3711 // Always send event, as this is indirect call
3712 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
);
3716 wxPrintf( "Selected %s\n", prevFirstSel->GetClassInfo()->GetClassName() );
3718 wxPrintf( "None selected\n" );
3721 wxPrintf( "P = %s\n", p->GetClassInfo()->GetClassName() );
3723 wxPrintf( "P = NULL\n" );
3726 // If we are frozen, then just set the values.
3729 m_iFlags
&= ~(wxPG_FL_ABNORMAL_EDITOR
);
3730 m_editorFocused
= 0;
3731 m_pState
->DoSetSelection(p
);
3733 // If frozen, always free controls. But don't worry, as Thaw will
3734 // recall SelectProperty to recreate them.
3737 // Prevent any further selection measures in this call
3743 if ( prevFirstSel
== p
&&
3744 prevSelection
.size() <= 1 &&
3745 !(flags
& wxPG_SEL_FORCE
) )
3747 // Only set focus if not deselecting
3750 if ( flags
& wxPG_SEL_FOCUS
)
3754 m_wndEditor
->SetFocus();
3755 m_editorFocused
= 1;
3764 m_inDoSelectProperty
= 0;
3769 // First, deactivate previous
3772 OnValidationFailureReset(prevFirstSel
);
3774 // Must double-check if this is an selected in case of forceswitch
3775 if ( p
!= prevFirstSel
)
3777 if ( !CommitChangesFromEditor(flags
) )
3779 // Validation has failed, so we can't exit the previous editor
3780 //::wxMessageBox(_("Please correct the value or press ESC to cancel the edit."),
3781 // _("Invalid Value"),wxOK|wxICON_ERROR);
3782 m_inDoSelectProperty
= 0;
3789 m_iFlags
&= ~(wxPG_FL_ABNORMAL_EDITOR
);
3790 EditorsValueWasNotModified();
3793 SetInternalFlag(wxPG_FL_IN_SELECT_PROPERTY
);
3795 m_pState
->DoSetSelection(p
);
3797 // Redraw unselected
3798 for ( unsigned int i
=0; i
<prevSelection
.size(); i
++ )
3800 DrawItem(prevSelection
[i
]);
3804 // Then, activate the one given.
3807 int propY
= p
->GetY2(m_lineHeight
);
3809 int splitterX
= GetSplitterPosition();
3810 m_editorFocused
= 0;
3811 m_iFlags
|= wxPG_FL_PRIMARY_FILLS_ENTIRE
;
3812 if ( p
!= prevFirstSel
)
3813 m_iFlags
&= ~(wxPG_FL_VALIDATION_FAILED
);
3815 wxASSERT( m_wndEditor
== NULL
);
3818 // Only create editor for non-disabled non-caption
3819 if ( !p
->IsCategory() && !(p
->m_flags
& wxPG_PROP_DISABLED
) )
3821 // do this for non-caption items
3825 // Do we need to paint the custom image, if any?
3826 m_iFlags
&= ~(wxPG_FL_CUR_USES_CUSTOM_IMAGE
);
3827 if ( (p
->m_flags
& wxPG_PROP_CUSTOMIMAGE
) &&
3828 !p
->GetEditorClass()->CanContainCustomImage()
3830 m_iFlags
|= wxPG_FL_CUR_USES_CUSTOM_IMAGE
;
3832 wxRect grect
= GetEditorWidgetRect(p
, m_selColumn
);
3833 wxPoint goodPos
= grect
.GetPosition();
3835 const wxPGEditor
* editor
= p
->GetEditorClass();
3836 wxCHECK_MSG(editor
, false,
3837 wxT("NULL editor class not allowed"));
3839 m_iFlags
&= ~wxPG_FL_FIXED_WIDTH_EDITOR
;
3841 wxPGWindowList wndList
=
3842 editor
->CreateControls(this,
3847 m_wndEditor
= wndList
.m_primary
;
3848 m_wndEditor2
= wndList
.m_secondary
;
3849 wxWindow
* primaryCtrl
= GetEditorControl();
3852 // Essentially, primaryCtrl == m_wndEditor
3855 // NOTE: It is allowed for m_wndEditor to be NULL - in this
3856 // case value is drawn as normal, and m_wndEditor2 is
3857 // assumed to be a right-aligned button that triggers
3858 // a separate editorCtrl window.
3862 wxASSERT_MSG( m_wndEditor
->GetParent() == GetPanel(),
3863 "CreateControls must use result of "
3864 "wxPropertyGrid::GetPanel() as parent "
3867 // Set validator, if any
3868 #if wxUSE_VALIDATORS
3869 wxValidator
* validator
= p
->GetValidator();
3871 primaryCtrl
->SetValidator(*validator
);
3874 if ( m_wndEditor
->GetSize().y
> (m_lineHeight
+6) )
3875 m_iFlags
|= wxPG_FL_ABNORMAL_EDITOR
;
3877 // If it has modified status, use bold font
3878 // (must be done before capturing m_ctrlXAdjust)
3879 if ( (p
->m_flags
& wxPG_PROP_MODIFIED
) &&
3880 (m_windowStyle
& wxPG_BOLD_MODIFIED
) )
3881 SetCurControlBoldFont();
3883 // Store x relative to splitter (we'll need it).
3884 m_ctrlXAdjust
= m_wndEditor
->GetPosition().x
- splitterX
;
3886 // Check if background clear is not necessary
3887 wxPoint pos
= m_wndEditor
->GetPosition();
3888 if ( pos
.x
> (splitterX
+1) || pos
.y
> propY
)
3890 m_iFlags
&= ~(wxPG_FL_PRIMARY_FILLS_ENTIRE
);
3893 m_wndEditor
->SetSizeHints(3, 3);
3895 SetupChildEventHandling(primaryCtrl
);
3897 // Focus and select all (wxTextCtrl, wxComboBox etc)
3898 if ( flags
& wxPG_SEL_FOCUS
)
3900 primaryCtrl
->SetFocus();
3902 p
->GetEditorClass()->OnFocus(p
, primaryCtrl
);
3908 wxASSERT_MSG( m_wndEditor2
->GetParent() == GetPanel(),
3909 "CreateControls must use result of "
3910 "wxPropertyGrid::GetPanel() as parent "
3913 // Get proper id for wndSecondary
3914 m_wndSecId
= m_wndEditor2
->GetId();
3915 wxWindowList children
= m_wndEditor2
->GetChildren();
3916 wxWindowList::iterator node
= children
.begin();
3917 if ( node
!= children
.end() )
3918 m_wndSecId
= ((wxWindow
*)*node
)->GetId();
3920 m_wndEditor2
->SetSizeHints(3,3);
3922 m_wndEditor2
->Show();
3924 SetupChildEventHandling(m_wndEditor2
);
3926 // If no primary editor, focus to button to allow
3927 // it to interprete ENTER etc.
3928 // NOTE: Due to problems focusing away from it, this
3929 // has been disabled.
3931 if ( (flags & wxPG_SEL_FOCUS) && !m_wndEditor )
3932 m_wndEditor2->SetFocus();
3936 if ( flags
& wxPG_SEL_FOCUS
)
3937 m_editorFocused
= 1;
3942 // Make sure focus is in grid canvas (important for wxGTK,
3947 EditorsValueWasNotModified();
3949 // If it's inside collapsed section, expand parent, scroll, etc.
3950 // Also, if it was partially visible, scroll it into view.
3951 if ( !(flags
& wxPG_SEL_NONVISIBLE
) )
3956 m_wndEditor
->Show(true);
3959 if ( !(flags
& wxPG_SEL_NO_REFRESH
) )
3964 // Make sure focus is in grid canvas
3968 ClearInternalFlag(wxPG_FL_IN_SELECT_PROPERTY
);
3974 // Show help text in status bar.
3975 // (if found and grid not embedded in manager with help box and
3976 // style wxPG_EX_HELP_AS_TOOLTIPS is not used).
3979 if ( !(GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS
) )
3981 wxStatusBar
* statusbar
= NULL
;
3982 if ( !(m_iFlags
& wxPG_FL_NOSTATUSBARHELP
) )
3984 wxFrame
* frame
= wxDynamicCast(::wxGetTopLevelParent(this),wxFrame
);
3986 statusbar
= frame
->GetStatusBar();
3991 const wxString
* pHelpString
= (const wxString
*) NULL
;
3995 pHelpString
= &p
->GetHelpString();
3996 if ( pHelpString
->length() )
3998 // Set help box text.
3999 statusbar
->SetStatusText( *pHelpString
);
4000 m_iFlags
|= wxPG_FL_STRING_IN_STATUSBAR
;
4004 if ( (!pHelpString
|| !pHelpString
->length()) &&
4005 (m_iFlags
& wxPG_FL_STRING_IN_STATUSBAR
) )
4007 // Clear help box - but only if it was written
4008 // by us at previous time.
4009 statusbar
->SetStatusText( m_emptyString
);
4010 m_iFlags
&= ~(wxPG_FL_STRING_IN_STATUSBAR
);
4016 m_inDoSelectProperty
= 0;
4018 // call wx event handler (here so that it also occurs on deselection)
4019 if ( !(flags
& wxPG_SEL_DONT_SEND_EVENT
) )
4020 SendEvent( wxEVT_PG_SELECTED
, p
, NULL
);
4025 // -----------------------------------------------------------------------
4027 bool wxPropertyGrid::UnfocusEditor()
4029 wxPGProperty
* selected
= GetSelection();
4031 if ( !selected
|| !m_wndEditor
|| m_frozen
)
4034 if ( !CommitChangesFromEditor(0) )
4043 // -----------------------------------------------------------------------
4045 void wxPropertyGrid::RefreshEditor()
4047 wxPGProperty
* p
= GetSelection();
4051 wxWindow
* wnd
= GetEditorControl();
4055 // Set editor font boldness - must do this before
4056 // calling UpdateControl().
4057 if ( HasFlag(wxPG_BOLD_MODIFIED
) )
4059 if ( p
->HasFlag(wxPG_PROP_MODIFIED
) )
4060 wnd
->SetFont(GetCaptionFont());
4062 wnd
->SetFont(GetFont());
4065 const wxPGEditor
* editorClass
= p
->GetEditorClass();
4067 editorClass
->UpdateControl(p
, wnd
);
4069 if ( p
->IsValueUnspecified() )
4070 editorClass
->SetValueToUnspecified(p
, wnd
);
4073 // -----------------------------------------------------------------------
4075 bool wxPropertyGrid::SelectProperty( wxPGPropArg id
, bool focus
)
4077 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
4079 int flags
= wxPG_SEL_DONT_SEND_EVENT
;
4081 flags
|= wxPG_SEL_FOCUS
;
4083 return DoSelectProperty(p
, flags
);
4086 // -----------------------------------------------------------------------
4087 // wxPropertyGrid expand/collapse state
4088 // -----------------------------------------------------------------------
4090 bool wxPropertyGrid::DoCollapse( wxPGProperty
* p
, bool sendEvents
)
4092 wxPGProperty
* pwc
= wxStaticCast(p
, wxPGProperty
);
4093 wxPGProperty
* selected
= GetSelection();
4095 // If active editor was inside collapsed section, then disable it
4096 if ( selected
&& selected
->IsSomeParent(p
) )
4101 // Store dont-center-splitter flag 'cause we need to temporarily set it
4102 bool prevDontCenterSplitter
= m_pState
->m_dontCenterSplitter
;
4103 m_pState
->m_dontCenterSplitter
= true;
4105 bool res
= m_pState
->DoCollapse(pwc
);
4110 SendEvent( wxEVT_PG_ITEM_COLLAPSED
, p
);
4112 RecalculateVirtualSize();
4116 m_pState
->m_dontCenterSplitter
= prevDontCenterSplitter
;
4121 // -----------------------------------------------------------------------
4123 bool wxPropertyGrid::DoExpand( wxPGProperty
* p
, bool sendEvents
)
4125 wxCHECK_MSG( p
, false, wxT("invalid property id") );
4127 wxPGProperty
* pwc
= (wxPGProperty
*)p
;
4129 // Store dont-center-splitter flag 'cause we need to temporarily set it
4130 bool prevDontCenterSplitter
= m_pState
->m_dontCenterSplitter
;
4131 m_pState
->m_dontCenterSplitter
= true;
4133 bool res
= m_pState
->DoExpand(pwc
);
4138 SendEvent( wxEVT_PG_ITEM_EXPANDED
, p
);
4140 RecalculateVirtualSize();
4144 m_pState
->m_dontCenterSplitter
= prevDontCenterSplitter
;
4149 // -----------------------------------------------------------------------
4151 bool wxPropertyGrid::DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
)
4154 return m_pState
->DoHideProperty(p
, hide
, flags
);
4156 wxArrayPGProperty selection
= m_pState
->m_selection
; // Must use a copy
4157 int selRemoveCount
= 0;
4158 for ( unsigned int i
=0; i
<selection
.size(); i
++ )
4160 wxPGProperty
* selected
= selection
[i
];
4161 if ( selected
== p
|| selected
->IsSomeParent(p
) )
4163 if ( !DoRemoveFromSelection(p
, flags
) )
4165 selRemoveCount
+= 1;
4169 m_pState
->DoHideProperty(p
, hide
, flags
);
4171 RecalculateVirtualSize();
4178 // -----------------------------------------------------------------------
4179 // wxPropertyGrid size related methods
4180 // -----------------------------------------------------------------------
4182 void wxPropertyGrid::RecalculateVirtualSize( int forceXPos
)
4184 if ( (m_iFlags
& wxPG_FL_RECALCULATING_VIRTUAL_SIZE
) || m_frozen
)
4188 // If virtual height was changed, then recalculate editor control position(s)
4189 if ( m_pState
->m_vhCalcPending
)
4190 CorrectEditorWidgetPosY();
4192 m_pState
->EnsureVirtualHeight();
4194 wxASSERT_LEVEL_2_MSG(
4195 m_pState
->GetVirtualHeight() == m_pState
->GetActualVirtualHeight(),
4196 "VirtualHeight and ActualVirtualHeight should match"
4199 m_iFlags
|= wxPG_FL_RECALCULATING_VIRTUAL_SIZE
;
4201 int x
= m_pState
->m_width
;
4202 int y
= m_pState
->m_virtualHeight
;
4205 GetClientSize(&width
,&height
);
4207 // Now adjust virtual size.
4208 SetVirtualSize(x
, y
);
4214 // Adjust scrollbars
4215 if ( HasVirtualWidth() )
4217 xAmount
= x
/wxPG_PIXELS_PER_UNIT
;
4218 xPos
= GetScrollPos( wxHORIZONTAL
);
4221 if ( forceXPos
!= -1 )
4224 else if ( xPos
> (xAmount
-(width
/wxPG_PIXELS_PER_UNIT
)) )
4227 int yAmount
= y
/ wxPG_PIXELS_PER_UNIT
;
4228 int yPos
= GetScrollPos( wxVERTICAL
);
4230 SetScrollbars( wxPG_PIXELS_PER_UNIT
, wxPG_PIXELS_PER_UNIT
,
4231 xAmount
, yAmount
, xPos
, yPos
, true );
4233 // Must re-get size now
4234 GetClientSize(&width
,&height
);
4236 if ( !HasVirtualWidth() )
4238 m_pState
->SetVirtualWidth(width
);
4245 m_pState
->CheckColumnWidths();
4247 if ( GetSelection() )
4248 CorrectEditorWidgetSizeX();
4250 m_iFlags
&= ~wxPG_FL_RECALCULATING_VIRTUAL_SIZE
;
4253 // -----------------------------------------------------------------------
4255 void wxPropertyGrid::OnResize( wxSizeEvent
& event
)
4257 if ( !(m_iFlags
& wxPG_FL_INITIALIZED
) )
4261 GetClientSize(&width
, &height
);
4266 #if wxPG_DOUBLE_BUFFER
4267 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING
) )
4269 int dblh
= (m_lineHeight
*2);
4270 if ( !m_doubleBuffer
)
4272 // Create double buffer bitmap to draw on, if none
4273 int w
= (width
>250)?width
:250;
4274 int h
= height
+ dblh
;
4276 m_doubleBuffer
= new wxBitmap( w
, h
);
4280 int w
= m_doubleBuffer
->GetWidth();
4281 int h
= m_doubleBuffer
->GetHeight();
4283 // Double buffer must be large enough
4284 if ( w
< width
|| h
< (height
+dblh
) )
4286 if ( w
< width
) w
= width
;
4287 if ( h
< (height
+dblh
) ) h
= height
+ dblh
;
4288 delete m_doubleBuffer
;
4289 m_doubleBuffer
= new wxBitmap( w
, h
);
4296 m_pState
->OnClientWidthChange( width
, event
.GetSize().x
- m_ncWidth
, true );
4297 m_ncWidth
= event
.GetSize().x
;
4301 if ( m_pState
->m_itemsAdded
)
4302 PrepareAfterItemsAdded();
4304 // Without this, virtual size (atleast under wxGTK) will be skewed
4305 RecalculateVirtualSize();
4311 // -----------------------------------------------------------------------
4313 void wxPropertyGrid::SetVirtualWidth( int width
)
4317 // Disable virtual width
4318 width
= GetClientSize().x
;
4319 ClearInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH
);
4323 // Enable virtual width
4324 SetInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH
);
4326 m_pState
->SetVirtualWidth( width
);
4329 void wxPropertyGrid::SetFocusOnCanvas()
4331 SetFocusIgnoringChildren();
4332 m_editorFocused
= 0;
4335 // -----------------------------------------------------------------------
4336 // wxPropertyGrid mouse event handling
4337 // -----------------------------------------------------------------------
4339 // selFlags uses same values DoSelectProperty's flags
4340 // Returns true if event was vetoed.
4341 bool wxPropertyGrid::SendEvent( int eventType
, wxPGProperty
* p
,
4343 unsigned int selFlags
,
4344 unsigned int column
)
4346 // Send property grid event of specific type and with specific property
4347 wxPropertyGridEvent
evt( eventType
, m_eventObject
->GetId() );
4348 evt
.SetPropertyGrid(this);
4349 evt
.SetEventObject(m_eventObject
);
4351 evt
.SetColumn(column
);
4352 if ( eventType
== wxEVT_PG_CHANGING
)
4355 evt
.SetCanVeto(true);
4356 m_validationInfo
.m_pValue
= pValue
;
4357 evt
.SetupValidationInfo();
4362 evt
.SetPropertyValue(p
->GetValue());
4364 if ( !(selFlags
& wxPG_SEL_NOVALIDATE
) )
4365 evt
.SetCanVeto(true);
4368 m_processedEvent
= &evt
;
4369 m_eventObject
->HandleWindowEvent(evt
);
4370 m_processedEvent
= NULL
;
4372 return evt
.WasVetoed();
4375 // -----------------------------------------------------------------------
4377 // Return false if should be skipped
4378 bool wxPropertyGrid::HandleMouseClick( int x
, unsigned int y
, wxMouseEvent
&event
)
4382 // Need to set focus?
4383 if ( !(m_iFlags
& wxPG_FL_FOCUSED
) )
4388 wxPropertyGridPageState
* state
= m_pState
;
4390 int splitterHitOffset
;
4391 int columnHit
= state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4393 wxPGProperty
* p
= DoGetItemAtY(y
);
4397 int depth
= (int)p
->GetDepth() - 1;
4399 int marginEnds
= m_marginWidth
+ ( depth
* m_subgroup_extramargin
);
4401 if ( x
>= marginEnds
)
4405 if ( p
->IsCategory() )
4407 // This is category.
4408 wxPropertyCategory
* pwc
= (wxPropertyCategory
*)p
;
4410 int textX
= m_marginWidth
+ ((unsigned int)((pwc
->m_depth
-1)*m_subgroup_extramargin
));
4412 // Expand, collapse, activate etc. if click on text or left of splitter.
4415 ( x
< (textX
+pwc
->GetTextExtent(this, m_captionFont
)+(wxPG_CAPRECTXMARGIN
*2)) ||
4420 if ( !AddToSelectionFromInputEvent( p
,
4425 // On double-click, expand/collapse.
4426 if ( event
.ButtonDClick() && !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
4428 if ( pwc
->IsExpanded() ) DoCollapse( p
, true );
4429 else DoExpand( p
, true );
4433 else if ( splitterHit
== -1 )
4436 unsigned int selFlag
= 0;
4437 if ( columnHit
== 1 )
4439 m_iFlags
|= wxPG_FL_ACTIVATION_BY_CLICK
;
4440 selFlag
= wxPG_SEL_FOCUS
;
4442 if ( !AddToSelectionFromInputEvent( p
,
4448 m_iFlags
&= ~(wxPG_FL_ACTIVATION_BY_CLICK
);
4450 if ( p
->GetChildCount() && !p
->IsCategory() )
4451 // On double-click, expand/collapse.
4452 if ( event
.ButtonDClick() && !(m_windowStyle
& wxPG_HIDE_MARGIN
) )
4454 wxPGProperty
* pwc
= (wxPGProperty
*)p
;
4455 if ( pwc
->IsExpanded() ) DoCollapse( p
, true );
4456 else DoExpand( p
, true );
4463 // click on splitter
4464 if ( !(m_windowStyle
& wxPG_STATIC_SPLITTER
) )
4466 if ( event
.GetEventType() == wxEVT_LEFT_DCLICK
)
4468 // Double-clicking the splitter causes auto-centering
4469 CenterSplitter( true );
4471 else if ( m_dragStatus
== 0 )
4474 // Begin draggin the splitter
4478 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE
);
4482 // Changes must be committed here or the
4483 // value won't be drawn correctly
4484 if ( !CommitChangesFromEditor() )
4487 m_wndEditor
->Show ( false );
4490 if ( !(m_iFlags
& wxPG_FL_MOUSE_CAPTURED
) )
4493 m_iFlags
|= wxPG_FL_MOUSE_CAPTURED
;
4497 m_draggedSplitter
= splitterHit
;
4498 m_dragOffset
= splitterHitOffset
;
4500 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4501 // Fixes button disappearance bug
4503 m_wndEditor2
->Show ( false );
4506 m_startingSplitterX
= x
- splitterHitOffset
;
4514 if ( p
->GetChildCount() )
4516 int nx
= x
+ m_marginWidth
- marginEnds
; // Normalize x.
4518 // Fine tune cell button x
4519 if ( !p
->IsCategory() )
4520 nx
-= IN_CELL_EXPANDER_BUTTON_X_ADJUST
;
4522 if ( (nx
>= m_gutterWidth
&& nx
< (m_gutterWidth
+m_iconWidth
)) )
4524 int y2
= y
% m_lineHeight
;
4525 if ( (y2
>= m_buttonSpacingY
&& y2
< (m_buttonSpacingY
+m_iconHeight
)) )
4527 // On click on expander button, expand/collapse
4528 if ( ((wxPGProperty
*)p
)->IsExpanded() )
4529 DoCollapse( p
, true );
4531 DoExpand( p
, true );
4540 // -----------------------------------------------------------------------
4542 bool wxPropertyGrid::HandleMouseRightClick( int WXUNUSED(x
),
4543 unsigned int WXUNUSED(y
),
4544 wxMouseEvent
& event
)
4548 // Select property here as well
4549 wxPGProperty
* p
= m_propHover
;
4550 AddToSelectionFromInputEvent(p
, m_colHover
, &event
);
4552 // Send right click event.
4553 SendEvent( wxEVT_PG_RIGHT_CLICK
, p
);
4560 // -----------------------------------------------------------------------
4562 bool wxPropertyGrid::HandleMouseDoubleClick( int WXUNUSED(x
),
4563 unsigned int WXUNUSED(y
),
4564 wxMouseEvent
& event
)
4568 // Select property here as well
4569 wxPGProperty
* p
= m_propHover
;
4571 AddToSelectionFromInputEvent(p
, m_colHover
, &event
);
4573 // Send double-click event.
4574 SendEvent( wxEVT_PG_DOUBLE_CLICK
, m_propHover
);
4581 // -----------------------------------------------------------------------
4583 #if wxPG_SUPPORT_TOOLTIPS
4585 void wxPropertyGrid::SetToolTip( const wxString
& tipString
)
4587 if ( tipString
.length() )
4589 wxScrolledWindow::SetToolTip(tipString
);
4593 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4594 wxScrolledWindow::SetToolTip( m_emptyString
);
4596 wxScrolledWindow::SetToolTip( NULL
);
4601 #endif // #if wxPG_SUPPORT_TOOLTIPS
4603 // -----------------------------------------------------------------------
4605 // Return false if should be skipped
4606 bool wxPropertyGrid::HandleMouseMove( int x
, unsigned int y
,
4607 wxMouseEvent
&event
)
4609 // Safety check (needed because mouse capturing may
4610 // otherwise freeze the control)
4611 if ( m_dragStatus
> 0 && !event
.Dragging() )
4613 HandleMouseUp(x
, y
, event
);
4616 wxPropertyGridPageState
* state
= m_pState
;
4618 int splitterHitOffset
;
4619 int columnHit
= state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4620 int splitterX
= x
- splitterHitOffset
;
4622 m_colHover
= columnHit
;
4624 if ( m_dragStatus
> 0 )
4626 if ( x
> (m_marginWidth
+ wxPG_DRAG_MARGIN
) &&
4627 x
< (m_pState
->m_width
- wxPG_DRAG_MARGIN
) )
4630 int newSplitterX
= x
- m_dragOffset
;
4631 int splitterX
= x
- splitterHitOffset
;
4633 // Splitter redraw required?
4634 if ( newSplitterX
!= splitterX
)
4637 state
->m_dontCenterSplitter
= true;
4638 state
->DoSetSplitterPosition(newSplitterX
,
4641 state
->m_fSplitterX
= (float) newSplitterX
;
4643 if ( GetSelection() )
4644 CorrectEditorWidgetSizeX();
4658 int ih
= m_lineHeight
;
4661 #if wxPG_SUPPORT_TOOLTIPS
4662 wxPGProperty
* prevHover
= m_propHover
;
4663 unsigned char prevSide
= m_mouseSide
;
4665 int curPropHoverY
= y
- (y
% ih
);
4667 // On which item it hovers
4670 ( sy
< m_propHoverY
|| sy
>= (m_propHoverY
+ih
) )
4673 // Mouse moves on another property
4675 m_propHover
= DoGetItemAtY(y
);
4676 m_propHoverY
= curPropHoverY
;
4679 SendEvent( wxEVT_PG_HIGHLIGHTED
, m_propHover
);
4682 #if wxPG_SUPPORT_TOOLTIPS
4683 // Store which side we are on
4685 if ( columnHit
== 1 )
4687 else if ( columnHit
== 0 )
4691 // If tooltips are enabled, show label or value as a tip
4692 // in case it doesn't otherwise show in full length.
4694 if ( m_windowStyle
& wxPG_TOOLTIPS
)
4696 wxToolTip
* tooltip
= GetToolTip();
4698 if ( m_propHover
!= prevHover
|| prevSide
!= m_mouseSide
)
4700 if ( m_propHover
&& !m_propHover
->IsCategory() )
4703 if ( GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS
)
4705 // Show help string as a tooltip
4706 wxString tipString
= m_propHover
->GetHelpString();
4708 SetToolTip(tipString
);
4712 // Show cropped value string as a tooltip
4716 if ( m_mouseSide
== 1 )
4718 tipString
= m_propHover
->m_label
;
4719 space
= splitterX
-m_marginWidth
-3;
4721 else if ( m_mouseSide
== 2 )
4723 tipString
= m_propHover
->GetDisplayedString();
4725 space
= m_width
- splitterX
;
4726 if ( m_propHover
->m_flags
& wxPG_PROP_CUSTOMIMAGE
)
4727 space
-= wxPG_CUSTOM_IMAGE_WIDTH
+
4728 wxCC_CUSTOM_IMAGE_MARGIN1
+
4729 wxCC_CUSTOM_IMAGE_MARGIN2
;
4735 GetTextExtent( tipString
, &tw
, &th
, 0, 0 );
4738 SetToolTip( tipString
);
4745 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4746 SetToolTip( m_emptyString
);
4748 wxScrolledWindow::SetToolTip( NULL
);
4759 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4760 SetToolTip( m_emptyString
);
4762 wxScrolledWindow::SetToolTip( NULL
);
4770 if ( splitterHit
== -1 ||
4772 HasFlag(wxPG_STATIC_SPLITTER
) )
4774 // hovering on something else
4775 if ( m_curcursor
!= wxCURSOR_ARROW
)
4776 CustomSetCursor( wxCURSOR_ARROW
);
4780 // Do not allow splitter cursor on caption items.
4781 // (also not if we were dragging and its started
4782 // outside the splitter region)
4784 if ( !m_propHover
->IsCategory() &&
4788 // hovering on splitter
4790 // NB: Condition disabled since MouseLeave event (from the
4791 // editor control) cannot be reliably detected.
4792 //if ( m_curcursor != wxCURSOR_SIZEWE )
4793 CustomSetCursor( wxCURSOR_SIZEWE
, true );
4799 // hovering on something else
4800 if ( m_curcursor
!= wxCURSOR_ARROW
)
4801 CustomSetCursor( wxCURSOR_ARROW
);
4806 // Multi select by dragging
4808 if ( (GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION
) &&
4809 event
.LeftIsDown() &&
4813 !state
->DoIsPropertySelected(m_propHover
) )
4815 // Additional requirement is that the hovered property
4816 // is adjacent to edges of selection.
4817 const wxArrayPGProperty
& selection
= GetSelectedProperties();
4819 // Since categories cannot be selected along with 'other'
4820 // properties, exclude them from iterator flags.
4821 int iterFlags
= wxPG_ITERATE_VISIBLE
& (~wxPG_PROP_CATEGORY
);
4823 for ( int i
=(selection
.size()-1); i
>=0; i
-- )
4825 // TODO: This could be optimized by keeping track of
4826 // which properties are at the edges of selection.
4827 wxPGProperty
* selProp
= selection
[i
];
4828 if ( state
->ArePropertiesAdjacent(m_propHover
, selProp
,
4831 DoAddToSelection(m_propHover
);
4840 // -----------------------------------------------------------------------
4842 // Also handles Leaving event
4843 bool wxPropertyGrid::HandleMouseUp( int x
, unsigned int WXUNUSED(y
),
4844 wxMouseEvent
&WXUNUSED(event
) )
4846 wxPropertyGridPageState
* state
= m_pState
;
4850 int splitterHitOffset
;
4851 state
->HitTestH( x
, &splitterHit
, &splitterHitOffset
);
4853 // No event type check - basicly calling this method should
4854 // just stop dragging.
4855 // Left up after dragged?
4856 if ( m_dragStatus
>= 1 )
4859 // End Splitter Dragging
4861 // DO NOT ENABLE FOLLOWING LINE!
4862 // (it is only here as a reminder to not to do it)
4865 // Disable splitter auto-centering
4866 state
->m_dontCenterSplitter
= true;
4868 // This is necessary to return cursor
4869 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
4872 m_iFlags
&= ~(wxPG_FL_MOUSE_CAPTURED
);
4875 // Set back the default cursor, if necessary
4876 if ( splitterHit
== -1 ||
4879 CustomSetCursor( wxCURSOR_ARROW
);
4884 // Control background needs to be cleared
4885 wxPGProperty
* selected
= GetSelection();
4886 if ( !(m_iFlags
& wxPG_FL_PRIMARY_FILLS_ENTIRE
) && selected
)
4887 DrawItem( selected
);
4891 m_wndEditor
->Show ( true );
4894 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4895 // Fixes button disappearance bug
4897 m_wndEditor2
->Show ( true );
4900 // This clears the focus.
4901 m_editorFocused
= 0;
4907 // -----------------------------------------------------------------------
4909 bool wxPropertyGrid::OnMouseCommon( wxMouseEvent
& event
, int* px
, int* py
)
4911 int splitterX
= GetSplitterPosition();
4914 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &ux
, &uy
);
4916 wxWindow
* wnd
= GetEditorControl();
4918 // Hide popup on clicks
4919 if ( event
.GetEventType() != wxEVT_MOTION
)
4920 if ( wnd
&& wnd
->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox
)) )
4922 ((wxOwnerDrawnComboBox
*)wnd
)->HidePopup();
4928 if ( wnd
== NULL
|| m_dragStatus
||
4930 ux
<= (splitterX
+ wxPG_SPLITTERX_DETECTMARGIN2
) ||
4931 ux
>= (r
.x
+r
.width
) ||
4933 event
.m_y
>= (r
.y
+r
.height
)
4943 if ( m_curcursor
!= wxCURSOR_ARROW
) CustomSetCursor ( wxCURSOR_ARROW
);
4948 // -----------------------------------------------------------------------
4950 void wxPropertyGrid::OnMouseClick( wxMouseEvent
&event
)
4953 if ( OnMouseCommon( event
, &x
, &y
) )
4955 HandleMouseClick(x
,y
,event
);
4960 // -----------------------------------------------------------------------
4962 void wxPropertyGrid::OnMouseRightClick( wxMouseEvent
&event
)
4965 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &x
, &y
);
4966 HandleMouseRightClick(x
,y
,event
);
4970 // -----------------------------------------------------------------------
4972 void wxPropertyGrid::OnMouseDoubleClick( wxMouseEvent
&event
)
4974 // Always run standard mouse-down handler as well
4975 OnMouseClick(event
);
4978 CalcUnscrolledPosition( event
.m_x
, event
.m_y
, &x
, &y
);
4979 HandleMouseDoubleClick(x
,y
,event
);
4983 // -----------------------------------------------------------------------
4985 void wxPropertyGrid::OnMouseMove( wxMouseEvent
&event
)
4988 if ( OnMouseCommon( event
, &x
, &y
) )
4990 HandleMouseMove(x
,y
,event
);
4995 // -----------------------------------------------------------------------
4997 void wxPropertyGrid::OnMouseUp( wxMouseEvent
&event
)
5000 if ( OnMouseCommon( event
, &x
, &y
) )
5002 HandleMouseUp(x
,y
,event
);
5007 // -----------------------------------------------------------------------
5009 void wxPropertyGrid::OnMouseEntry( wxMouseEvent
&event
)
5011 // This may get called from child control as well, so event's
5012 // mouse position cannot be relied on.
5014 if ( event
.Entering() )
5016 if ( !(m_iFlags
& wxPG_FL_MOUSE_INSIDE
) )
5018 // TODO: Fix this (detect parent and only do
5019 // cursor trick if it is a manager).
5020 wxASSERT( GetParent() );
5021 GetParent()->SetCursor(wxNullCursor
);
5023 m_iFlags
|= wxPG_FL_MOUSE_INSIDE
;
5026 GetParent()->SetCursor(wxNullCursor
);
5028 else if ( event
.Leaving() )
5030 // Without this, wxSpinCtrl editor will sometimes have wrong cursor
5031 SetCursor( wxNullCursor
);
5033 // Get real cursor position
5034 wxPoint pt
= ScreenToClient(::wxGetMousePosition());
5036 if ( ( pt
.x
<= 0 || pt
.y
<= 0 || pt
.x
>= m_width
|| pt
.y
>= m_height
) )
5039 if ( (m_iFlags
& wxPG_FL_MOUSE_INSIDE
) )
5041 m_iFlags
&= ~(wxPG_FL_MOUSE_INSIDE
);
5045 wxPropertyGrid::HandleMouseUp ( -1, 10000, event
);
5053 // -----------------------------------------------------------------------
5055 // Common code used by various OnMouseXXXChild methods.
5056 bool wxPropertyGrid::OnMouseChildCommon( wxMouseEvent
&event
, int* px
, int *py
)
5058 wxWindow
* topCtrlWnd
= (wxWindow
*)event
.GetEventObject();
5059 wxASSERT( topCtrlWnd
);
5061 event
.GetPosition(&x
,&y
);
5063 int splitterX
= GetSplitterPosition();
5065 wxRect r
= topCtrlWnd
->GetRect();
5066 if ( !m_dragStatus
&&
5067 x
> (splitterX
-r
.x
+wxPG_SPLITTERX_DETECTMARGIN2
) &&
5068 y
>= 0 && y
< r
.height \
5071 if ( m_curcursor
!= wxCURSOR_ARROW
) CustomSetCursor ( wxCURSOR_ARROW
);
5076 CalcUnscrolledPosition( event
.m_x
+ r
.x
, event
.m_y
+ r
.y
, \
5083 void wxPropertyGrid::OnMouseClickChild( wxMouseEvent
&event
)
5086 if ( OnMouseChildCommon(event
,&x
,&y
) )
5088 bool res
= HandleMouseClick(x
,y
,event
);
5089 if ( !res
) event
.Skip();
5093 void wxPropertyGrid::OnMouseRightClickChild( wxMouseEvent
&event
)
5096 wxASSERT( m_wndEditor
);
5097 // These coords may not be exact (about +-2),
5098 // but that should not matter (right click is about item, not position).
5099 wxPoint pt
= m_wndEditor
->GetPosition();
5100 CalcUnscrolledPosition( event
.m_x
+ pt
.x
, event
.m_y
+ pt
.y
, &x
, &y
);
5102 // FIXME: Used to set m_propHover to selection here. Was it really
5105 bool res
= HandleMouseRightClick(x
,y
,event
);
5106 if ( !res
) event
.Skip();
5109 void wxPropertyGrid::OnMouseMoveChild( wxMouseEvent
&event
)
5112 if ( OnMouseChildCommon(event
,&x
,&y
) )
5114 bool res
= HandleMouseMove(x
,y
,event
);
5115 if ( !res
) event
.Skip();
5119 void wxPropertyGrid::OnMouseUpChild( wxMouseEvent
&event
)
5122 if ( OnMouseChildCommon(event
,&x
,&y
) )
5124 bool res
= HandleMouseUp(x
,y
,event
);
5125 if ( !res
) event
.Skip();
5129 // -----------------------------------------------------------------------
5130 // wxPropertyGrid keyboard event handling
5131 // -----------------------------------------------------------------------
5133 int wxPropertyGrid::KeyEventToActions(wxKeyEvent
&event
, int* pSecond
) const
5135 // Translates wxKeyEvent to wxPG_ACTION_XXX
5137 int keycode
= event
.GetKeyCode();
5138 int modifiers
= event
.GetModifiers();
5140 wxASSERT( !(modifiers
&~(0xFFFF)) );
5142 int hashMapKey
= (keycode
& 0xFFFF) | ((modifiers
& 0xFFFF) << 16);
5144 wxPGHashMapI2I::const_iterator it
= m_actionTriggers
.find(hashMapKey
);
5146 if ( it
== m_actionTriggers
.end() )
5151 int second
= (it
->second
>>16) & 0xFFFF;
5155 return (it
->second
& 0xFFFF);
5158 void wxPropertyGrid::AddActionTrigger( int action
, int keycode
, int modifiers
)
5160 wxASSERT( !(modifiers
&~(0xFFFF)) );
5162 int hashMapKey
= (keycode
& 0xFFFF) | ((modifiers
& 0xFFFF) << 16);
5164 wxPGHashMapI2I::iterator it
= m_actionTriggers
.find(hashMapKey
);
5166 if ( it
!= m_actionTriggers
.end() )
5168 // This key combination is already used
5170 // Can add secondary?
5171 wxASSERT_MSG( !(it
->second
&~(0xFFFF)),
5172 wxT("You can only add up to two separate actions per key combination.") );
5174 action
= it
->second
| (action
<<16);
5177 m_actionTriggers
[hashMapKey
] = action
;
5180 void wxPropertyGrid::ClearActionTriggers( int action
)
5182 wxPGHashMapI2I::iterator it
;
5187 didSomething
= false;
5189 for ( it
= m_actionTriggers
.begin();
5190 it
!= m_actionTriggers
.end();
5193 if ( it
->second
== action
)
5195 m_actionTriggers
.erase(it
);
5196 didSomething
= true;
5201 while ( didSomething
);
5204 void wxPropertyGrid::HandleKeyEvent( wxKeyEvent
&event
, bool fromChild
)
5207 // Handles key event when editor control is not focused.
5210 wxCHECK2(!m_frozen
, return);
5212 // Travelsal between items, collapsing/expanding, etc.
5213 wxPGProperty
* selected
= GetSelection();
5214 int keycode
= event
.GetKeyCode();
5215 bool editorFocused
= IsEditorFocused();
5217 if ( keycode
== WXK_TAB
)
5219 wxWindow
* mainControl
;
5221 if ( HasInternalFlag(wxPG_FL_IN_MANAGER
) )
5222 mainControl
= GetParent();
5226 if ( !event
.ShiftDown() )
5228 if ( !editorFocused
&& m_wndEditor
)
5230 DoSelectProperty( selected
, wxPG_SEL_FOCUS
);
5234 // Tab traversal workaround for platforms on which
5235 // wxWindow::Navigate() may navigate into first child
5236 // instead of next sibling. Does not work perfectly
5237 // in every scenario (for instance, when property grid
5238 // is either first or last control).
5239 #if defined(__WXGTK__)
5240 wxWindow
* sibling
= mainControl
->GetNextSibling();
5242 sibling
->SetFocusFromKbd();
5244 Navigate(wxNavigationKeyEvent::IsForward
);
5250 if ( editorFocused
)
5256 #if defined(__WXGTK__)
5257 wxWindow
* sibling
= mainControl
->GetPrevSibling();
5259 sibling
->SetFocusFromKbd();
5261 Navigate(wxNavigationKeyEvent::IsBackward
);
5269 // Ignore Alt and Control when they are down alone
5270 if ( keycode
== WXK_ALT
||
5271 keycode
== WXK_CONTROL
)
5278 int action
= KeyEventToActions(event
, &secondAction
);
5280 if ( editorFocused
&& action
== wxPG_ACTION_CANCEL_EDIT
)
5283 // Esc cancels any changes
5284 if ( IsEditorsValueModified() )
5286 EditorsValueWasNotModified();
5288 // Update the control as well
5289 selected
->GetEditorClass()->
5290 SetControlStringValue( selected
,
5292 selected
->GetDisplayedString() );
5295 OnValidationFailureReset(selected
);
5301 // Except for TAB and ESC, handle child control events in child control
5304 // Only propagate event if it had modifiers
5305 if ( !event
.HasModifiers() )
5307 event
.StopPropagation();
5313 bool wasHandled
= false;
5318 if ( ButtonTriggerKeyTest(action
, event
) )
5321 wxPGProperty
* p
= selected
;
5323 // Travel and expand/collapse
5326 if ( p
->GetChildCount() )
5328 if ( action
== wxPG_ACTION_COLLAPSE_PROPERTY
|| secondAction
== wxPG_ACTION_COLLAPSE_PROPERTY
)
5330 if ( (m_windowStyle
& wxPG_HIDE_MARGIN
) || Collapse(p
) )
5333 else if ( action
== wxPG_ACTION_EXPAND_PROPERTY
|| secondAction
== wxPG_ACTION_EXPAND_PROPERTY
)
5335 if ( (m_windowStyle
& wxPG_HIDE_MARGIN
) || Expand(p
) )
5342 if ( action
== wxPG_ACTION_PREV_PROPERTY
|| secondAction
== wxPG_ACTION_PREV_PROPERTY
)
5346 else if ( action
== wxPG_ACTION_NEXT_PROPERTY
|| secondAction
== wxPG_ACTION_NEXT_PROPERTY
)
5352 if ( selectDir
>= -1 )
5354 p
= wxPropertyGridIterator::OneStep( m_pState
, wxPG_ITERATE_VISIBLE
, p
, selectDir
);
5356 DoSelectProperty(p
);
5362 // If nothing was selected, select the first item now
5363 // (or navigate out of tab).
5364 if ( action
!= wxPG_ACTION_CANCEL_EDIT
&& secondAction
!= wxPG_ACTION_CANCEL_EDIT
)
5366 wxPGProperty
* p
= wxPropertyGridInterface::GetFirst();
5367 if ( p
) DoSelectProperty(p
);
5376 // -----------------------------------------------------------------------
5378 void wxPropertyGrid::OnKey( wxKeyEvent
&event
)
5380 // If there was editor open and focused, then this event should not
5381 // really be processed here.
5382 if ( IsEditorFocused() )
5384 // However, if event had modifiers, it is probably still best
5386 if ( event
.HasModifiers() )
5389 event
.StopPropagation();
5393 HandleKeyEvent(event
, false);
5396 // -----------------------------------------------------------------------
5398 bool wxPropertyGrid::ButtonTriggerKeyTest( int action
, wxKeyEvent
& event
)
5403 action
= KeyEventToActions(event
, &secondAction
);
5406 // Does the keycode trigger button?
5407 if ( action
== wxPG_ACTION_PRESS_BUTTON
&&
5410 wxCommandEvent
evt(wxEVT_COMMAND_BUTTON_CLICKED
, m_wndEditor2
->GetId());
5411 GetEventHandler()->AddPendingEvent(evt
);
5418 // -----------------------------------------------------------------------
5420 void wxPropertyGrid::OnChildKeyDown( wxKeyEvent
&event
)
5422 HandleKeyEvent(event
, true);
5425 // -----------------------------------------------------------------------
5426 // wxPropertyGrid miscellaneous event handling
5427 // -----------------------------------------------------------------------
5429 void wxPropertyGrid::OnIdle( wxIdleEvent
& WXUNUSED(event
) )
5432 // Check if the focus is in this control or one of its children
5433 wxWindow
* newFocused
= wxWindow::FindFocus();
5435 if ( newFocused
!= m_curFocused
)
5436 HandleFocusChange( newFocused
);
5439 // Check if top-level parent has changed
5440 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING
)
5442 wxWindow
* tlp
= ::wxGetTopLevelParent(this);
5448 bool wxPropertyGrid::IsEditorFocused() const
5450 wxWindow
* focus
= wxWindow::FindFocus();
5452 if ( focus
== m_wndEditor
|| focus
== m_wndEditor2
||
5453 focus
== GetEditorControl() )
5459 // Called by focus event handlers. newFocused is the window that becomes focused.
5460 void wxPropertyGrid::HandleFocusChange( wxWindow
* newFocused
)
5462 unsigned int oldFlags
= m_iFlags
;
5464 m_iFlags
&= ~(wxPG_FL_FOCUSED
);
5466 wxWindow
* parent
= newFocused
;
5468 // This must be one of nextFocus' parents.
5471 // Use m_eventObject, which is either wxPropertyGrid or
5472 // wxPropertyGridManager, as appropriate.
5473 if ( parent
== m_eventObject
)
5475 m_iFlags
|= wxPG_FL_FOCUSED
;
5478 parent
= parent
->GetParent();
5481 m_curFocused
= newFocused
;
5483 if ( (m_iFlags
& wxPG_FL_FOCUSED
) !=
5484 (oldFlags
& wxPG_FL_FOCUSED
) )
5486 if ( !(m_iFlags
& wxPG_FL_FOCUSED
) )
5488 // Need to store changed value
5489 CommitChangesFromEditor();
5495 // Preliminary code for tab-order respecting
5496 // tab-traversal (but should be moved to
5499 wxWindow* prevFocus = event.GetWindow();
5500 wxWindow* useThis = this;
5501 if ( m_iFlags & wxPG_FL_IN_MANAGER )
5502 useThis = GetParent();
5505 prevFocus->GetParent() == useThis->GetParent() )
5507 wxList& children = useThis->GetParent()->GetChildren();
5509 wxNode* node = children.Find(prevFocus);
5511 if ( node->GetNext() &&
5512 useThis == node->GetNext()->GetData() )
5513 DoSelectProperty(GetFirst());
5514 else if ( node->GetPrevious () &&
5515 useThis == node->GetPrevious()->GetData() )
5516 DoSelectProperty(GetLastProperty());
5523 wxPGProperty
* selected
= GetSelection();
5524 if ( selected
&& (m_iFlags
& wxPG_FL_INITIALIZED
) )
5525 DrawItem( selected
);
5529 void wxPropertyGrid::OnFocusEvent( wxFocusEvent
& event
)
5531 if ( event
.GetEventType() == wxEVT_SET_FOCUS
)
5532 HandleFocusChange((wxWindow
*)event
.GetEventObject());
5533 // Line changed to "else" when applying wxPropertyGrid patch #1675902
5534 //else if ( event.GetWindow() )
5536 HandleFocusChange(event
.GetWindow());
5541 // -----------------------------------------------------------------------
5543 void wxPropertyGrid::OnChildFocusEvent( wxChildFocusEvent
& event
)
5545 HandleFocusChange((wxWindow
*)event
.GetEventObject());
5549 // -----------------------------------------------------------------------
5551 void wxPropertyGrid::OnScrollEvent( wxScrollWinEvent
&event
)
5553 m_iFlags
|= wxPG_FL_SCROLLED
;
5558 // -----------------------------------------------------------------------
5560 void wxPropertyGrid::OnCaptureChange( wxMouseCaptureChangedEvent
& WXUNUSED(event
) )
5562 if ( m_iFlags
& wxPG_FL_MOUSE_CAPTURED
)
5564 m_iFlags
&= ~(wxPG_FL_MOUSE_CAPTURED
);
5568 // -----------------------------------------------------------------------
5569 // Property editor related functions
5570 // -----------------------------------------------------------------------
5572 // noDefCheck = true prevents infinite recursion.
5573 wxPGEditor
* wxPropertyGrid::DoRegisterEditorClass( wxPGEditor
* editorClass
,
5574 const wxString
& editorName
,
5577 wxASSERT( editorClass
);
5579 if ( !noDefCheck
&& wxPGGlobalVars
->m_mapEditorClasses
.empty() )
5580 RegisterDefaultEditors();
5582 wxString name
= editorName
;
5583 if ( name
.length() == 0 )
5584 name
= editorClass
->GetName();
5586 // Existing editor under this name?
5587 wxPGHashMapS2P::iterator vt_it
= wxPGGlobalVars
->m_mapEditorClasses
.find(name
);
5589 if ( vt_it
!= wxPGGlobalVars
->m_mapEditorClasses
.end() )
5591 // If this name was already used, try class name.
5592 name
= editorClass
->GetClassInfo()->GetClassName();
5593 vt_it
= wxPGGlobalVars
->m_mapEditorClasses
.find(name
);
5596 wxCHECK_MSG( vt_it
== wxPGGlobalVars
->m_mapEditorClasses
.end(),
5597 (wxPGEditor
*) vt_it
->second
,
5598 "Editor with given name was already registered" );
5600 wxPGGlobalVars
->m_mapEditorClasses
[name
] = (void*)editorClass
;
5605 // Use this in RegisterDefaultEditors.
5606 #define wxPGRegisterDefaultEditorClass(EDITOR) \
5607 if ( wxPGEditor_##EDITOR == NULL ) \
5609 wxPGEditor_##EDITOR = wxPropertyGrid::RegisterEditorClass( \
5610 new wxPG##EDITOR##Editor, true ); \
5613 // Registers all default editor classes
5614 void wxPropertyGrid::RegisterDefaultEditors()
5616 wxPGRegisterDefaultEditorClass( TextCtrl
);
5617 wxPGRegisterDefaultEditorClass( Choice
);
5618 wxPGRegisterDefaultEditorClass( ComboBox
);
5619 wxPGRegisterDefaultEditorClass( TextCtrlAndButton
);
5620 #if wxPG_INCLUDE_CHECKBOX
5621 wxPGRegisterDefaultEditorClass( CheckBox
);
5623 wxPGRegisterDefaultEditorClass( ChoiceAndButton
);
5625 // Register SpinCtrl etc. editors before use
5626 RegisterAdditionalEditors();
5629 // -----------------------------------------------------------------------
5630 // wxPGStringTokenizer
5631 // Needed to handle C-style string lists (e.g. "str1" "str2")
5632 // -----------------------------------------------------------------------
5634 wxPGStringTokenizer::wxPGStringTokenizer( const wxString
& str
, wxChar delimeter
)
5635 : m_str(&str
), m_curPos(str
.begin()), m_delimeter(delimeter
)
5639 wxPGStringTokenizer::~wxPGStringTokenizer()
5643 bool wxPGStringTokenizer::HasMoreTokens()
5645 const wxString
& str
= *m_str
;
5647 wxString::const_iterator i
= m_curPos
;
5649 wxUniChar delim
= m_delimeter
;
5651 wxUniChar prev_a
= wxT('\0');
5653 bool inToken
= false;
5655 while ( i
!= str
.end() )
5664 m_readyToken
.clear();
5669 if ( prev_a
!= wxT('\\') )
5673 if ( a
!= wxT('\\') )
5693 m_curPos
= str
.end();
5701 wxString
wxPGStringTokenizer::GetNextToken()
5703 return m_readyToken
;
5706 // -----------------------------------------------------------------------
5708 // -----------------------------------------------------------------------
5710 wxPGChoiceEntry::wxPGChoiceEntry()
5711 : wxPGCell(), m_value(wxPG_INVALID_VALUE
)
5715 // -----------------------------------------------------------------------
5717 // -----------------------------------------------------------------------
5719 wxPGChoicesData::wxPGChoicesData()
5723 wxPGChoicesData::~wxPGChoicesData()
5728 void wxPGChoicesData::Clear()
5733 void wxPGChoicesData::CopyDataFrom( wxPGChoicesData
* data
)
5735 wxASSERT( m_items
.size() == 0 );
5737 m_items
= data
->m_items
;
5740 wxPGChoiceEntry
& wxPGChoicesData::Insert( int index
,
5741 const wxPGChoiceEntry
& item
)
5743 wxVector
<wxPGChoiceEntry
>::iterator it
;
5747 index
= (int) m_items
.size();
5751 it
= m_items
.begin() + index
;
5754 m_items
.insert(it
, item
);
5756 wxPGChoiceEntry
& ownEntry
= m_items
[index
];
5758 // Need to fix value?
5759 if ( ownEntry
.GetValue() == wxPG_INVALID_VALUE
)
5760 ownEntry
.SetValue(index
);
5765 // -----------------------------------------------------------------------
5766 // wxPropertyGridEvent
5767 // -----------------------------------------------------------------------
5769 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGridEvent
, wxCommandEvent
)
5772 wxDEFINE_EVENT( wxEVT_PG_SELECTED
, wxPropertyGridEvent
);
5773 wxDEFINE_EVENT( wxEVT_PG_CHANGING
, wxPropertyGridEvent
);
5774 wxDEFINE_EVENT( wxEVT_PG_CHANGED
, wxPropertyGridEvent
);
5775 wxDEFINE_EVENT( wxEVT_PG_HIGHLIGHTED
, wxPropertyGridEvent
);
5776 wxDEFINE_EVENT( wxEVT_PG_RIGHT_CLICK
, wxPropertyGridEvent
);
5777 wxDEFINE_EVENT( wxEVT_PG_PAGE_CHANGED
, wxPropertyGridEvent
);
5778 wxDEFINE_EVENT( wxEVT_PG_ITEM_EXPANDED
, wxPropertyGridEvent
);
5779 wxDEFINE_EVENT( wxEVT_PG_ITEM_COLLAPSED
, wxPropertyGridEvent
);
5780 wxDEFINE_EVENT( wxEVT_PG_DOUBLE_CLICK
, wxPropertyGridEvent
);
5781 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_BEGIN
, wxPropertyGridEvent
);
5782 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_ENDING
, wxPropertyGridEvent
);
5784 // -----------------------------------------------------------------------
5786 void wxPropertyGridEvent::Init()
5788 m_validationInfo
= NULL
;
5791 m_wasVetoed
= false;
5794 // -----------------------------------------------------------------------
5796 wxPropertyGridEvent::wxPropertyGridEvent(wxEventType commandType
, int id
)
5797 : wxCommandEvent(commandType
,id
)
5803 // -----------------------------------------------------------------------
5805 wxPropertyGridEvent::wxPropertyGridEvent(const wxPropertyGridEvent
& event
)
5806 : wxCommandEvent(event
)
5808 m_eventType
= event
.GetEventType();
5809 m_eventObject
= event
.m_eventObject
;
5811 OnPropertyGridSet();
5812 m_property
= event
.m_property
;
5813 m_validationInfo
= event
.m_validationInfo
;
5814 m_canVeto
= event
.m_canVeto
;
5815 m_wasVetoed
= event
.m_wasVetoed
;
5818 // -----------------------------------------------------------------------
5820 void wxPropertyGridEvent::OnPropertyGridSet()
5826 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
5828 m_pg
->m_liveEvents
.push_back(this);
5831 // -----------------------------------------------------------------------
5833 wxPropertyGridEvent::~wxPropertyGridEvent()
5838 wxCriticalSectionLocker(wxPGGlobalVars
->m_critSect
);
5841 // Use iterate from the back since it is more likely that the event
5842 // being desroyed is at the end of the array.
5843 wxVector
<wxPropertyGridEvent
*>& liveEvents
= m_pg
->m_liveEvents
;
5845 for ( int i
= liveEvents
.size()-1; i
>= 0; i
-- )
5847 if ( liveEvents
[i
] == this )
5849 liveEvents
.erase(liveEvents
.begin() + i
);
5856 // -----------------------------------------------------------------------
5858 wxEvent
* wxPropertyGridEvent::Clone() const
5860 return new wxPropertyGridEvent( *this );
5863 // -----------------------------------------------------------------------
5864 // wxPropertyGridPopulator
5865 // -----------------------------------------------------------------------
5867 wxPropertyGridPopulator::wxPropertyGridPopulator()
5871 wxPGGlobalVars
->m_offline
++;
5874 // -----------------------------------------------------------------------
5876 void wxPropertyGridPopulator::SetState( wxPropertyGridPageState
* state
)
5879 m_propHierarchy
.clear();
5882 // -----------------------------------------------------------------------
5884 void wxPropertyGridPopulator::SetGrid( wxPropertyGrid
* pg
)
5890 // -----------------------------------------------------------------------
5892 wxPropertyGridPopulator::~wxPropertyGridPopulator()
5895 // Free unused sets of choices
5896 wxPGHashMapS2P::iterator it
;
5898 for( it
= m_dictIdChoices
.begin(); it
!= m_dictIdChoices
.end(); ++it
)
5900 wxPGChoicesData
* data
= (wxPGChoicesData
*) it
->second
;
5907 m_pg
->GetPanel()->Refresh();
5909 wxPGGlobalVars
->m_offline
--;
5912 // -----------------------------------------------------------------------
5914 wxPGProperty
* wxPropertyGridPopulator::Add( const wxString
& propClass
,
5915 const wxString
& propLabel
,
5916 const wxString
& propName
,
5917 const wxString
* propValue
,
5918 wxPGChoices
* pChoices
)
5920 wxClassInfo
* classInfo
= wxClassInfo::FindClass(propClass
);
5921 wxPGProperty
* parent
= GetCurParent();
5923 if ( parent
->HasFlag(wxPG_PROP_AGGREGATE
) )
5925 ProcessError(wxString::Format(wxT("new children cannot be added to '%s'"),parent
->GetName().c_str()));
5929 if ( !classInfo
|| !classInfo
->IsKindOf(CLASSINFO(wxPGProperty
)) )
5931 ProcessError(wxString::Format(wxT("'%s' is not valid property class"),propClass
.c_str()));
5935 wxPGProperty
* property
= (wxPGProperty
*) classInfo
->CreateObject();
5937 property
->SetLabel(propLabel
);
5938 property
->DoSetName(propName
);
5940 if ( pChoices
&& pChoices
->IsOk() )
5941 property
->SetChoices(*pChoices
);
5943 m_state
->DoInsert(parent
, -1, property
);
5946 property
->SetValueFromString( *propValue
, wxPG_FULL_VALUE
|
5947 wxPG_PROGRAMMATIC_VALUE
);
5952 // -----------------------------------------------------------------------
5954 void wxPropertyGridPopulator::AddChildren( wxPGProperty
* property
)
5956 m_propHierarchy
.push_back(property
);
5957 DoScanForChildren();
5958 m_propHierarchy
.pop_back();
5961 // -----------------------------------------------------------------------
5963 wxPGChoices
wxPropertyGridPopulator::ParseChoices( const wxString
& choicesString
,
5964 const wxString
& idString
)
5966 wxPGChoices choices
;
5969 if ( choicesString
[0] == wxT('@') )
5971 wxString ids
= choicesString
.substr(1);
5972 wxPGHashMapS2P::iterator it
= m_dictIdChoices
.find(ids
);
5973 if ( it
== m_dictIdChoices
.end() )
5974 ProcessError(wxString::Format(wxT("No choices defined for id '%s'"),ids
.c_str()));
5976 choices
.AssignData((wxPGChoicesData
*)it
->second
);
5981 if ( idString
.length() )
5983 wxPGHashMapS2P::iterator it
= m_dictIdChoices
.find(idString
);
5984 if ( it
!= m_dictIdChoices
.end() )
5986 choices
.AssignData((wxPGChoicesData
*)it
->second
);
5993 // Parse choices string
5994 wxString::const_iterator it
= choicesString
.begin();
5998 bool labelValid
= false;
6000 for ( ; it
!= choicesString
.end(); ++it
)
6006 if ( c
== wxT('"') )
6011 if ( !value
.ToLong(&l
, 0) ) l
= wxPG_INVALID_VALUE
;
6012 choices
.Add(label
, l
);
6015 //wxLogDebug(wxT("%s, %s"),label.c_str(),value.c_str());
6020 else if ( c
== wxT('=') )
6027 else if ( state
== 2 && (wxIsalnum(c
) || c
== wxT('x')) )
6034 if ( c
== wxT('"') )
6047 if ( !value
.ToLong(&l
, 0) ) l
= wxPG_INVALID_VALUE
;
6048 choices
.Add(label
, l
);
6051 if ( !choices
.IsOk() )
6053 choices
.EnsureData();
6057 if ( idString
.length() )
6058 m_dictIdChoices
[idString
] = choices
.GetData();
6065 // -----------------------------------------------------------------------
6067 bool wxPropertyGridPopulator::ToLongPCT( const wxString
& s
, long* pval
, long max
)
6069 if ( s
.Last() == wxT('%') )
6071 wxString s2
= s
.substr(0,s
.length()-1);
6073 if ( s2
.ToLong(&val
, 10) )
6075 *pval
= (val
*max
)/100;
6081 return s
.ToLong(pval
, 10);
6084 // -----------------------------------------------------------------------
6086 bool wxPropertyGridPopulator::AddAttribute( const wxString
& name
,
6087 const wxString
& type
,
6088 const wxString
& value
)
6090 int l
= m_propHierarchy
.size();
6094 wxPGProperty
* p
= m_propHierarchy
[l
-1];
6095 wxString valuel
= value
.Lower();
6098 if ( type
.length() == 0 )
6103 if ( valuel
== wxT("true") || valuel
== wxT("yes") || valuel
== wxT("1") )
6105 else if ( valuel
== wxT("false") || valuel
== wxT("no") || valuel
== wxT("0") )
6107 else if ( value
.ToLong(&v
, 0) )
6114 if ( type
== wxT("string") )
6118 else if ( type
== wxT("int") )
6121 value
.ToLong(&v
, 0);
6124 else if ( type
== wxT("bool") )
6126 if ( valuel
== wxT("true") || valuel
== wxT("yes") || valuel
== wxT("1") )
6133 ProcessError(wxString::Format(wxT("Invalid attribute type '%s'"),type
.c_str()));
6138 p
->SetAttribute( name
, variant
);
6143 // -----------------------------------------------------------------------
6145 void wxPropertyGridPopulator::ProcessError( const wxString
& msg
)
6147 wxLogError(_("Error in resource: %s"),msg
.c_str());
6150 // -----------------------------------------------------------------------
6152 #endif // wxUSE_PROPGRID