Fix focus at the end of a property label edit (needed at least for wxGTK)
[wxWidgets.git] / src / propgrid / propgrid.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/propgrid/propgrid.cpp
3 // Purpose: wxPropertyGrid
4 // Author: Jaakko Salli
5 // Modified by:
6 // Created: 2004-09-25
7 // RCS-ID: $Id$
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 // For compilers that support precompilation, includes "wx/wx.h".
13 #include "wx/wxprec.h"
14
15 #ifdef __BORLANDC__
16 #pragma hdrstop
17 #endif
18
19 #if wxUSE_PROPGRID
20
21 #ifndef WX_PRECOMP
22 #include "wx/defs.h"
23 #include "wx/object.h"
24 #include "wx/hash.h"
25 #include "wx/string.h"
26 #include "wx/log.h"
27 #include "wx/event.h"
28 #include "wx/window.h"
29 #include "wx/panel.h"
30 #include "wx/dc.h"
31 #include "wx/dcmemory.h"
32 #include "wx/button.h"
33 #include "wx/pen.h"
34 #include "wx/brush.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"
43 #include "wx/sizer.h"
44 #include "wx/textdlg.h"
45 #include "wx/filedlg.h"
46 #include "wx/statusbr.h"
47 #include "wx/intl.h"
48 #include "wx/frame.h"
49 #endif
50
51
52 // This define is necessary to prevent macro clearing
53 #define __wxPG_SOURCE_FILE__
54
55 #include "wx/propgrid/propgrid.h"
56 #include "wx/propgrid/editors.h"
57
58 #if wxPG_USE_RENDERER_NATIVE
59 #include "wx/renderer.h"
60 #endif
61
62 #include "wx/odcombo.h"
63
64 #include "wx/timer.h"
65 #include "wx/dcbuffer.h"
66
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"
81 #else
82 #include "default_collapse.xpm"
83 #include "default_expand.xpm"
84 #endif
85 #endif
86
87
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
95
96 //#define wxPG_OPTIMAL_WIDTH 200 // Arbitrary
97
98 //#define wxPG_MIN_SCROLLBAR_WIDTH 10 // Smallest scrollbar width on any platform
99 // Must be larger than largest control border
100 // width * 2.
101
102
103 #define wxPG_DEFAULT_CURSOR wxNullCursor
104
105
106 //#define wxPG_NAT_CHOICE_BORDER_ANY 0
107
108 //#define wxPG_HIDER_BUTTON_HEIGHT 25
109
110 #define wxPG_PIXELS_PER_UNIT m_lineHeight
111
112 #ifdef wxPG_ICON_WIDTH
113 #define m_iconHeight m_iconWidth
114 #endif
115
116 //#define wxPG_TOOLTIP_DELAY 1000
117
118 // This is the number of pixels the expander button inside
119 // property cells (i.e. not in the grey margin area are
120 // adjusted.
121 #define IN_CELL_EXPANDER_BUTTON_X_ADJUST 2
122
123 // -----------------------------------------------------------------------
124
125 #if wxUSE_INTL
126 void wxPropertyGrid::AutoGetTranslation ( bool enable )
127 {
128 wxPGGlobalVars->m_autoGetTranslation = enable;
129 }
130 #else
131 void wxPropertyGrid::AutoGetTranslation ( bool ) { }
132 #endif
133
134 // -----------------------------------------------------------------------
135
136 const char wxPropertyGridNameStr[] = "wxPropertyGrid";
137
138 // -----------------------------------------------------------------------
139 // Statics in one class for easy destruction.
140 // -----------------------------------------------------------------------
141
142 #include "wx/module.h"
143
144 class wxPGGlobalVarsClassManager : public wxModule
145 {
146 DECLARE_DYNAMIC_CLASS(wxPGGlobalVarsClassManager)
147 public:
148 wxPGGlobalVarsClassManager() {}
149 virtual bool OnInit() { wxPGGlobalVars = new wxPGGlobalVarsClass(); return true; }
150 virtual void OnExit() { delete wxPGGlobalVars; wxPGGlobalVars = NULL; }
151 };
152
153 IMPLEMENT_DYNAMIC_CLASS(wxPGGlobalVarsClassManager, wxModule)
154
155
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()
159 {
160 wxModule* module = new wxPGGlobalVarsClassManager;
161 module->Init();
162 wxModule::RegisterModule(module);
163 }
164
165 wxPGGlobalVarsClass* wxPGGlobalVars = NULL;
166
167
168 wxPGGlobalVarsClass::wxPGGlobalVarsClass()
169 {
170 wxPGProperty::sm_wxPG_LABEL = new wxString(wxPG_LABEL_STRING);
171
172 m_boolChoices.Add(_("False"));
173 m_boolChoices.Add(_("True"));
174
175 m_fontFamilyChoices = NULL;
176
177 m_defaultRenderer = new wxPGDefaultRenderer();
178
179 m_autoGetTranslation = false;
180
181 m_offline = 0;
182
183 m_extraStyle = 0;
184
185 wxVariant v;
186
187 // Prepare some shared variants
188 m_vEmptyString = wxString();
189 m_vZero = (long) 0;
190 m_vMinusOne = (long) -1;
191 m_vTrue = true;
192 m_vFalse = false;
193
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_strHint = wxS("Hint");
204 #if wxPG_COMPATIBILITY_1_4
205 m_strInlineHelp = wxS("InlineHelp");
206 #endif
207
208 m_warnings = 0;
209 }
210
211
212 wxPGGlobalVarsClass::~wxPGGlobalVarsClass()
213 {
214 size_t i;
215
216 delete m_defaultRenderer;
217
218 // This will always have one ref
219 delete m_fontFamilyChoices;
220
221 #if wxUSE_VALIDATORS
222 for ( i=0; i<m_arrValidators.size(); i++ )
223 delete ((wxValidator*)m_arrValidators[i]);
224 #endif
225
226 //
227 // Destroy value type class instances.
228 wxPGHashMapS2P::iterator vt_it;
229
230 // Destroy editor class instances.
231 // iterate over all the elements in the class
232 for( vt_it = m_mapEditorClasses.begin(); vt_it != m_mapEditorClasses.end(); ++vt_it )
233 {
234 delete ((wxPGEditor*)vt_it->second);
235 }
236
237 delete wxPGProperty::sm_wxPG_LABEL;
238 }
239
240 void wxPropertyGridInitGlobalsIfNeeded()
241 {
242 }
243
244 // -----------------------------------------------------------------------
245 // wxPropertyGrid
246 // -----------------------------------------------------------------------
247
248 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGrid, wxScrolledWindow)
249
250 BEGIN_EVENT_TABLE(wxPropertyGrid, wxScrolledWindow)
251 EVT_IDLE(wxPropertyGrid::OnIdle)
252 EVT_PAINT(wxPropertyGrid::OnPaint)
253 EVT_SIZE(wxPropertyGrid::OnResize)
254 EVT_ENTER_WINDOW(wxPropertyGrid::OnMouseEntry)
255 EVT_LEAVE_WINDOW(wxPropertyGrid::OnMouseEntry)
256 EVT_MOUSE_CAPTURE_CHANGED(wxPropertyGrid::OnCaptureChange)
257 EVT_SCROLLWIN(wxPropertyGrid::OnScrollEvent)
258 EVT_CHILD_FOCUS(wxPropertyGrid::OnChildFocusEvent)
259 EVT_SET_FOCUS(wxPropertyGrid::OnFocusEvent)
260 EVT_KILL_FOCUS(wxPropertyGrid::OnFocusEvent)
261 EVT_SYS_COLOUR_CHANGED(wxPropertyGrid::OnSysColourChanged)
262 EVT_MOTION(wxPropertyGrid::OnMouseMove)
263 EVT_LEFT_DOWN(wxPropertyGrid::OnMouseClick)
264 EVT_LEFT_UP(wxPropertyGrid::OnMouseUp)
265 EVT_RIGHT_UP(wxPropertyGrid::OnMouseRightClick)
266 EVT_LEFT_DCLICK(wxPropertyGrid::OnMouseDoubleClick)
267 EVT_KEY_DOWN(wxPropertyGrid::OnKey)
268 END_EVENT_TABLE()
269
270 // -----------------------------------------------------------------------
271
272 wxPropertyGrid::wxPropertyGrid()
273 : wxScrolledWindow()
274 {
275 Init1();
276 }
277
278 // -----------------------------------------------------------------------
279
280 wxPropertyGrid::wxPropertyGrid( wxWindow *parent,
281 wxWindowID id,
282 const wxPoint& pos,
283 const wxSize& size,
284 long style,
285 const wxString& name )
286 : wxScrolledWindow()
287 {
288 Init1();
289 Create(parent,id,pos,size,style,name);
290 }
291
292 // -----------------------------------------------------------------------
293
294 bool wxPropertyGrid::Create( wxWindow *parent,
295 wxWindowID id,
296 const wxPoint& pos,
297 const wxSize& size,
298 long style,
299 const wxString& name )
300 {
301
302 if (!(style&wxBORDER_MASK))
303 {
304 style |= wxBORDER_THEME;
305 }
306
307 style |= wxVSCROLL;
308
309 // Filter out wxTAB_TRAVERSAL - we will handle TABs manually
310 style &= ~(wxTAB_TRAVERSAL);
311 style |= wxWANTS_CHARS;
312
313 wxScrolledWindow::Create(parent,id,pos,size,style,name);
314
315 Init2();
316
317 return true;
318 }
319
320 // -----------------------------------------------------------------------
321
322 //
323 // Initialize values to defaults
324 //
325 void wxPropertyGrid::Init1()
326 {
327 // Register editor classes, if necessary.
328 if ( wxPGGlobalVars->m_mapEditorClasses.empty() )
329 wxPropertyGrid::RegisterDefaultEditors();
330
331 m_iFlags = 0;
332 m_pState = NULL;
333 m_wndEditor = m_wndEditor2 = NULL;
334 m_selColumn = 1;
335 m_colHover = 1;
336 m_propHover = NULL;
337 m_labelEditor = NULL;
338 m_labelEditorProperty = NULL;
339 m_eventObject = this;
340 m_curFocused = NULL;
341 m_processedEvent = NULL;
342 m_sortFunction = NULL;
343 m_inDoPropertyChanged = 0;
344 m_inCommitChangesFromEditor = 0;
345 m_inDoSelectProperty = 0;
346 m_permanentValidationFailureBehavior = wxPG_VFB_DEFAULT;
347 m_dragStatus = 0;
348 m_mouseSide = 16;
349 m_editorFocused = 0;
350
351 // Set up default unspecified value 'colour'
352 m_unspecifiedAppearance.SetFgCol(*wxLIGHT_GREY);
353
354 // Set default keys
355 AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY, WXK_RIGHT );
356 AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY, WXK_DOWN );
357 AddActionTrigger( wxPG_ACTION_PREV_PROPERTY, WXK_LEFT );
358 AddActionTrigger( wxPG_ACTION_PREV_PROPERTY, WXK_UP );
359 AddActionTrigger( wxPG_ACTION_EXPAND_PROPERTY, WXK_RIGHT);
360 AddActionTrigger( wxPG_ACTION_COLLAPSE_PROPERTY, WXK_LEFT);
361 AddActionTrigger( wxPG_ACTION_CANCEL_EDIT, WXK_ESCAPE );
362 AddActionTrigger( wxPG_ACTION_PRESS_BUTTON, WXK_DOWN, wxMOD_ALT );
363 AddActionTrigger( wxPG_ACTION_PRESS_BUTTON, WXK_F4 );
364
365 m_coloursCustomized = 0;
366 m_frozen = 0;
367
368 #if wxPG_DOUBLE_BUFFER
369 m_doubleBuffer = NULL;
370 #endif
371
372 #ifndef wxPG_ICON_WIDTH
373 m_expandbmp = NULL;
374 m_collbmp = NULL;
375 m_iconWidth = 11;
376 m_iconHeight = 11;
377 #else
378 m_iconWidth = wxPG_ICON_WIDTH;
379 #endif
380
381 m_prevVY = -1;
382
383 m_gutterWidth = wxPG_GUTTER_MIN;
384 m_subgroup_extramargin = 10;
385
386 m_lineHeight = 0;
387
388 m_width = m_height = 0;
389
390 m_commonValues.push_back(new wxPGCommonValue(_("Unspecified"), wxPGGlobalVars->m_defaultRenderer) );
391 m_cvUnspecified = 0;
392
393 m_chgInfo_changedProperty = NULL;
394 }
395
396 // -----------------------------------------------------------------------
397
398 //
399 // Initialize after parent etc. set
400 //
401 void wxPropertyGrid::Init2()
402 {
403 wxASSERT( !(m_iFlags & wxPG_FL_INITIALIZED ) );
404
405 #ifdef __WXMAC__
406 // Smaller controls on Mac
407 SetWindowVariant(wxWINDOW_VARIANT_SMALL);
408 #endif
409
410 // Now create state, if one didn't exist already
411 // (wxPropertyGridManager might have created it for us).
412 if ( !m_pState )
413 {
414 m_pState = CreateState();
415 m_pState->m_pPropGrid = this;
416 m_iFlags |= wxPG_FL_CREATEDSTATE;
417 }
418
419 if ( !(m_windowStyle & wxPG_SPLITTER_AUTO_CENTER) )
420 m_pState->m_dontCenterSplitter = true;
421
422 if ( m_windowStyle & wxPG_HIDE_CATEGORIES )
423 {
424 m_pState->InitNonCatMode();
425
426 m_pState->m_properties = m_pState->m_abcArray;
427 }
428
429 GetClientSize(&m_width,&m_height);
430
431 #ifndef wxPG_ICON_WIDTH
432 // create two bitmap nodes for drawing
433 m_expandbmp = new wxBitmap(expand_xpm);
434 m_collbmp = new wxBitmap(collapse_xpm);
435
436 // calculate average font height for bitmap centering
437
438 m_iconWidth = m_expandbmp->GetWidth();
439 m_iconHeight = m_expandbmp->GetHeight();
440 #endif
441
442 m_curcursor = wxCURSOR_ARROW;
443 m_cursorSizeWE = new wxCursor( wxCURSOR_SIZEWE );
444
445 // adjust bitmap icon y position so they are centered
446 m_vspacing = wxPG_DEFAULT_VSPACING;
447
448 CalculateFontAndBitmapStuff( wxPG_DEFAULT_VSPACING );
449
450 // Allocate cell datas
451 m_propertyDefaultCell.SetEmptyData();
452 m_categoryDefaultCell.SetEmptyData();
453
454 RegainColours();
455
456 // This helps with flicker
457 SetBackgroundStyle( wxBG_STYLE_CUSTOM );
458
459 // Hook the top-level parent
460 m_tlp = NULL;
461 m_tlpClosed = NULL;
462 m_tlpClosedTime = 0;
463
464 // set virtual size to this window size
465 wxSize wndsize = GetSize();
466 SetVirtualSize(wndsize.GetWidth(), wndsize.GetWidth());
467
468 m_timeCreated = ::wxGetLocalTimeMillis();
469
470 //m_canvas->Create(this, wxID_ANY, wxPoint(0, 0), GetClientSize(),
471 // wxWANTS_CHARS | wxCLIP_CHILDREN);
472 SetBackgroundStyle( wxBG_STYLE_CUSTOM );
473
474 m_iFlags |= wxPG_FL_INITIALIZED;
475
476 m_ncWidth = wndsize.GetWidth();
477
478 // Need to call OnResize handler or size given in constructor/Create
479 // will never work.
480 wxSizeEvent sizeEvent(wndsize,0);
481 OnResize(sizeEvent);
482 }
483
484 // -----------------------------------------------------------------------
485
486 wxPropertyGrid::~wxPropertyGrid()
487 {
488 size_t i;
489
490 #if wxUSE_THREADS
491 wxCriticalSectionLocker(wxPGGlobalVars->m_critSect);
492 #endif
493
494 //
495 // Remove grid and property pointers from live wxPropertyGridEvents.
496 for ( i=0; i<m_liveEvents.size(); i++ )
497 {
498 wxPropertyGridEvent* evt = m_liveEvents[i];
499 evt->SetPropertyGrid(NULL);
500 evt->SetProperty(NULL);
501 }
502 m_liveEvents.clear();
503
504 if ( m_processedEvent )
505 {
506 // All right... we are being deleted while wxPropertyGrid event
507 // is being sent. Make sure that event propagates as little
508 // as possible (although usually this is not enough to prevent
509 // a crash).
510 m_processedEvent->Skip(false);
511 m_processedEvent->StopPropagation();
512
513 // Let's use wxMessageBox to make the message appear more
514 // reliably (and *before* the crash can happen).
515 ::wxMessageBox("wxPropertyGrid was being destroyed in an event "
516 "generated by it. This usually leads to a crash "
517 "so it is recommended to destroy the control "
518 "at idle time instead.");
519 }
520
521 DoSelectProperty(NULL, wxPG_SEL_NOVALIDATE|wxPG_SEL_DONT_SEND_EVENT);
522
523 // This should do prevent things from going too badly wrong
524 m_iFlags &= ~(wxPG_FL_INITIALIZED);
525
526 if ( m_iFlags & wxPG_FL_MOUSE_CAPTURED )
527 ReleaseMouse();
528
529 // Call with NULL to disconnect event handling
530 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING )
531 {
532 OnTLPChanging(NULL);
533
534 wxASSERT_MSG( !IsEditorsValueModified(),
535 wxS("Most recent change in property editor was ")
536 wxS("lost!!! (if you don't want this to happen, ")
537 wxS("close your frames and dialogs using ")
538 wxS("Close(false).)") );
539 }
540
541 #if wxPG_DOUBLE_BUFFER
542 if ( m_doubleBuffer )
543 delete m_doubleBuffer;
544 #endif
545
546 if ( m_iFlags & wxPG_FL_CREATEDSTATE )
547 delete m_pState;
548
549 delete m_cursorSizeWE;
550
551 #ifndef wxPG_ICON_WIDTH
552 delete m_expandbmp;
553 delete m_collbmp;
554 #endif
555
556 // Delete common value records
557 for ( i=0; i<m_commonValues.size(); i++ )
558 {
559 // Use temporary variable to work around possible strange VC6 (asserts because m_size is zero)
560 wxPGCommonValue* value = m_commonValues[i];
561 delete value;
562 }
563 }
564
565 // -----------------------------------------------------------------------
566
567 bool wxPropertyGrid::Destroy()
568 {
569 if ( m_iFlags & wxPG_FL_MOUSE_CAPTURED )
570 ReleaseMouse();
571
572 return wxScrolledWindow::Destroy();
573 }
574
575 // -----------------------------------------------------------------------
576
577 wxPropertyGridPageState* wxPropertyGrid::CreateState() const
578 {
579 return new wxPropertyGridPageState();
580 }
581
582 // -----------------------------------------------------------------------
583 // wxPropertyGrid overridden wxWindow methods
584 // -----------------------------------------------------------------------
585
586 void wxPropertyGrid::SetWindowStyleFlag( long style )
587 {
588 long old_style = m_windowStyle;
589
590 if ( m_iFlags & wxPG_FL_INITIALIZED )
591 {
592 wxASSERT( m_pState );
593
594 if ( !(style & wxPG_HIDE_CATEGORIES) && (old_style & wxPG_HIDE_CATEGORIES) )
595 {
596 // Enable categories
597 EnableCategories( true );
598 }
599 else if ( (style & wxPG_HIDE_CATEGORIES) && !(old_style & wxPG_HIDE_CATEGORIES) )
600 {
601 // Disable categories
602 EnableCategories( false );
603 }
604 if ( !(old_style & wxPG_AUTO_SORT) && (style & wxPG_AUTO_SORT) )
605 {
606 //
607 // Autosort enabled
608 //
609 if ( !m_frozen )
610 PrepareAfterItemsAdded();
611 else
612 m_pState->m_itemsAdded = 1;
613 }
614 #if wxPG_SUPPORT_TOOLTIPS
615 if ( !(old_style & wxPG_TOOLTIPS) && (style & wxPG_TOOLTIPS) )
616 {
617 //
618 // Tooltips enabled
619 //
620 /*
621 wxToolTip* tooltip = new wxToolTip ( wxEmptyString );
622 SetToolTip ( tooltip );
623 tooltip->SetDelay ( wxPG_TOOLTIP_DELAY );
624 */
625 }
626 else if ( (old_style & wxPG_TOOLTIPS) && !(style & wxPG_TOOLTIPS) )
627 {
628 //
629 // Tooltips disabled
630 //
631 wxScrolledWindow::SetToolTip( NULL );
632 }
633 #endif
634 }
635
636 wxScrolledWindow::SetWindowStyleFlag ( style );
637
638 if ( m_iFlags & wxPG_FL_INITIALIZED )
639 {
640 if ( (old_style & wxPG_HIDE_MARGIN) != (style & wxPG_HIDE_MARGIN) )
641 {
642 CalculateFontAndBitmapStuff( m_vspacing );
643 Refresh();
644 }
645 }
646 }
647
648 // -----------------------------------------------------------------------
649
650 void wxPropertyGrid::Freeze()
651 {
652 if ( !m_frozen )
653 {
654 wxScrolledWindow::Freeze();
655 }
656 m_frozen++;
657 }
658
659 // -----------------------------------------------------------------------
660
661 void wxPropertyGrid::Thaw()
662 {
663 m_frozen--;
664
665 if ( !m_frozen )
666 {
667 wxScrolledWindow::Thaw();
668 RecalculateVirtualSize();
669 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
670 Refresh();
671 #endif
672
673 // Force property re-selection
674 // NB: We must copy the selection.
675 wxArrayPGProperty selection = m_pState->m_selection;
676 DoSetSelection(selection, wxPG_SEL_FORCE | wxPG_SEL_NONVISIBLE);
677 }
678 }
679
680 // -----------------------------------------------------------------------
681
682 bool wxPropertyGrid::DoAddToSelection( wxPGProperty* prop, int selFlags )
683 {
684 wxCHECK( prop, false );
685
686 if ( !(GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION) )
687 return DoSelectProperty(prop, selFlags);
688
689 wxArrayPGProperty& selection = m_pState->m_selection;
690
691 if ( !selection.size() )
692 {
693 return DoSelectProperty(prop, selFlags);
694 }
695 else
696 {
697 // For categories, only one can be selected at a time
698 if ( prop->IsCategory() || selection[0]->IsCategory() )
699 return true;
700
701 selection.push_back(prop);
702
703 if ( !(selFlags & wxPG_SEL_DONT_SEND_EVENT) )
704 {
705 SendEvent( wxEVT_PG_SELECTED, prop, NULL );
706 }
707
708 DrawItem(prop);
709 }
710
711 return true;
712 }
713
714 // -----------------------------------------------------------------------
715
716 bool wxPropertyGrid::DoRemoveFromSelection( wxPGProperty* prop, int selFlags )
717 {
718 wxCHECK( prop, false );
719 bool res;
720
721 wxArrayPGProperty& selection = m_pState->m_selection;
722 if ( selection.size() <= 1 )
723 {
724 res = DoSelectProperty(NULL, selFlags);
725 }
726 else
727 {
728 m_pState->DoRemoveFromSelection(prop);
729 DrawItem(prop);
730 res = true;
731 }
732
733 return res;
734 }
735
736 // -----------------------------------------------------------------------
737
738 bool wxPropertyGrid::DoSelectAndEdit( wxPGProperty* prop,
739 unsigned int colIndex,
740 unsigned int selFlags )
741 {
742 //
743 // NB: Enable following if label editor background colour is
744 // ever changed to any other than m_colSelBack.
745 //
746 // We use this workaround to prevent visible flicker when editing
747 // a cell. Atleast on wxMSW, there is a difficult to find
748 // (and perhaps prevent) redraw somewhere between making property
749 // selected and enabling label editing.
750 //
751 //wxColour prevColSelBack = m_colSelBack;
752 //m_colSelBack = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
753
754 bool res;
755
756 if ( colIndex == 1 )
757 {
758 res = DoSelectProperty(prop, selFlags);
759 }
760 else
761 {
762 // send event
763 DoClearSelection(false, wxPG_SEL_NO_REFRESH);
764
765 if ( m_pState->m_editableColumns.Index(colIndex) == wxNOT_FOUND )
766 {
767 res = DoAddToSelection(prop, selFlags);
768 }
769 else
770 {
771 res = DoAddToSelection(prop, selFlags|wxPG_SEL_NO_REFRESH);
772
773 DoBeginLabelEdit(colIndex, selFlags);
774 }
775 }
776
777 //m_colSelBack = prevColSelBack;
778 return res;
779 }
780
781 // -----------------------------------------------------------------------
782
783 bool wxPropertyGrid::AddToSelectionFromInputEvent( wxPGProperty* prop,
784 unsigned int colIndex,
785 wxMouseEvent* mouseEvent,
786 int selFlags )
787 {
788 const wxArrayPGProperty& selection = GetSelectedProperties();
789 bool alreadySelected = m_pState->DoIsPropertySelected(prop);
790 bool res = true;
791
792 // Set to 2 if also add all items in between
793 int addToExistingSelection = 0;
794
795 if ( GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION )
796 {
797 if ( mouseEvent )
798 {
799 if ( mouseEvent->GetEventType() == wxEVT_RIGHT_DOWN ||
800 mouseEvent->GetEventType() == wxEVT_RIGHT_UP )
801 {
802 // Allow right-click for context menu without
803 // disturbing the selection.
804 if ( GetSelectedProperties().size() <= 1 ||
805 !alreadySelected )
806 return DoSelectAndEdit(prop, colIndex, selFlags);
807 return true;
808 }
809 else
810 {
811 if ( mouseEvent->ControlDown() )
812 {
813 addToExistingSelection = 1;
814 }
815 else if ( mouseEvent->ShiftDown() )
816 {
817 if ( selection.size() > 0 && !prop->IsCategory() )
818 addToExistingSelection = 2;
819 else
820 addToExistingSelection = 1;
821 }
822 }
823 }
824 }
825
826 if ( addToExistingSelection == 1 )
827 {
828 // Add/remove one
829 if ( !alreadySelected )
830 {
831 res = DoAddToSelection(prop, selFlags);
832 }
833 else if ( GetSelectedProperties().size() > 1 )
834 {
835 res = DoRemoveFromSelection(prop, selFlags);
836 }
837 }
838 else if ( addToExistingSelection == 2 )
839 {
840 // Add this, and all in between
841
842 // Find top selected property
843 wxPGProperty* topSelProp = selection[0];
844 int topSelPropY = topSelProp->GetY();
845 for ( unsigned int i=1; i<selection.size(); i++ )
846 {
847 wxPGProperty* p = selection[i];
848 int y = p->GetY();
849 if ( y < topSelPropY )
850 {
851 topSelProp = p;
852 topSelPropY = y;
853 }
854 }
855
856 wxPGProperty* startFrom;
857 wxPGProperty* stopAt;
858
859 if ( prop->GetY() <= topSelPropY )
860 {
861 // Property is above selection (or same)
862 startFrom = prop;
863 stopAt = topSelProp;
864 }
865 else
866 {
867 // Property is below selection
868 startFrom = topSelProp;
869 stopAt = prop;
870 }
871
872 // Iterate through properties in-between, and select them
873 wxPropertyGridIterator it;
874
875 for ( it = GetIterator(wxPG_ITERATE_VISIBLE, startFrom);
876 !it.AtEnd();
877 it++ )
878 {
879 wxPGProperty* p = *it;
880
881 if ( !p->IsCategory() &&
882 !m_pState->DoIsPropertySelected(p) )
883 {
884 DoAddToSelection(p, selFlags);
885 }
886
887 if ( p == stopAt )
888 break;
889 }
890 }
891 else
892 {
893 res = DoSelectAndEdit(prop, colIndex, selFlags);
894 }
895
896 return res;
897 }
898
899 // -----------------------------------------------------------------------
900
901 void wxPropertyGrid::DoSetSelection( const wxArrayPGProperty& newSelection,
902 int selFlags )
903 {
904 if ( newSelection.size() > 0 )
905 {
906 if ( !DoSelectProperty(newSelection[0], selFlags) )
907 return;
908 }
909 else
910 {
911 DoClearSelection(false, selFlags);
912 }
913
914 for ( unsigned int i = 1; i < newSelection.size(); i++ )
915 {
916 DoAddToSelection(newSelection[i], selFlags);
917 }
918
919 Refresh();
920 }
921
922 // -----------------------------------------------------------------------
923
924 void wxPropertyGrid::MakeColumnEditable( unsigned int column,
925 bool editable )
926 {
927 wxASSERT( column != 1 );
928
929 wxArrayInt& cols = m_pState->m_editableColumns;
930
931 if ( editable )
932 {
933 cols.push_back(column);
934 }
935 else
936 {
937 for ( int i = cols.size() - 1; i > 0; i-- )
938 {
939 if ( cols[i] == (int)column )
940 cols.erase( cols.begin() + i );
941 }
942 }
943 }
944
945 // -----------------------------------------------------------------------
946
947 void wxPropertyGrid::DoBeginLabelEdit( unsigned int colIndex,
948 int selFlags )
949 {
950 wxPGProperty* selected = GetSelection();
951 wxCHECK_RET(selected, wxT("No property selected"));
952 wxCHECK_RET(colIndex != 1, wxT("Do not use this for column 1"));
953
954 if ( !(selFlags & wxPG_SEL_DONT_SEND_EVENT) )
955 {
956 if ( SendEvent( wxEVT_PG_LABEL_EDIT_BEGIN,
957 selected, NULL, 0,
958 colIndex ) )
959 return;
960 }
961
962 wxString text;
963 const wxPGCell* cell = NULL;
964 if ( selected->HasCell(colIndex) )
965 {
966 cell = &selected->GetCell(colIndex);
967 if ( !cell->HasText() && colIndex == 0 )
968 text = selected->GetLabel();
969 }
970
971 if ( !cell )
972 {
973 if ( colIndex == 0 )
974 text = selected->GetLabel();
975 else
976 cell = &selected->GetOrCreateCell(colIndex);
977 }
978
979 if ( cell && cell->HasText() )
980 text = cell->GetText();
981
982 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE); // send event
983
984 m_selColumn = colIndex;
985
986 wxRect r = GetEditorWidgetRect(selected, m_selColumn);
987
988 wxWindow* tc = GenerateEditorTextCtrl(r.GetPosition(),
989 r.GetSize(),
990 text,
991 NULL,
992 wxTE_PROCESS_ENTER,
993 0,
994 colIndex);
995
996 wxWindowID id = tc->GetId();
997 tc->Connect(id, wxEVT_COMMAND_TEXT_ENTER,
998 wxCommandEventHandler(wxPropertyGrid::OnLabelEditorEnterPress),
999 NULL, this);
1000 tc->Connect(id, wxEVT_KEY_DOWN,
1001 wxKeyEventHandler(wxPropertyGrid::OnLabelEditorKeyPress),
1002 NULL, this);
1003
1004 tc->SetFocus();
1005
1006 m_labelEditor = wxStaticCast(tc, wxTextCtrl);
1007 m_labelEditorProperty = selected;
1008 }
1009
1010 // -----------------------------------------------------------------------
1011
1012 void
1013 wxPropertyGrid::OnLabelEditorEnterPress( wxCommandEvent& WXUNUSED(event) )
1014 {
1015 DoEndLabelEdit(true);
1016 }
1017
1018 // -----------------------------------------------------------------------
1019
1020 void wxPropertyGrid::OnLabelEditorKeyPress( wxKeyEvent& event )
1021 {
1022 int keycode = event.GetKeyCode();
1023
1024 if ( keycode == WXK_ESCAPE )
1025 {
1026 DoEndLabelEdit(false);
1027 }
1028 else
1029 {
1030 event.Skip();
1031 }
1032 }
1033
1034 // -----------------------------------------------------------------------
1035
1036 void wxPropertyGrid::DoEndLabelEdit( bool commit, int selFlags )
1037 {
1038 if ( !m_labelEditor )
1039 return;
1040
1041 wxPGProperty* prop = m_labelEditorProperty;
1042 wxASSERT(prop);
1043
1044 if ( commit )
1045 {
1046 if ( !(selFlags & wxPG_SEL_DONT_SEND_EVENT) )
1047 {
1048 // wxPG_SEL_NOVALIDATE is passed correctly in selFlags
1049 if ( SendEvent( wxEVT_PG_LABEL_EDIT_ENDING,
1050 prop, NULL, selFlags,
1051 m_selColumn ) )
1052 return;
1053 }
1054
1055 wxString text = m_labelEditor->GetValue();
1056 wxPGCell* cell = NULL;
1057 if ( prop->HasCell(m_selColumn) )
1058 {
1059 cell = &prop->GetCell(m_selColumn);
1060 }
1061 else
1062 {
1063 if ( m_selColumn == 0 )
1064 prop->SetLabel(text);
1065 else
1066 cell = &prop->GetOrCreateCell(m_selColumn);
1067 }
1068
1069 if ( cell )
1070 cell->SetText(text);
1071 }
1072
1073 m_selColumn = 1;
1074 int wasFocused = m_iFlags & wxPG_FL_FOCUSED;
1075
1076 DestroyEditorWnd(m_labelEditor);
1077
1078 m_labelEditor = NULL;
1079 m_labelEditorProperty = NULL;
1080
1081 // Fix focus (needed at least on wxGTK)
1082 if ( wasFocused )
1083 SetFocusOnCanvas();
1084
1085 DrawItem(prop);
1086 }
1087
1088 // -----------------------------------------------------------------------
1089
1090 void wxPropertyGrid::SetExtraStyle( long exStyle )
1091 {
1092 if ( exStyle & wxPG_EX_ENABLE_TLP_TRACKING )
1093 OnTLPChanging(::wxGetTopLevelParent(this));
1094 else
1095 OnTLPChanging(NULL);
1096
1097 if ( exStyle & wxPG_EX_NATIVE_DOUBLE_BUFFERING )
1098 {
1099 #if defined(__WXMSW__)
1100
1101 /*
1102 // Don't use WS_EX_COMPOSITED just now.
1103 HWND hWnd;
1104
1105 if ( m_iFlags & wxPG_FL_IN_MANAGER )
1106 hWnd = (HWND)GetParent()->GetHWND();
1107 else
1108 hWnd = (HWND)GetHWND();
1109
1110 ::SetWindowLong( hWnd, GWL_EXSTYLE,
1111 ::GetWindowLong(hWnd, GWL_EXSTYLE) | WS_EX_COMPOSITED );
1112 */
1113
1114 //#elif defined(__WXGTK20__)
1115 #endif
1116 // Only apply wxPG_EX_NATIVE_DOUBLE_BUFFERING if the window
1117 // truly was double-buffered.
1118 if ( !this->IsDoubleBuffered() )
1119 {
1120 exStyle &= ~(wxPG_EX_NATIVE_DOUBLE_BUFFERING);
1121 }
1122 else
1123 {
1124 #if wxPG_DOUBLE_BUFFER
1125 delete m_doubleBuffer;
1126 m_doubleBuffer = NULL;
1127 #endif
1128 }
1129 }
1130
1131 wxScrolledWindow::SetExtraStyle( exStyle );
1132
1133 if ( exStyle & wxPG_EX_INIT_NOCAT )
1134 m_pState->InitNonCatMode();
1135
1136 if ( exStyle & wxPG_EX_HELP_AS_TOOLTIPS )
1137 m_windowStyle |= wxPG_TOOLTIPS;
1138
1139 // Set global style
1140 wxPGGlobalVars->m_extraStyle = exStyle;
1141 }
1142
1143 // -----------------------------------------------------------------------
1144
1145 // returns the best acceptable minimal size
1146 wxSize wxPropertyGrid::DoGetBestSize() const
1147 {
1148 int lineHeight = wxMax(15, m_lineHeight);
1149
1150 // don't make the grid too tall (limit height to 10 items) but don't
1151 // make it too small neither
1152 int numLines = wxMin
1153 (
1154 wxMax(m_pState->m_properties->GetChildCount(), 3),
1155 10
1156 );
1157
1158 wxClientDC dc(const_cast<wxPropertyGrid *>(this));
1159 int width = m_marginWidth;
1160 for ( unsigned int i = 0; i < m_pState->m_colWidths.size(); i++ )
1161 {
1162 width += m_pState->GetColumnFitWidth(dc, m_pState->DoGetRoot(), i, true);
1163 }
1164
1165 const wxSize sz = wxSize(width, lineHeight*numLines + 40);
1166
1167 CacheBestSize(sz);
1168 return sz;
1169 }
1170
1171 // -----------------------------------------------------------------------
1172
1173 void wxPropertyGrid::OnTLPChanging( wxWindow* newTLP )
1174 {
1175 if ( newTLP == m_tlp )
1176 return;
1177
1178 wxLongLong currentTime = ::wxGetLocalTimeMillis();
1179
1180 //
1181 // Parent changed so let's redetermine and re-hook the
1182 // correct top-level window.
1183 if ( m_tlp )
1184 {
1185 m_tlp->Disconnect( wxEVT_CLOSE_WINDOW,
1186 wxCloseEventHandler(wxPropertyGrid::OnTLPClose),
1187 NULL, this );
1188 m_tlpClosed = m_tlp;
1189 m_tlpClosedTime = currentTime;
1190 }
1191
1192 if ( newTLP )
1193 {
1194 // Only accept new tlp if same one was not just dismissed.
1195 if ( newTLP != m_tlpClosed ||
1196 m_tlpClosedTime+250 < currentTime )
1197 {
1198 newTLP->Connect( wxEVT_CLOSE_WINDOW,
1199 wxCloseEventHandler(wxPropertyGrid::OnTLPClose),
1200 NULL, this );
1201 m_tlpClosed = NULL;
1202 }
1203 else
1204 {
1205 newTLP = NULL;
1206 }
1207 }
1208
1209 m_tlp = newTLP;
1210 }
1211
1212 // -----------------------------------------------------------------------
1213
1214 void wxPropertyGrid::OnTLPClose( wxCloseEvent& event )
1215 {
1216 // ClearSelection forces value validation/commit.
1217 if ( event.CanVeto() && !DoClearSelection() )
1218 {
1219 event.Veto();
1220 return;
1221 }
1222
1223 // Ok, it can close, set tlp pointer to NULL. Some other event
1224 // handler can of course veto the close, but our OnIdle() should
1225 // then be able to regain the tlp pointer.
1226 OnTLPChanging(NULL);
1227
1228 event.Skip();
1229 }
1230
1231 // -----------------------------------------------------------------------
1232
1233 bool wxPropertyGrid::Reparent( wxWindowBase *newParent )
1234 {
1235 OnTLPChanging((wxWindow*)newParent);
1236
1237 bool res = wxScrolledWindow::Reparent(newParent);
1238
1239 return res;
1240 }
1241
1242 // -----------------------------------------------------------------------
1243 // wxPropertyGrid Font and Colour Methods
1244 // -----------------------------------------------------------------------
1245
1246 void wxPropertyGrid::CalculateFontAndBitmapStuff( int vspacing )
1247 {
1248 int x = 0, y = 0;
1249
1250 m_captionFont = wxScrolledWindow::GetFont();
1251
1252 GetTextExtent(wxS("jG"), &x, &y, 0, 0, &m_captionFont);
1253 m_subgroup_extramargin = x + (x/2);
1254 m_fontHeight = y;
1255
1256 #if wxPG_USE_RENDERER_NATIVE
1257 m_iconWidth = wxPG_ICON_WIDTH;
1258 #elif wxPG_ICON_WIDTH
1259 // scale icon
1260 m_iconWidth = (m_fontHeight * wxPG_ICON_WIDTH) / 13;
1261 if ( m_iconWidth < 5 ) m_iconWidth = 5;
1262 else if ( !(m_iconWidth & 0x01) ) m_iconWidth++; // must be odd
1263
1264 #endif
1265
1266 m_gutterWidth = m_iconWidth / wxPG_GUTTER_DIV;
1267 if ( m_gutterWidth < wxPG_GUTTER_MIN )
1268 m_gutterWidth = wxPG_GUTTER_MIN;
1269
1270 int vdiv = 6;
1271 if ( vspacing <= 1 ) vdiv = 12;
1272 else if ( vspacing >= 3 ) vdiv = 3;
1273
1274 m_spacingy = m_fontHeight / vdiv;
1275 if ( m_spacingy < wxPG_YSPACING_MIN )
1276 m_spacingy = wxPG_YSPACING_MIN;
1277
1278 m_marginWidth = 0;
1279 if ( !(m_windowStyle & wxPG_HIDE_MARGIN) )
1280 m_marginWidth = m_gutterWidth*2 + m_iconWidth;
1281
1282 m_captionFont.SetWeight(wxBOLD);
1283 GetTextExtent(wxS("jG"), &x, &y, 0, 0, &m_captionFont);
1284
1285 m_lineHeight = m_fontHeight+(2*m_spacingy)+1;
1286
1287 // button spacing
1288 m_buttonSpacingY = (m_lineHeight - m_iconHeight) / 2;
1289 if ( m_buttonSpacingY < 0 ) m_buttonSpacingY = 0;
1290
1291 if ( m_pState )
1292 m_pState->CalculateFontAndBitmapStuff(vspacing);
1293
1294 if ( m_iFlags & wxPG_FL_INITIALIZED )
1295 RecalculateVirtualSize();
1296
1297 InvalidateBestSize();
1298 }
1299
1300 // -----------------------------------------------------------------------
1301
1302 void wxPropertyGrid::OnSysColourChanged( wxSysColourChangedEvent &WXUNUSED(event) )
1303 {
1304 RegainColours();
1305 Refresh();
1306 }
1307
1308 // -----------------------------------------------------------------------
1309
1310 static wxColour wxPGAdjustColour(const wxColour& src, int ra,
1311 int ga = 1000, int ba = 1000,
1312 bool forceDifferent = false)
1313 {
1314 if ( ga >= 1000 )
1315 ga = ra;
1316 if ( ba >= 1000 )
1317 ba = ra;
1318
1319 // Recursion guard (allow 2 max)
1320 static int isinside = 0;
1321 isinside++;
1322 wxCHECK_MSG( isinside < 3,
1323 *wxBLACK,
1324 wxT("wxPGAdjustColour should not be recursively called more than once") );
1325
1326 wxColour dst;
1327
1328 int r = src.Red();
1329 int g = src.Green();
1330 int b = src.Blue();
1331 int r2 = r + ra;
1332 if ( r2>255 ) r2 = 255;
1333 else if ( r2<0) r2 = 0;
1334 int g2 = g + ga;
1335 if ( g2>255 ) g2 = 255;
1336 else if ( g2<0) g2 = 0;
1337 int b2 = b + ba;
1338 if ( b2>255 ) b2 = 255;
1339 else if ( b2<0) b2 = 0;
1340
1341 // Make sure they are somewhat different
1342 if ( forceDifferent && (abs((r+g+b)-(r2+g2+b2)) < abs(ra/2)) )
1343 dst = wxPGAdjustColour(src,-(ra*2));
1344 else
1345 dst = wxColour(r2,g2,b2);
1346
1347 // Recursion guard (allow 2 max)
1348 isinside--;
1349
1350 return dst;
1351 }
1352
1353
1354 static int wxPGGetColAvg( const wxColour& col )
1355 {
1356 return (col.Red() + col.Green() + col.Blue()) / 3;
1357 }
1358
1359
1360 void wxPropertyGrid::RegainColours()
1361 {
1362 if ( !(m_coloursCustomized & 0x0002) )
1363 {
1364 wxColour col = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE );
1365
1366 // Make sure colour is dark enough
1367 #ifdef __WXGTK__
1368 int colDec = wxPGGetColAvg(col) - 230;
1369 #else
1370 int colDec = wxPGGetColAvg(col) - 200;
1371 #endif
1372 if ( colDec > 0 )
1373 m_colCapBack = wxPGAdjustColour(col,-colDec);
1374 else
1375 m_colCapBack = col;
1376 m_categoryDefaultCell.GetData()->SetBgCol(m_colCapBack);
1377 }
1378
1379 if ( !(m_coloursCustomized & 0x0001) )
1380 m_colMargin = m_colCapBack;
1381
1382 if ( !(m_coloursCustomized & 0x0004) )
1383 {
1384 #ifdef __WXGTK__
1385 int colDec = -90;
1386 #else
1387 int colDec = -72;
1388 #endif
1389 wxColour capForeCol = wxPGAdjustColour(m_colCapBack,colDec,5000,5000,true);
1390 m_colCapFore = capForeCol;
1391 m_categoryDefaultCell.GetData()->SetFgCol(capForeCol);
1392 }
1393
1394 if ( !(m_coloursCustomized & 0x0008) )
1395 {
1396 wxColour bgCol = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
1397 m_colPropBack = bgCol;
1398 m_propertyDefaultCell.GetData()->SetBgCol(bgCol);
1399 if ( !m_unspecifiedAppearance.GetBgCol().IsOk() )
1400 m_unspecifiedAppearance.SetBgCol(bgCol);
1401 }
1402
1403 if ( !(m_coloursCustomized & 0x0010) )
1404 {
1405 wxColour fgCol = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT );
1406 m_colPropFore = fgCol;
1407 m_propertyDefaultCell.GetData()->SetFgCol(fgCol);
1408 if ( !m_unspecifiedAppearance.GetFgCol().IsOk() )
1409 m_unspecifiedAppearance.SetFgCol(fgCol);
1410 }
1411
1412 if ( !(m_coloursCustomized & 0x0020) )
1413 m_colSelBack = wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT );
1414
1415 if ( !(m_coloursCustomized & 0x0040) )
1416 m_colSelFore = wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHTTEXT );
1417
1418 if ( !(m_coloursCustomized & 0x0080) )
1419 m_colLine = m_colCapBack;
1420
1421 if ( !(m_coloursCustomized & 0x0100) )
1422 m_colDisPropFore = m_colCapFore;
1423
1424 m_colEmptySpace = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
1425 }
1426
1427 // -----------------------------------------------------------------------
1428
1429 void wxPropertyGrid::ResetColours()
1430 {
1431 m_coloursCustomized = 0;
1432
1433 RegainColours();
1434
1435 Refresh();
1436 }
1437
1438 // -----------------------------------------------------------------------
1439
1440 bool wxPropertyGrid::SetFont( const wxFont& font )
1441 {
1442 // Must disable active editor.
1443 DoClearSelection();
1444
1445 bool res = wxScrolledWindow::SetFont( font );
1446 if ( res && GetParent()) // may not have been Create()ed yet if SetFont called from SetWindowVariant
1447 {
1448 CalculateFontAndBitmapStuff( m_vspacing );
1449 Refresh();
1450 }
1451
1452 return res;
1453 }
1454
1455 // -----------------------------------------------------------------------
1456
1457 void wxPropertyGrid::SetLineColour( const wxColour& col )
1458 {
1459 m_colLine = col;
1460 m_coloursCustomized |= 0x80;
1461 Refresh();
1462 }
1463
1464 // -----------------------------------------------------------------------
1465
1466 void wxPropertyGrid::SetMarginColour( const wxColour& col )
1467 {
1468 m_colMargin = col;
1469 m_coloursCustomized |= 0x01;
1470 Refresh();
1471 }
1472
1473 // -----------------------------------------------------------------------
1474
1475 void wxPropertyGrid::SetCellBackgroundColour( const wxColour& col )
1476 {
1477 m_colPropBack = col;
1478 m_coloursCustomized |= 0x08;
1479
1480 m_propertyDefaultCell.GetData()->SetBgCol(col);
1481 m_unspecifiedAppearance.SetBgCol(col);
1482
1483 Refresh();
1484 }
1485
1486 // -----------------------------------------------------------------------
1487
1488 void wxPropertyGrid::SetCellTextColour( const wxColour& col )
1489 {
1490 m_colPropFore = col;
1491 m_coloursCustomized |= 0x10;
1492
1493 m_propertyDefaultCell.GetData()->SetFgCol(col);
1494 m_unspecifiedAppearance.SetFgCol(col);
1495
1496 Refresh();
1497 }
1498
1499 // -----------------------------------------------------------------------
1500
1501 void wxPropertyGrid::SetEmptySpaceColour( const wxColour& col )
1502 {
1503 m_colEmptySpace = col;
1504
1505 Refresh();
1506 }
1507
1508 // -----------------------------------------------------------------------
1509
1510 void wxPropertyGrid::SetCellDisabledTextColour( const wxColour& col )
1511 {
1512 m_colDisPropFore = col;
1513 m_coloursCustomized |= 0x100;
1514 Refresh();
1515 }
1516
1517 // -----------------------------------------------------------------------
1518
1519 void wxPropertyGrid::SetSelectionBackgroundColour( const wxColour& col )
1520 {
1521 m_colSelBack = col;
1522 m_coloursCustomized |= 0x20;
1523 Refresh();
1524 }
1525
1526 // -----------------------------------------------------------------------
1527
1528 void wxPropertyGrid::SetSelectionTextColour( const wxColour& col )
1529 {
1530 m_colSelFore = col;
1531 m_coloursCustomized |= 0x40;
1532 Refresh();
1533 }
1534
1535 // -----------------------------------------------------------------------
1536
1537 void wxPropertyGrid::SetCaptionBackgroundColour( const wxColour& col )
1538 {
1539 m_colCapBack = col;
1540 m_coloursCustomized |= 0x02;
1541
1542 m_categoryDefaultCell.GetData()->SetBgCol(col);
1543
1544 Refresh();
1545 }
1546
1547 // -----------------------------------------------------------------------
1548
1549 void wxPropertyGrid::SetCaptionTextColour( const wxColour& col )
1550 {
1551 m_colCapFore = col;
1552 m_coloursCustomized |= 0x04;
1553
1554 m_categoryDefaultCell.GetData()->SetFgCol(col);
1555
1556 Refresh();
1557 }
1558
1559 // -----------------------------------------------------------------------
1560 // wxPropertyGrid property adding and removal
1561 // -----------------------------------------------------------------------
1562
1563 void wxPropertyGrid::PrepareAfterItemsAdded()
1564 {
1565 if ( !m_pState || !m_pState->m_itemsAdded ) return;
1566
1567 m_pState->m_itemsAdded = 0;
1568
1569 if ( m_windowStyle & wxPG_AUTO_SORT )
1570 Sort(wxPG_SORT_TOP_LEVEL_ONLY);
1571
1572 RecalculateVirtualSize();
1573
1574 // Fix editor position
1575 CorrectEditorWidgetPosY();
1576 }
1577
1578 // -----------------------------------------------------------------------
1579 // wxPropertyGrid property operations
1580 // -----------------------------------------------------------------------
1581
1582 bool wxPropertyGrid::EnsureVisible( wxPGPropArg id )
1583 {
1584 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
1585
1586 Update();
1587
1588 bool changed = false;
1589
1590 // Is it inside collapsed section?
1591 if ( !p->IsVisible() )
1592 {
1593 // expand parents
1594 wxPGProperty* parent = p->GetParent();
1595 wxPGProperty* grandparent = parent->GetParent();
1596
1597 if ( grandparent && grandparent != m_pState->m_properties )
1598 Expand( grandparent );
1599
1600 Expand( parent );
1601 changed = true;
1602 }
1603
1604 // Need to scroll?
1605 int vx, vy;
1606 GetViewStart(&vx,&vy);
1607 vy*=wxPG_PIXELS_PER_UNIT;
1608
1609 int y = p->GetY();
1610
1611 if ( y < vy )
1612 {
1613 Scroll(vx, y/wxPG_PIXELS_PER_UNIT );
1614 m_iFlags |= wxPG_FL_SCROLLED;
1615 changed = true;
1616 }
1617 else if ( (y+m_lineHeight) > (vy+m_height) )
1618 {
1619 Scroll(vx, (y-m_height+(m_lineHeight*2))/wxPG_PIXELS_PER_UNIT );
1620 m_iFlags |= wxPG_FL_SCROLLED;
1621 changed = true;
1622 }
1623
1624 if ( changed )
1625 DrawItems( p, p );
1626
1627 return changed;
1628 }
1629
1630 // -----------------------------------------------------------------------
1631 // wxPropertyGrid helper methods called by properties
1632 // -----------------------------------------------------------------------
1633
1634 // Control font changer helper.
1635 void wxPropertyGrid::SetCurControlBoldFont()
1636 {
1637 wxASSERT( m_wndEditor );
1638 m_wndEditor->SetFont( m_captionFont );
1639 }
1640
1641 // -----------------------------------------------------------------------
1642
1643 wxPoint wxPropertyGrid::GetGoodEditorDialogPosition( wxPGProperty* p,
1644 const wxSize& sz )
1645 {
1646 #if wxPG_SMALL_SCREEN
1647 // On small-screen devices, always show dialogs with default position and size.
1648 return wxDefaultPosition;
1649 #else
1650 int splitterX = GetSplitterPosition();
1651 int x = splitterX;
1652 int y = p->GetY();
1653
1654 wxCHECK_MSG( y >= 0, wxPoint(-1,-1), wxT("invalid y?") );
1655
1656 ImprovedClientToScreen( &x, &y );
1657
1658 int sw = wxSystemSettings::GetMetric( ::wxSYS_SCREEN_X );
1659 int sh = wxSystemSettings::GetMetric( ::wxSYS_SCREEN_Y );
1660
1661 int new_x;
1662 int new_y;
1663
1664 if ( x > (sw/2) )
1665 // left
1666 new_x = x + (m_width-splitterX) - sz.x;
1667 else
1668 // right
1669 new_x = x;
1670
1671 if ( y > (sh/2) )
1672 // above
1673 new_y = y - sz.y;
1674 else
1675 // below
1676 new_y = y + m_lineHeight;
1677
1678 return wxPoint(new_x,new_y);
1679 #endif
1680 }
1681
1682 // -----------------------------------------------------------------------
1683
1684 wxString& wxPropertyGrid::ExpandEscapeSequences( wxString& dst_str, wxString& src_str )
1685 {
1686 if ( src_str.length() == 0 )
1687 {
1688 dst_str = src_str;
1689 return src_str;
1690 }
1691
1692 bool prev_is_slash = false;
1693
1694 wxString::const_iterator i = src_str.begin();
1695
1696 dst_str.clear();
1697
1698 for ( ; i != src_str.end(); ++i )
1699 {
1700 wxUniChar a = *i;
1701
1702 if ( a != wxS('\\') )
1703 {
1704 if ( !prev_is_slash )
1705 {
1706 dst_str << a;
1707 }
1708 else
1709 {
1710 if ( a == wxS('n') )
1711 {
1712 #ifdef __WXMSW__
1713 dst_str << wxS('\n');
1714 #else
1715 dst_str << wxS('\n');
1716 #endif
1717 }
1718 else if ( a == wxS('t') )
1719 dst_str << wxS('\t');
1720 else
1721 dst_str << a;
1722 }
1723 prev_is_slash = false;
1724 }
1725 else
1726 {
1727 if ( prev_is_slash )
1728 {
1729 dst_str << wxS('\\');
1730 prev_is_slash = false;
1731 }
1732 else
1733 {
1734 prev_is_slash = true;
1735 }
1736 }
1737 }
1738 return dst_str;
1739 }
1740
1741 // -----------------------------------------------------------------------
1742
1743 wxString& wxPropertyGrid::CreateEscapeSequences( wxString& dst_str, wxString& src_str )
1744 {
1745 if ( src_str.length() == 0 )
1746 {
1747 dst_str = src_str;
1748 return src_str;
1749 }
1750
1751 wxString::const_iterator i = src_str.begin();
1752 wxUniChar prev_a = wxS('\0');
1753
1754 dst_str.clear();
1755
1756 for ( ; i != src_str.end(); ++i )
1757 {
1758 wxChar a = *i;
1759
1760 if ( a >= wxS(' ') )
1761 {
1762 // This surely is not something that requires an escape sequence.
1763 dst_str << a;
1764 }
1765 else
1766 {
1767 // This might need...
1768 if ( a == wxS('\r') )
1769 {
1770 // DOS style line end.
1771 // Already taken care below
1772 }
1773 else if ( a == wxS('\n') )
1774 // UNIX style line end.
1775 dst_str << wxS("\\n");
1776 else if ( a == wxS('\t') )
1777 // Tab.
1778 dst_str << wxS('\t');
1779 else
1780 {
1781 //wxLogDebug(wxT("WARNING: Could not create escape sequence for character #%i"),(int)a);
1782 dst_str << a;
1783 }
1784 }
1785
1786 prev_a = a;
1787 }
1788 return dst_str;
1789 }
1790
1791 // -----------------------------------------------------------------------
1792
1793 wxPGProperty* wxPropertyGrid::DoGetItemAtY( int y ) const
1794 {
1795 // Outside?
1796 if ( y < 0 )
1797 return NULL;
1798
1799 unsigned int a = 0;
1800 return m_pState->m_properties->GetItemAtY(y, m_lineHeight, &a);
1801 }
1802
1803 // -----------------------------------------------------------------------
1804 // wxPropertyGrid graphics related methods
1805 // -----------------------------------------------------------------------
1806
1807 void wxPropertyGrid::OnPaint( wxPaintEvent& WXUNUSED(event) )
1808 {
1809 wxPaintDC dc(this);
1810 PrepareDC(dc);
1811
1812 // Don't paint after destruction has begun
1813 if ( !HasInternalFlag(wxPG_FL_INITIALIZED) )
1814 return;
1815
1816 // Find out where the window is scrolled to
1817 int vx,vy; // Top left corner of client
1818 GetViewStart(&vx,&vy);
1819 vy *= wxPG_PIXELS_PER_UNIT;
1820
1821 // Update everything inside the box
1822 wxRect r = GetUpdateRegion().GetBox();
1823
1824 r.y += vy;
1825
1826 // FIXME: This is just a workaround for a bug that causes splitters not
1827 // to paint when other windows are being dragged over the grid.
1828 r.x = 0;
1829 r.width = GetClientSize().x;
1830
1831 // Repaint this rectangle
1832 DrawItems( dc, r.y, r.y + r.height, &r );
1833
1834 // We assume that the size set when grid is shown
1835 // is what is desired.
1836 SetInternalFlag(wxPG_FL_GOOD_SIZE_SET);
1837 }
1838
1839 // -----------------------------------------------------------------------
1840
1841 void wxPropertyGrid::DrawExpanderButton( wxDC& dc, const wxRect& rect,
1842 wxPGProperty* property ) const
1843 {
1844 // Prepare rectangle to be used
1845 wxRect r(rect);
1846 r.x += m_gutterWidth; r.y += m_buttonSpacingY;
1847 r.width = m_iconWidth; r.height = m_iconHeight;
1848
1849 #if (wxPG_USE_RENDERER_NATIVE)
1850 //
1851 #elif wxPG_ICON_WIDTH
1852 // Drawing expand/collapse button manually
1853 dc.SetPen(m_colPropFore);
1854 if ( property->IsCategory() )
1855 dc.SetBrush(*wxTRANSPARENT_BRUSH);
1856 else
1857 dc.SetBrush(m_colPropBack);
1858
1859 dc.DrawRectangle( r );
1860 int _y = r.y+(m_iconWidth/2);
1861 dc.DrawLine(r.x+2,_y,r.x+m_iconWidth-2,_y);
1862 #else
1863 wxBitmap* bmp;
1864 #endif
1865
1866 if ( property->IsExpanded() )
1867 {
1868 // wxRenderer functions are non-mutating in nature, so it
1869 // should be safe to cast "const wxPropertyGrid*" to "wxWindow*".
1870 // Hopefully this does not cause problems.
1871 #if (wxPG_USE_RENDERER_NATIVE)
1872 wxRendererNative::Get().DrawTreeItemButton(
1873 (wxWindow*)this,
1874 dc,
1875 r,
1876 wxCONTROL_EXPANDED
1877 );
1878 #elif wxPG_ICON_WIDTH
1879 //
1880 #else
1881 bmp = m_collbmp;
1882 #endif
1883
1884 }
1885 else
1886 {
1887 #if (wxPG_USE_RENDERER_NATIVE)
1888 wxRendererNative::Get().DrawTreeItemButton(
1889 (wxWindow*)this,
1890 dc,
1891 r,
1892 0
1893 );
1894 #elif wxPG_ICON_WIDTH
1895 int _x = r.x+(m_iconWidth/2);
1896 dc.DrawLine(_x,r.y+2,_x,r.y+m_iconWidth-2);
1897 #else
1898 bmp = m_expandbmp;
1899 #endif
1900 }
1901
1902 #if (wxPG_USE_RENDERER_NATIVE)
1903 //
1904 #elif wxPG_ICON_WIDTH
1905 //
1906 #else
1907 dc.DrawBitmap( *bmp, r.x, r.y, true );
1908 #endif
1909 }
1910
1911 // -----------------------------------------------------------------------
1912
1913 //
1914 // This is the one called by OnPaint event handler and others.
1915 // topy and bottomy are already unscrolled (ie. physical)
1916 //
1917 void wxPropertyGrid::DrawItems( wxDC& dc,
1918 unsigned int topItemY,
1919 unsigned int bottomItemY,
1920 const wxRect* drawRect )
1921 {
1922 if ( m_frozen ||
1923 m_height < 1 ||
1924 bottomItemY < topItemY ||
1925 !m_pState )
1926 return;
1927
1928 m_pState->EnsureVirtualHeight();
1929
1930 wxRect tempDrawRect;
1931 if ( !drawRect )
1932 {
1933 tempDrawRect = wxRect(0, topItemY,
1934 m_pState->m_width,
1935 bottomItemY);
1936 drawRect = &tempDrawRect;
1937 }
1938
1939 // items added check
1940 if ( m_pState->m_itemsAdded ) PrepareAfterItemsAdded();
1941
1942 int paintFinishY = 0;
1943
1944 if ( m_pState->m_properties->GetChildCount() > 0 )
1945 {
1946 wxDC* dcPtr = &dc;
1947 bool isBuffered = false;
1948
1949 #if wxPG_DOUBLE_BUFFER
1950 wxMemoryDC* bufferDC = NULL;
1951
1952 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING) )
1953 {
1954 if ( !m_doubleBuffer )
1955 {
1956 paintFinishY = drawRect->y;
1957 dcPtr = NULL;
1958 }
1959 else
1960 {
1961 bufferDC = new wxMemoryDC();
1962
1963 // If nothing was changed, then just copy from double-buffer
1964 bufferDC->SelectObject( *m_doubleBuffer );
1965 dcPtr = bufferDC;
1966
1967 isBuffered = true;
1968 }
1969 }
1970 #endif
1971
1972 if ( dcPtr )
1973 {
1974 dc.SetClippingRegion( *drawRect );
1975 paintFinishY = DoDrawItems( *dcPtr, drawRect, isBuffered );
1976 int drawBottomY = drawRect->y + drawRect->height;
1977
1978 // Clear area beyond last painted property
1979 if ( paintFinishY < drawBottomY )
1980 {
1981 dcPtr->SetPen(m_colEmptySpace);
1982 dcPtr->SetBrush(m_colEmptySpace);
1983 dcPtr->DrawRectangle(0, paintFinishY,
1984 m_width,
1985 drawBottomY );
1986 }
1987
1988 dc.DestroyClippingRegion();
1989 }
1990
1991 #if wxPG_DOUBLE_BUFFER
1992 if ( bufferDC )
1993 {
1994 dc.Blit( drawRect->x, drawRect->y, drawRect->width,
1995 drawRect->height,
1996 bufferDC, 0, 0, wxCOPY );
1997 delete bufferDC;
1998 }
1999 #endif
2000 }
2001 else
2002 {
2003 // Just clear the area
2004 dc.SetPen(m_colEmptySpace);
2005 dc.SetBrush(m_colEmptySpace);
2006 dc.DrawRectangle(*drawRect);
2007 }
2008 }
2009
2010 // -----------------------------------------------------------------------
2011
2012 int wxPropertyGrid::DoDrawItems( wxDC& dc,
2013 const wxRect* drawRect,
2014 bool isBuffered ) const
2015 {
2016 const wxPGProperty* firstItem;
2017 const wxPGProperty* lastItem;
2018
2019 firstItem = DoGetItemAtY(drawRect->y);
2020 lastItem = DoGetItemAtY(drawRect->y+drawRect->height-1);
2021
2022 if ( !lastItem )
2023 lastItem = GetLastItem( wxPG_ITERATE_VISIBLE );
2024
2025 if ( m_frozen || m_height < 1 || firstItem == NULL )
2026 return drawRect->y;
2027
2028 wxCHECK_MSG( !m_pState->m_itemsAdded, drawRect->y,
2029 "no items added" );
2030 wxASSERT( m_pState->m_properties->GetChildCount() );
2031
2032 int lh = m_lineHeight;
2033
2034 int firstItemTopY;
2035 int lastItemBottomY;
2036
2037 firstItemTopY = drawRect->y;
2038 lastItemBottomY = drawRect->y + drawRect->height;
2039
2040 // Align y coordinates to item boundaries
2041 firstItemTopY -= firstItemTopY % lh;
2042 lastItemBottomY += lh - (lastItemBottomY % lh);
2043 lastItemBottomY -= 1;
2044
2045 // Entire range outside scrolled, visible area?
2046 if ( firstItemTopY >= (int)m_pState->GetVirtualHeight() ||
2047 lastItemBottomY <= 0 )
2048 return drawRect->y;
2049
2050 wxCHECK_MSG( firstItemTopY < lastItemBottomY,
2051 drawRect->y,
2052 "invalid y values" );
2053
2054 /*
2055 wxLogDebug(" -> DoDrawItems ( \"%s\" -> \"%s\"
2056 "height=%i (ch=%i), drawRect = 0x%lX )",
2057 firstItem->GetLabel().c_str(),
2058 lastItem->GetLabel().c_str(),
2059 (int)(lastItemBottomY - firstItemTopY),
2060 (int)m_height,
2061 (unsigned long)drawRect );
2062 */
2063
2064 wxRect r;
2065
2066 long windowStyle = m_windowStyle;
2067
2068 int xRelMod = 0;
2069
2070 //
2071 // With wxPG_DOUBLE_BUFFER, do double buffering
2072 // - buffer's y = 0, so align drawRect and coordinates to that
2073 //
2074 #if wxPG_DOUBLE_BUFFER
2075 int yRelMod = 0;
2076
2077 wxRect cr2;
2078
2079 if ( isBuffered )
2080 {
2081 xRelMod = drawRect->x;
2082 yRelMod = drawRect->y;
2083
2084 //
2085 // drawRect conversion
2086 cr2 = *drawRect;
2087 cr2.x -= xRelMod;
2088 cr2.y -= yRelMod;
2089 drawRect = &cr2;
2090 firstItemTopY -= yRelMod;
2091 lastItemBottomY -= yRelMod;
2092 }
2093 #else
2094 wxUnusedVar(isBuffered);
2095 #endif
2096
2097 int x = m_marginWidth - xRelMod;
2098
2099 wxFont normalFont = GetFont();
2100
2101 bool reallyFocused = (m_iFlags & wxPG_FL_FOCUSED) != 0;
2102
2103 bool isPgEnabled = IsEnabled();
2104
2105 //
2106 // Prepare some pens and brushes that are often changed to.
2107 //
2108
2109 wxBrush marginBrush(m_colMargin);
2110 wxPen marginPen(m_colMargin);
2111 wxBrush capbgbrush(m_colCapBack,wxSOLID);
2112 wxPen linepen(m_colLine,1,wxSOLID);
2113
2114 wxColour selBackCol;
2115 if ( isPgEnabled )
2116 selBackCol = m_colSelBack;
2117 else
2118 selBackCol = m_colMargin;
2119
2120 // pen that has same colour as text
2121 wxPen outlinepen(m_colPropFore,1,wxSOLID);
2122
2123 //
2124 // Clear margin with background colour
2125 //
2126 dc.SetBrush( marginBrush );
2127 if ( !(windowStyle & wxPG_HIDE_MARGIN) )
2128 {
2129 dc.SetPen( *wxTRANSPARENT_PEN );
2130 dc.DrawRectangle(-1-xRelMod,firstItemTopY-1,x+2,lastItemBottomY-firstItemTopY+2);
2131 }
2132
2133 const wxPGProperty* firstSelected = GetSelection();
2134 const wxPropertyGridPageState* state = m_pState;
2135 const wxArrayInt& colWidths = state->m_colWidths;
2136
2137 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2138 bool wasSelectedPainted = false;
2139 #endif
2140
2141 // TODO: Only render columns that are within clipping region.
2142
2143 dc.SetFont(normalFont);
2144
2145 wxPropertyGridConstIterator it( state, wxPG_ITERATE_VISIBLE, firstItem );
2146 int endScanBottomY = lastItemBottomY + lh;
2147 int y = firstItemTopY;
2148
2149 //
2150 // Pregenerate list of visible properties.
2151 wxArrayPGProperty visPropArray;
2152 visPropArray.reserve((m_height/m_lineHeight)+6);
2153
2154 for ( ; !it.AtEnd(); it.Next() )
2155 {
2156 const wxPGProperty* p = *it;
2157
2158 if ( !p->HasFlag(wxPG_PROP_HIDDEN) )
2159 {
2160 visPropArray.push_back((wxPGProperty*)p);
2161
2162 if ( y > endScanBottomY )
2163 break;
2164
2165 y += lh;
2166 }
2167 }
2168
2169 visPropArray.push_back(NULL);
2170
2171 wxPGProperty* nextP = visPropArray[0];
2172
2173 int gridWidth = state->m_width;
2174
2175 y = firstItemTopY;
2176 for ( unsigned int arrInd=1;
2177 nextP && y <= lastItemBottomY;
2178 arrInd++ )
2179 {
2180 wxPGProperty* p = nextP;
2181 nextP = visPropArray[arrInd];
2182
2183 int rowHeight = m_fontHeight+(m_spacingy*2)+1;
2184 int textMarginHere = x;
2185 int renderFlags = 0;
2186
2187 int greyDepth = m_marginWidth;
2188 if ( !(windowStyle & wxPG_HIDE_CATEGORIES) )
2189 greyDepth = (((int)p->m_depthBgCol)-1) * m_subgroup_extramargin + m_marginWidth;
2190
2191 int greyDepthX = greyDepth - xRelMod;
2192
2193 // Use basic depth if in non-categoric mode and parent is base array.
2194 if ( !(windowStyle & wxPG_HIDE_CATEGORIES) || p->GetParent() != m_pState->m_properties )
2195 {
2196 textMarginHere += ((unsigned int)((p->m_depth-1)*m_subgroup_extramargin));
2197 }
2198
2199 // Paint margin area
2200 dc.SetBrush(marginBrush);
2201 dc.SetPen(marginPen);
2202 dc.DrawRectangle( -xRelMod, y, greyDepth, lh );
2203
2204 dc.SetPen( linepen );
2205
2206 int y2 = y + lh;
2207
2208 #ifdef __WXMSW__
2209 // Margin Edge
2210 // Modified by JACS to not draw a margin if wxPG_HIDE_MARGIN is specified, since it
2211 // looks better, at least under Windows when we have a themed border (the themed-window-specific
2212 // whitespace between the real border and the propgrid margin exacerbates the double-border look).
2213
2214 // Is this or its parent themed?
2215 bool suppressMarginEdge = (GetWindowStyle() & wxPG_HIDE_MARGIN) &&
2216 (((GetWindowStyle() & wxBORDER_MASK) == wxBORDER_THEME) ||
2217 (((GetWindowStyle() & wxBORDER_MASK) == wxBORDER_NONE) && ((GetParent()->GetWindowStyle() & wxBORDER_MASK) == wxBORDER_THEME)));
2218 #else
2219 bool suppressMarginEdge = false;
2220 #endif
2221 if (!suppressMarginEdge)
2222 dc.DrawLine( greyDepthX, y, greyDepthX, y2 );
2223 else
2224 {
2225 // Blank out the margin edge
2226 dc.SetPen(wxPen(GetBackgroundColour()));
2227 dc.DrawLine( greyDepthX, y, greyDepthX, y2 );
2228 dc.SetPen( linepen );
2229 }
2230
2231 // Splitters
2232 unsigned int si;
2233 int sx = x;
2234
2235 for ( si=0; si<colWidths.size(); si++ )
2236 {
2237 sx += colWidths[si];
2238 dc.DrawLine( sx, y, sx, y2 );
2239 }
2240
2241 // Horizontal Line, below
2242 // (not if both this and next is category caption)
2243 if ( p->IsCategory() &&
2244 nextP && nextP->IsCategory() )
2245 dc.SetPen(m_colCapBack);
2246
2247 dc.DrawLine( greyDepthX, y2-1, gridWidth-xRelMod, y2-1 );
2248
2249 //
2250 // Need to override row colours?
2251 wxColour rowFgCol;
2252 wxColour rowBgCol;
2253
2254 bool isSelected = state->DoIsPropertySelected(p);
2255
2256 if ( !isSelected )
2257 {
2258 // Disabled may get different colour.
2259 if ( !p->IsEnabled() )
2260 {
2261 renderFlags |= wxPGCellRenderer::Disabled |
2262 wxPGCellRenderer::DontUseCellFgCol;
2263 rowFgCol = m_colDisPropFore;
2264 }
2265 }
2266 else
2267 {
2268 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2269 if ( p == firstSelected )
2270 wasSelectedPainted = true;
2271 #endif
2272
2273 renderFlags |= wxPGCellRenderer::Selected;
2274
2275 if ( !p->IsCategory() )
2276 {
2277 renderFlags |= wxPGCellRenderer::DontUseCellFgCol |
2278 wxPGCellRenderer::DontUseCellBgCol;
2279
2280 if ( reallyFocused && p == firstSelected )
2281 {
2282 rowFgCol = m_colSelFore;
2283 rowBgCol = selBackCol;
2284 }
2285 else if ( isPgEnabled )
2286 {
2287 rowFgCol = m_colPropFore;
2288 if ( p == firstSelected )
2289 rowBgCol = m_colMargin;
2290 else
2291 rowBgCol = selBackCol;
2292 }
2293 else
2294 {
2295 rowFgCol = m_colDisPropFore;
2296 rowBgCol = selBackCol;
2297 }
2298 }
2299 }
2300
2301 wxBrush rowBgBrush;
2302
2303 if ( rowBgCol.IsOk() )
2304 rowBgBrush = wxBrush(rowBgCol);
2305
2306 if ( HasInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL) )
2307 renderFlags = renderFlags & ~wxPGCellRenderer::DontUseCellColours;
2308
2309 //
2310 // Fill additional margin area with background colour of first cell
2311 if ( greyDepthX < textMarginHere )
2312 {
2313 if ( !(renderFlags & wxPGCellRenderer::DontUseCellBgCol) )
2314 {
2315 wxPGCell& cell = p->GetCell(0);
2316 rowBgCol = cell.GetBgCol();
2317 rowBgBrush = wxBrush(rowBgCol);
2318 }
2319 dc.SetBrush(rowBgBrush);
2320 dc.SetPen(rowBgCol);
2321 dc.DrawRectangle(greyDepthX+1, y,
2322 textMarginHere-greyDepthX, lh-1);
2323 }
2324
2325 bool fontChanged = false;
2326
2327 // Expander button rectangle
2328 wxRect butRect( ((p->m_depth - 1) * m_subgroup_extramargin) - xRelMod,
2329 y,
2330 m_marginWidth,
2331 lh );
2332
2333 // Default cell rect fill the entire row
2334 wxRect cellRect(greyDepthX, y,
2335 gridWidth - greyDepth + 2, rowHeight-1 );
2336
2337 bool isCategory = p->IsCategory();
2338
2339 if ( isCategory )
2340 {
2341 dc.SetFont(m_captionFont);
2342 fontChanged = true;
2343
2344 if ( renderFlags & wxPGCellRenderer::DontUseCellBgCol )
2345 {
2346 dc.SetBrush(rowBgBrush);
2347 dc.SetPen(rowBgCol);
2348 }
2349
2350 if ( renderFlags & wxPGCellRenderer::DontUseCellFgCol )
2351 {
2352 dc.SetTextForeground(rowFgCol);
2353 }
2354 }
2355 else
2356 {
2357 // Fine tune button rectangle to actually fit the cell
2358 if ( butRect.x > 0 )
2359 butRect.x += IN_CELL_EXPANDER_BUTTON_X_ADJUST;
2360
2361 if ( p->m_flags & wxPG_PROP_MODIFIED &&
2362 (windowStyle & wxPG_BOLD_MODIFIED) )
2363 {
2364 dc.SetFont(m_captionFont);
2365 fontChanged = true;
2366 }
2367
2368 // Magic fine-tuning for non-category rows
2369 cellRect.x += 1;
2370 }
2371
2372 int firstCellWidth = colWidths[0] - (greyDepthX - m_marginWidth);
2373 int firstCellX = cellRect.x;
2374
2375 // Calculate cellRect.x for the last cell
2376 unsigned int ci = 0;
2377 int cellX = x + 1;
2378 for ( ci=0; ci<colWidths.size(); ci++ )
2379 cellX += colWidths[ci];
2380 cellRect.x = cellX;
2381
2382 // Draw cells from back to front so that we can easily tell if the
2383 // cell on the right was empty from text
2384 bool prevFilled = true;
2385 ci = colWidths.size();
2386 do
2387 {
2388 ci--;
2389
2390 int textXAdd = 0;
2391
2392 if ( ci == 0 )
2393 {
2394 textXAdd = textMarginHere - greyDepthX;
2395 cellRect.width = firstCellWidth;
2396 cellRect.x = firstCellX;
2397 }
2398 else
2399 {
2400 int colWidth = colWidths[ci];
2401 cellRect.width = colWidth;
2402 cellRect.x -= colWidth;
2403 }
2404
2405 // Merge with column to the right?
2406 if ( !prevFilled && isCategory )
2407 {
2408 cellRect.width += colWidths[ci+1];
2409 }
2410
2411 if ( !isCategory )
2412 cellRect.width -= 1;
2413
2414 wxWindow* cellEditor = NULL;
2415 int cellRenderFlags = renderFlags;
2416
2417 // Tree Item Button (must be drawn before clipping is set up)
2418 if ( ci == 0 && !HasFlag(wxPG_HIDE_MARGIN) && p->HasVisibleChildren() )
2419 DrawExpanderButton( dc, butRect, p );
2420
2421 // Background
2422 if ( isSelected && (ci == 1 || ci == m_selColumn) )
2423 {
2424 if ( p == firstSelected )
2425 {
2426 if ( ci == 1 && m_wndEditor )
2427 cellEditor = m_wndEditor;
2428 else if ( ci == m_selColumn && m_labelEditor )
2429 cellEditor = m_labelEditor;
2430 }
2431
2432 if ( cellEditor )
2433 {
2434 wxColour editorBgCol =
2435 cellEditor->GetBackgroundColour();
2436 dc.SetBrush(editorBgCol);
2437 dc.SetPen(editorBgCol);
2438 dc.SetTextForeground(m_colPropFore);
2439 dc.DrawRectangle(cellRect);
2440
2441 if ( m_dragStatus != 0 ||
2442 (m_iFlags & wxPG_FL_CUR_USES_CUSTOM_IMAGE) )
2443 cellEditor = NULL;
2444 }
2445 else
2446 {
2447 dc.SetBrush(m_colPropBack);
2448 dc.SetPen(m_colPropBack);
2449 if ( p->IsEnabled() )
2450 dc.SetTextForeground(m_colPropFore);
2451 else
2452 dc.SetTextForeground(m_colDisPropFore);
2453 }
2454 }
2455 else
2456 {
2457 if ( renderFlags & wxPGCellRenderer::DontUseCellBgCol )
2458 {
2459 dc.SetBrush(rowBgBrush);
2460 dc.SetPen(rowBgCol);
2461 }
2462
2463 if ( renderFlags & wxPGCellRenderer::DontUseCellFgCol )
2464 {
2465 dc.SetTextForeground(rowFgCol);
2466 }
2467 }
2468
2469 dc.SetClippingRegion(cellRect);
2470
2471 cellRect.x += textXAdd;
2472 cellRect.width -= textXAdd;
2473
2474 // Foreground
2475 if ( !cellEditor )
2476 {
2477 wxPGCellRenderer* renderer;
2478 int cmnVal = p->GetCommonValue();
2479 if ( cmnVal == -1 || ci != 1 )
2480 {
2481 renderer = p->GetCellRenderer(ci);
2482 prevFilled = renderer->Render(dc, cellRect, this,
2483 p, ci, -1,
2484 cellRenderFlags );
2485 }
2486 else
2487 {
2488 renderer = GetCommonValue(cmnVal)->GetRenderer();
2489 prevFilled = renderer->Render(dc, cellRect, this,
2490 p, ci, -1,
2491 cellRenderFlags );
2492 }
2493 }
2494 else
2495 {
2496 prevFilled = true;
2497 }
2498
2499 dc.DestroyClippingRegion(); // Is this really necessary?
2500 }
2501 while ( ci > 0 );
2502
2503 if ( fontChanged )
2504 dc.SetFont(normalFont);
2505
2506 y += rowHeight;
2507 }
2508
2509 // Refresh editor controls (seems not needed on msw)
2510 // NOTE: This code is mandatory for GTK!
2511 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2512 if ( wasSelectedPainted )
2513 {
2514 if ( m_wndEditor )
2515 m_wndEditor->Refresh();
2516 if ( m_wndEditor2 )
2517 m_wndEditor2->Refresh();
2518 }
2519 #endif
2520
2521 return y;
2522 }
2523
2524 // -----------------------------------------------------------------------
2525
2526 wxRect wxPropertyGrid::GetPropertyRect( const wxPGProperty* p1, const wxPGProperty* p2 ) const
2527 {
2528 wxRect r;
2529
2530 if ( m_width < 10 || m_height < 10 ||
2531 !m_pState->m_properties->GetChildCount() ||
2532 p1 == NULL )
2533 return wxRect(0,0,0,0);
2534
2535 int vy = 0;
2536
2537 //
2538 // Return rect which encloses the given property range
2539 // (in logical grid coordinates)
2540 //
2541
2542 int visTop = p1->GetY();
2543 int visBottom;
2544 if ( p2 )
2545 visBottom = p2->GetY() + m_lineHeight;
2546 else
2547 visBottom = m_height + visTop;
2548
2549 // If seleced property is inside the range, we'll extend the range to include
2550 // control's size.
2551 wxPGProperty* selected = GetSelection();
2552 if ( selected )
2553 {
2554 int selectedY = selected->GetY();
2555 if ( selectedY >= visTop && selectedY < visBottom )
2556 {
2557 wxWindow* editor = GetEditorControl();
2558 if ( editor )
2559 {
2560 int visBottom2 = selectedY + editor->GetSize().y;
2561 if ( visBottom2 > visBottom )
2562 visBottom = visBottom2;
2563 }
2564 }
2565 }
2566
2567 return wxRect(0,visTop-vy,m_pState->m_width,visBottom-visTop);
2568 }
2569
2570 // -----------------------------------------------------------------------
2571
2572 void wxPropertyGrid::DrawItems( const wxPGProperty* p1, const wxPGProperty* p2 )
2573 {
2574 if ( m_frozen )
2575 return;
2576
2577 if ( m_pState->m_itemsAdded )
2578 PrepareAfterItemsAdded();
2579
2580 wxRect r = GetPropertyRect(p1, p2);
2581 if ( r.width > 0 )
2582 {
2583 // Convert rectangle from logical grid coordinates to physical ones
2584 int vx, vy;
2585 GetViewStart(&vx, &vy);
2586 vx *= wxPG_PIXELS_PER_UNIT;
2587 vy *= wxPG_PIXELS_PER_UNIT;
2588 r.x -= vx;
2589 r.y -= vy;
2590 RefreshRect(r);
2591 }
2592 }
2593
2594 // -----------------------------------------------------------------------
2595
2596 void wxPropertyGrid::RefreshProperty( wxPGProperty* p )
2597 {
2598 if ( m_pState->DoIsPropertySelected(p) )
2599 {
2600 // NB: We must copy the selection.
2601 wxArrayPGProperty selection = m_pState->m_selection;
2602 DoSetSelection(selection, wxPG_SEL_FORCE);
2603 }
2604
2605 DrawItemAndChildren(p);
2606 }
2607
2608 // -----------------------------------------------------------------------
2609
2610 void wxPropertyGrid::DrawItemAndValueRelated( wxPGProperty* p )
2611 {
2612 if ( m_frozen )
2613 return;
2614
2615 // Draw item, children, and parent too, if it is not category
2616 wxPGProperty* parent = p->GetParent();
2617
2618 while ( parent &&
2619 !parent->IsCategory() &&
2620 parent->GetParent() )
2621 {
2622 DrawItem(parent);
2623 parent = parent->GetParent();
2624 }
2625
2626 DrawItemAndChildren(p);
2627 }
2628
2629 void wxPropertyGrid::DrawItemAndChildren( wxPGProperty* p )
2630 {
2631 wxCHECK_RET( p, wxT("invalid property id") );
2632
2633 // Do not draw if in non-visible page
2634 if ( p->GetParentState() != m_pState )
2635 return;
2636
2637 // do not draw a single item if multiple pending
2638 if ( m_pState->m_itemsAdded || m_frozen )
2639 return;
2640
2641 // Update child control.
2642 wxPGProperty* selected = GetSelection();
2643 if ( selected && selected->GetParent() == p )
2644 RefreshEditor();
2645
2646 const wxPGProperty* lastDrawn = p->GetLastVisibleSubItem();
2647
2648 DrawItems(p, lastDrawn);
2649 }
2650
2651 // -----------------------------------------------------------------------
2652
2653 void wxPropertyGrid::Refresh( bool WXUNUSED(eraseBackground),
2654 const wxRect *rect )
2655 {
2656 PrepareAfterItemsAdded();
2657
2658 wxWindow::Refresh(false, rect);
2659
2660 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
2661 // I think this really helps only GTK+1.2
2662 if ( m_wndEditor ) m_wndEditor->Refresh();
2663 if ( m_wndEditor2 ) m_wndEditor2->Refresh();
2664 #endif
2665 }
2666
2667 // -----------------------------------------------------------------------
2668 // wxPropertyGrid global operations
2669 // -----------------------------------------------------------------------
2670
2671 void wxPropertyGrid::Clear()
2672 {
2673 m_pState->DoClear();
2674
2675 m_propHover = NULL;
2676
2677 m_prevVY = 0;
2678
2679 RecalculateVirtualSize();
2680
2681 // Need to clear some area at the end
2682 if ( !m_frozen )
2683 RefreshRect(wxRect(0, 0, m_width, m_height));
2684 }
2685
2686 // -----------------------------------------------------------------------
2687
2688 bool wxPropertyGrid::EnableCategories( bool enable )
2689 {
2690 DoClearSelection();
2691
2692 if ( enable )
2693 {
2694 //
2695 // Enable categories
2696 //
2697
2698 m_windowStyle &= ~(wxPG_HIDE_CATEGORIES);
2699 }
2700 else
2701 {
2702 //
2703 // Disable categories
2704 //
2705 m_windowStyle |= wxPG_HIDE_CATEGORIES;
2706 }
2707
2708 if ( !m_pState->EnableCategories(enable) )
2709 return false;
2710
2711 if ( !m_frozen )
2712 {
2713 if ( m_windowStyle & wxPG_AUTO_SORT )
2714 {
2715 m_pState->m_itemsAdded = 1; // force
2716 PrepareAfterItemsAdded();
2717 }
2718 }
2719 else
2720 m_pState->m_itemsAdded = 1;
2721
2722 // No need for RecalculateVirtualSize() here - it is already called in
2723 // wxPropertyGridPageState method above.
2724
2725 Refresh();
2726
2727 return true;
2728 }
2729
2730 // -----------------------------------------------------------------------
2731
2732 void wxPropertyGrid::SwitchState( wxPropertyGridPageState* pNewState )
2733 {
2734 wxASSERT( pNewState );
2735 wxASSERT( pNewState->GetGrid() );
2736
2737 if ( pNewState == m_pState )
2738 return;
2739
2740 wxArrayPGProperty oldSelection = m_pState->m_selection;
2741
2742 // Call ClearSelection() instead of DoClearSelection()
2743 // so that selection clear events are not sent.
2744 ClearSelection();
2745
2746 m_pState->m_selection = oldSelection;
2747
2748 bool orig_mode = m_pState->IsInNonCatMode();
2749 bool new_state_mode = pNewState->IsInNonCatMode();
2750
2751 m_pState = pNewState;
2752
2753 // Validate width
2754 int pgWidth = GetClientSize().x;
2755 if ( HasVirtualWidth() )
2756 {
2757 int minWidth = pgWidth;
2758 if ( pNewState->m_width < minWidth )
2759 {
2760 pNewState->m_width = minWidth;
2761 pNewState->CheckColumnWidths();
2762 }
2763 }
2764 else
2765 {
2766 //
2767 // Just in case, fully re-center splitter
2768 //if ( HasFlag( wxPG_SPLITTER_AUTO_CENTER ) )
2769 // pNewState->m_fSplitterX = -1.0;
2770
2771 pNewState->OnClientWidthChange(pgWidth,
2772 pgWidth - pNewState->m_width);
2773 }
2774
2775 m_propHover = NULL;
2776
2777 // If necessary, convert state to correct mode.
2778 if ( orig_mode != new_state_mode )
2779 {
2780 // This should refresh as well.
2781 EnableCategories( orig_mode?false:true );
2782 }
2783 else if ( !m_frozen )
2784 {
2785 // Refresh, if not frozen.
2786 m_pState->PrepareAfterItemsAdded();
2787
2788 // Reselect (Use SetSelection() instead of Do-variant so that
2789 // events won't be sent).
2790 SetSelection(m_pState->m_selection);
2791
2792 RecalculateVirtualSize(0);
2793 Refresh();
2794 }
2795 else
2796 m_pState->m_itemsAdded = 1;
2797 }
2798
2799 // -----------------------------------------------------------------------
2800
2801 // Call to SetSplitterPosition will always disable splitter auto-centering
2802 // if parent window is shown.
2803 void wxPropertyGrid::DoSetSplitterPosition( int newxpos,
2804 int splitterIndex,
2805 int flags )
2806 {
2807 if ( ( newxpos < wxPG_DRAG_MARGIN ) )
2808 return;
2809
2810 wxPropertyGridPageState* state = m_pState;
2811
2812 if ( flags & wxPG_SPLITTER_FROM_EVENT )
2813 state->m_dontCenterSplitter = true;
2814
2815 state->DoSetSplitterPosition(newxpos, splitterIndex, flags);
2816
2817 if ( flags & wxPG_SPLITTER_REFRESH )
2818 {
2819 if ( GetSelection() )
2820 CorrectEditorWidgetSizeX();
2821
2822 Refresh();
2823 }
2824
2825 return;
2826 }
2827
2828 // -----------------------------------------------------------------------
2829
2830 void wxPropertyGrid::ResetColumnSizes( bool enableAutoResizing )
2831 {
2832 wxPropertyGridPageState* state = m_pState;
2833 if ( state )
2834 state->ResetColumnSizes(0);
2835
2836 if ( enableAutoResizing && HasFlag(wxPG_SPLITTER_AUTO_CENTER) )
2837 m_pState->m_dontCenterSplitter = false;
2838 }
2839
2840 // -----------------------------------------------------------------------
2841
2842 void wxPropertyGrid::CenterSplitter( bool enableAutoResizing )
2843 {
2844 SetSplitterPosition( m_width/2 );
2845 if ( enableAutoResizing && HasFlag(wxPG_SPLITTER_AUTO_CENTER) )
2846 m_pState->m_dontCenterSplitter = false;
2847 }
2848
2849 // -----------------------------------------------------------------------
2850 // wxPropertyGrid item iteration (GetNextProperty etc.) methods
2851 // -----------------------------------------------------------------------
2852
2853 // Returns nearest paint visible property (such that will be painted unless
2854 // window is scrolled or resized). If given property is paint visible, then
2855 // it itself will be returned
2856 wxPGProperty* wxPropertyGrid::GetNearestPaintVisible( wxPGProperty* p ) const
2857 {
2858 int vx,vy1;// Top left corner of client
2859 GetViewStart(&vx,&vy1);
2860 vy1 *= wxPG_PIXELS_PER_UNIT;
2861
2862 int vy2 = vy1 + m_height;
2863 int propY = p->GetY2(m_lineHeight);
2864
2865 if ( (propY + m_lineHeight) < vy1 )
2866 {
2867 // Too high
2868 return DoGetItemAtY( vy1 );
2869 }
2870 else if ( propY > vy2 )
2871 {
2872 // Too low
2873 return DoGetItemAtY( vy2 );
2874 }
2875
2876 // Itself paint visible
2877 return p;
2878
2879 }
2880
2881 // -----------------------------------------------------------------------
2882 // Methods related to change in value, value modification and sending events
2883 // -----------------------------------------------------------------------
2884
2885 // commits any changes in editor of selected property
2886 // return true if validation did not fail
2887 // flags are same as with DoSelectProperty
2888 bool wxPropertyGrid::CommitChangesFromEditor( wxUint32 flags )
2889 {
2890 // Committing already?
2891 if ( m_inCommitChangesFromEditor )
2892 return true;
2893
2894 // Don't do this if already processing editor event. It might
2895 // induce recursive dialogs and crap like that.
2896 if ( m_iFlags & wxPG_FL_IN_HANDLECUSTOMEDITOREVENT )
2897 {
2898 if ( m_inDoPropertyChanged )
2899 return true;
2900
2901 return false;
2902 }
2903
2904 wxPGProperty* selected = GetSelection();
2905
2906 if ( m_wndEditor &&
2907 IsEditorsValueModified() &&
2908 (m_iFlags & wxPG_FL_INITIALIZED) &&
2909 selected )
2910 {
2911 m_inCommitChangesFromEditor = 1;
2912
2913 wxVariant variant(selected->GetValueRef());
2914 bool valueIsPending = false;
2915
2916 // JACS - necessary to avoid new focus being found spuriously within OnIdle
2917 // due to another window getting focus
2918 wxWindow* oldFocus = m_curFocused;
2919
2920 bool validationFailure = false;
2921 bool forceSuccess = (flags & (wxPG_SEL_NOVALIDATE|wxPG_SEL_FORCE)) ? true : false;
2922
2923 m_chgInfo_changedProperty = NULL;
2924
2925 // If truly modified, schedule value as pending.
2926 if ( selected->GetEditorClass()->
2927 GetValueFromControl( variant,
2928 selected,
2929 GetEditorControl() ) )
2930 {
2931 if ( DoEditorValidate() &&
2932 PerformValidation(selected, variant) )
2933 {
2934 valueIsPending = true;
2935 }
2936 else
2937 {
2938 validationFailure = true;
2939 }
2940 }
2941 else
2942 {
2943 EditorsValueWasNotModified();
2944 }
2945
2946 bool res = true;
2947
2948 m_inCommitChangesFromEditor = 0;
2949
2950 if ( validationFailure && !forceSuccess )
2951 {
2952 if (oldFocus)
2953 {
2954 oldFocus->SetFocus();
2955 m_curFocused = oldFocus;
2956 }
2957
2958 res = OnValidationFailure(selected, variant);
2959
2960 // Now prevent further validation failure messages
2961 if ( res )
2962 {
2963 EditorsValueWasNotModified();
2964 OnValidationFailureReset(selected);
2965 }
2966 }
2967 else if ( valueIsPending )
2968 {
2969 DoPropertyChanged( selected, flags );
2970 EditorsValueWasNotModified();
2971 }
2972
2973 return res;
2974 }
2975
2976 return true;
2977 }
2978
2979 // -----------------------------------------------------------------------
2980
2981 bool wxPropertyGrid::PerformValidation( wxPGProperty* p, wxVariant& pendingValue,
2982 int flags )
2983 {
2984 //
2985 // Runs all validation functionality.
2986 // Returns true if value passes all tests.
2987 //
2988
2989 m_validationInfo.m_failureBehavior = m_permanentValidationFailureBehavior;
2990
2991 //
2992 // Variant list a special value that cannot be validated
2993 // by normal means.
2994 if ( pendingValue.GetType() != wxPG_VARIANT_TYPE_LIST )
2995 {
2996 if ( !p->ValidateValue(pendingValue, m_validationInfo) )
2997 return false;
2998 }
2999
3000 //
3001 // Adapt list to child values, if necessary
3002 wxVariant listValue = pendingValue;
3003 wxVariant* pPendingValue = &pendingValue;
3004 wxVariant* pList = NULL;
3005
3006 // If parent has wxPG_PROP_AGGREGATE flag, or uses composite
3007 // string value, then we need treat as it was changed instead
3008 // (or, in addition, as is the case with composite string parent).
3009 // This includes creating list variant for child values.
3010
3011 wxPGProperty* pwc = p->GetParent();
3012 wxPGProperty* changedProperty = p;
3013 wxPGProperty* baseChangedProperty = changedProperty;
3014 wxVariant bcpPendingList;
3015
3016 listValue = pendingValue;
3017 listValue.SetName(p->GetBaseName());
3018
3019 while ( pwc &&
3020 (pwc->HasFlag(wxPG_PROP_AGGREGATE) || pwc->HasFlag(wxPG_PROP_COMPOSED_VALUE)) )
3021 {
3022 wxVariantList tempList;
3023 wxVariant lv(tempList, pwc->GetBaseName());
3024 lv.Append(listValue);
3025 listValue = lv;
3026 pPendingValue = &listValue;
3027
3028 if ( pwc->HasFlag(wxPG_PROP_AGGREGATE) )
3029 {
3030 baseChangedProperty = pwc;
3031 bcpPendingList = lv;
3032 }
3033
3034 changedProperty = pwc;
3035 pwc = pwc->GetParent();
3036 }
3037
3038 wxVariant value;
3039 wxPGProperty* evtChangingProperty = changedProperty;
3040
3041 if ( pPendingValue->GetType() != wxPG_VARIANT_TYPE_LIST )
3042 {
3043 value = *pPendingValue;
3044 }
3045 else
3046 {
3047 // Convert list to child values
3048 pList = pPendingValue;
3049 changedProperty->AdaptListToValue( *pPendingValue, &value );
3050 }
3051
3052 wxVariant evtChangingValue = value;
3053
3054 if ( flags & SendEvtChanging )
3055 {
3056 // FIXME: After proper ValueToString()s added, remove
3057 // this. It is just a temporary fix, as evt_changing
3058 // will simply not work for wxPG_PROP_COMPOSED_VALUE
3059 // (unless it is selected, and textctrl editor is open).
3060 if ( changedProperty->HasFlag(wxPG_PROP_COMPOSED_VALUE) )
3061 {
3062 evtChangingProperty = baseChangedProperty;
3063 if ( evtChangingProperty != p )
3064 {
3065 evtChangingProperty->AdaptListToValue( bcpPendingList, &evtChangingValue );
3066 }
3067 else
3068 {
3069 evtChangingValue = pendingValue;
3070 }
3071 }
3072
3073 if ( evtChangingProperty->HasFlag(wxPG_PROP_COMPOSED_VALUE) )
3074 {
3075 if ( changedProperty == GetSelection() )
3076 {
3077 wxWindow* editor = GetEditorControl();
3078 wxASSERT( editor->IsKindOf(CLASSINFO(wxTextCtrl)) );
3079 evtChangingValue = wxStaticCast(editor, wxTextCtrl)->GetValue();
3080 }
3081 else
3082 {
3083 wxLogDebug(wxT("WARNING: wxEVT_PG_CHANGING is about to happen with old value."));
3084 }
3085 }
3086 }
3087
3088 wxASSERT( m_chgInfo_changedProperty == NULL );
3089 m_chgInfo_changedProperty = changedProperty;
3090 m_chgInfo_baseChangedProperty = baseChangedProperty;
3091 m_chgInfo_pendingValue = value;
3092
3093 if ( pList )
3094 m_chgInfo_valueList = *pList;
3095 else
3096 m_chgInfo_valueList.MakeNull();
3097
3098 // If changedProperty is not property which value was edited,
3099 // then call wxPGProperty::ValidateValue() for that as well.
3100 if ( p != changedProperty && value.GetType() != wxPG_VARIANT_TYPE_LIST )
3101 {
3102 if ( !changedProperty->ValidateValue(value, m_validationInfo) )
3103 return false;
3104 }
3105
3106 if ( flags & SendEvtChanging )
3107 {
3108 // SendEvent returns true if event was vetoed
3109 if ( SendEvent( wxEVT_PG_CHANGING, evtChangingProperty,
3110 &evtChangingValue ) )
3111 return false;
3112 }
3113
3114 if ( flags & IsStandaloneValidation )
3115 {
3116 // If called in 'generic' context, we need to reset
3117 // m_chgInfo_changedProperty and write back translated value.
3118 m_chgInfo_changedProperty = NULL;
3119 pendingValue = value;
3120 }
3121
3122 return true;
3123 }
3124
3125 // -----------------------------------------------------------------------
3126
3127 void wxPropertyGrid::DoShowPropertyError( wxPGProperty* WXUNUSED(property), const wxString& msg )
3128 {
3129 if ( !msg.length() )
3130 return;
3131
3132 #if wxUSE_STATUSBAR
3133 if ( !wxPGGlobalVars->m_offline )
3134 {
3135 wxWindow* topWnd = ::wxGetTopLevelParent(this);
3136 if ( topWnd )
3137 {
3138 wxFrame* pFrame = wxDynamicCast(topWnd, wxFrame);
3139 if ( pFrame )
3140 {
3141 wxStatusBar* pStatusBar = pFrame->GetStatusBar();
3142 if ( pStatusBar )
3143 {
3144 pStatusBar->SetStatusText(msg);
3145 return;
3146 }
3147 }
3148 }
3149 }
3150 #endif
3151
3152 ::wxMessageBox(msg, wxT("Property Error"));
3153 }
3154
3155 // -----------------------------------------------------------------------
3156
3157 bool wxPropertyGrid::OnValidationFailure( wxPGProperty* property,
3158 wxVariant& invalidValue )
3159 {
3160 wxWindow* editor = GetEditorControl();
3161
3162 // First call property's handler
3163 property->OnValidationFailure(invalidValue);
3164
3165 bool res = DoOnValidationFailure(property, invalidValue);
3166
3167 //
3168 // For non-wxTextCtrl editors, we do need to revert the value
3169 if ( !editor->IsKindOf(CLASSINFO(wxTextCtrl)) &&
3170 property == GetSelection() )
3171 {
3172 property->GetEditorClass()->UpdateControl(property, editor);
3173 }
3174
3175 property->SetFlag(wxPG_PROP_INVALID_VALUE);
3176
3177 return res;
3178 }
3179
3180 bool wxPropertyGrid::DoOnValidationFailure( wxPGProperty* property, wxVariant& WXUNUSED(invalidValue) )
3181 {
3182 int vfb = m_validationInfo.m_failureBehavior;
3183
3184 if ( vfb & wxPG_VFB_BEEP )
3185 ::wxBell();
3186
3187 if ( (vfb & wxPG_VFB_MARK_CELL) &&
3188 !property->HasFlag(wxPG_PROP_INVALID_VALUE) )
3189 {
3190 unsigned int colCount = m_pState->GetColumnCount();
3191
3192 // We need backup marked property's cells
3193 m_propCellsBackup = property->m_cells;
3194
3195 wxColour vfbFg = *wxWHITE;
3196 wxColour vfbBg = *wxRED;
3197
3198 property->EnsureCells(colCount);
3199
3200 for ( unsigned int i=0; i<colCount; i++ )
3201 {
3202 wxPGCell& cell = property->m_cells[i];
3203 cell.SetFgCol(vfbFg);
3204 cell.SetBgCol(vfbBg);
3205 }
3206
3207 DrawItemAndChildren(property);
3208
3209 if ( property == GetSelection() )
3210 {
3211 SetInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL);
3212
3213 wxWindow* editor = GetEditorControl();
3214 if ( editor )
3215 {
3216 editor->SetForegroundColour(vfbFg);
3217 editor->SetBackgroundColour(vfbBg);
3218 }
3219 }
3220 }
3221
3222 if ( vfb & wxPG_VFB_SHOW_MESSAGE )
3223 {
3224 wxString msg = m_validationInfo.m_failureMessage;
3225
3226 if ( !msg.length() )
3227 msg = wxT("You have entered invalid value. Press ESC to cancel editing.");
3228
3229 DoShowPropertyError(property, msg);
3230 }
3231
3232 return (vfb & wxPG_VFB_STAY_IN_PROPERTY) ? false : true;
3233 }
3234
3235 // -----------------------------------------------------------------------
3236
3237 void wxPropertyGrid::DoOnValidationFailureReset( wxPGProperty* property )
3238 {
3239 int vfb = m_validationInfo.m_failureBehavior;
3240
3241 if ( vfb & wxPG_VFB_MARK_CELL )
3242 {
3243 // Revert cells
3244 property->m_cells = m_propCellsBackup;
3245
3246 ClearInternalFlag(wxPG_FL_CELL_OVERRIDES_SEL);
3247
3248 if ( property == GetSelection() && GetEditorControl() )
3249 {
3250 // Calling this will recreate the control, thus resetting its colour
3251 RefreshProperty(property);
3252 }
3253 else
3254 {
3255 DrawItemAndChildren(property);
3256 }
3257 }
3258 }
3259
3260 // -----------------------------------------------------------------------
3261
3262 // flags are same as with DoSelectProperty
3263 bool wxPropertyGrid::DoPropertyChanged( wxPGProperty* p, unsigned int selFlags )
3264 {
3265 if ( m_inDoPropertyChanged )
3266 return true;
3267
3268 wxWindow* editor = GetEditorControl();
3269 wxPGProperty* selected = GetSelection();
3270
3271 m_pState->m_anyModified = 1;
3272
3273 m_inDoPropertyChanged = 1;
3274
3275 // Maybe need to update control
3276 wxASSERT( m_chgInfo_changedProperty != NULL );
3277
3278 // These values were calculated in PerformValidation()
3279 wxPGProperty* changedProperty = m_chgInfo_changedProperty;
3280 wxVariant value = m_chgInfo_pendingValue;
3281
3282 wxPGProperty* topPaintedProperty = changedProperty;
3283
3284 while ( !topPaintedProperty->IsCategory() &&
3285 !topPaintedProperty->IsRoot() )
3286 {
3287 topPaintedProperty = topPaintedProperty->GetParent();
3288 }
3289
3290 changedProperty->SetValue(value, &m_chgInfo_valueList, wxPG_SETVAL_BY_USER);
3291
3292 // Set as Modified (not if dragging just began)
3293 if ( !(p->m_flags & wxPG_PROP_MODIFIED) )
3294 {
3295 p->m_flags |= wxPG_PROP_MODIFIED;
3296 if ( p == selected && (m_windowStyle & wxPG_BOLD_MODIFIED) )
3297 {
3298 if ( editor )
3299 SetCurControlBoldFont();
3300 }
3301 }
3302
3303 wxPGProperty* pwc;
3304
3305 // Propagate updates to parent(s)
3306 pwc = p;
3307 wxPGProperty* prevPwc = NULL;
3308
3309 while ( prevPwc != topPaintedProperty )
3310 {
3311 pwc->m_flags |= wxPG_PROP_MODIFIED;
3312
3313 if ( pwc == selected && (m_windowStyle & wxPG_BOLD_MODIFIED) )
3314 {
3315 if ( editor )
3316 SetCurControlBoldFont();
3317 }
3318
3319 prevPwc = pwc;
3320 pwc = pwc->GetParent();
3321 }
3322
3323 // Draw the actual property
3324 DrawItemAndChildren( topPaintedProperty );
3325
3326 //
3327 // If value was set by wxPGProperty::OnEvent, then update the editor
3328 // control.
3329 if ( selFlags & wxPG_SEL_DIALOGVAL )
3330 {
3331 RefreshEditor();
3332 }
3333 else
3334 {
3335 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
3336 if ( m_wndEditor ) m_wndEditor->Refresh();
3337 if ( m_wndEditor2 ) m_wndEditor2->Refresh();
3338 #endif
3339 }
3340
3341 // Sanity check
3342 wxASSERT( !changedProperty->GetParent()->HasFlag(wxPG_PROP_AGGREGATE) );
3343
3344 // If top parent has composite string value, then send to child parents,
3345 // starting from baseChangedProperty.
3346 if ( changedProperty->HasFlag(wxPG_PROP_COMPOSED_VALUE) )
3347 {
3348 pwc = m_chgInfo_baseChangedProperty;
3349
3350 while ( pwc != changedProperty )
3351 {
3352 SendEvent( wxEVT_PG_CHANGED, pwc, NULL );
3353 pwc = pwc->GetParent();
3354 }
3355 }
3356
3357 SendEvent( wxEVT_PG_CHANGED, changedProperty, NULL );
3358
3359 m_inDoPropertyChanged = 0;
3360
3361 return true;
3362 }
3363
3364 // -----------------------------------------------------------------------
3365
3366 bool wxPropertyGrid::ChangePropertyValue( wxPGPropArg id, wxVariant newValue )
3367 {
3368 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
3369
3370 m_chgInfo_changedProperty = NULL;
3371
3372 if ( PerformValidation(p, newValue) )
3373 {
3374 DoPropertyChanged(p);
3375 return true;
3376 }
3377 else
3378 {
3379 OnValidationFailure(p, newValue);
3380 }
3381
3382 return false;
3383 }
3384
3385 // -----------------------------------------------------------------------
3386
3387 wxVariant wxPropertyGrid::GetUncommittedPropertyValue()
3388 {
3389 wxPGProperty* prop = GetSelectedProperty();
3390
3391 if ( !prop )
3392 return wxNullVariant;
3393
3394 wxTextCtrl* tc = GetEditorTextCtrl();
3395 wxVariant value = prop->GetValue();
3396
3397 if ( !tc || !IsEditorsValueModified() )
3398 return value;
3399
3400 if ( !prop->StringToValue(value, tc->GetValue()) )
3401 return value;
3402
3403 if ( !PerformValidation(prop, value, IsStandaloneValidation) )
3404 return prop->GetValue();
3405
3406 return value;
3407 }
3408
3409 // -----------------------------------------------------------------------
3410
3411 // Runs wxValidator for the selected property
3412 bool wxPropertyGrid::DoEditorValidate()
3413 {
3414 return true;
3415 }
3416
3417 // -----------------------------------------------------------------------
3418
3419 void wxPropertyGrid::HandleCustomEditorEvent( wxEvent &event )
3420 {
3421 // It is possible that this handler receives event even before
3422 // the control has been properly initialized. Let's skip the
3423 // event handling in that case.
3424 if ( !m_pState )
3425 return;
3426
3427 // Don't care about the event if it originated from the
3428 // 'label editor'. In this function we only care about the
3429 // property value editor.
3430 if ( m_labelEditor && event.GetId() == m_labelEditor->GetId() )
3431 {
3432 event.Skip();
3433 return;
3434 }
3435
3436 wxPGProperty* selected = GetSelection();
3437
3438 // Somehow, event is handled after property has been deselected.
3439 // Possibly, but very rare.
3440 if ( !selected ||
3441 selected->HasFlag(wxPG_PROP_BEING_DELETED) ||
3442 // Also don't handle editor event if wxEVT_PG_CHANGED or
3443 // similar is currently doing something (showing a
3444 // message box, for instance).
3445 m_processedEvent )
3446 return;
3447
3448 if ( m_iFlags & wxPG_FL_IN_HANDLECUSTOMEDITOREVENT )
3449 return;
3450
3451 wxVariant pendingValue(selected->GetValueRef());
3452 wxWindow* wnd = GetEditorControl();
3453 wxWindow* editorWnd = wxDynamicCast(event.GetEventObject(), wxWindow);
3454 int selFlags = 0;
3455 bool wasUnspecified = selected->IsValueUnspecified();
3456 int usesAutoUnspecified = selected->UsesAutoUnspecified();
3457 bool valueIsPending = false;
3458
3459 m_chgInfo_changedProperty = NULL;
3460
3461 m_iFlags &= ~(wxPG_FL_VALIDATION_FAILED|wxPG_FL_VALUE_CHANGE_IN_EVENT);
3462
3463 //
3464 // Filter out excess wxTextCtrl modified events
3465 if ( event.GetEventType() == wxEVT_COMMAND_TEXT_UPDATED && wnd )
3466 {
3467 if ( wnd->IsKindOf(CLASSINFO(wxTextCtrl)) )
3468 {
3469 wxTextCtrl* tc = (wxTextCtrl*) wnd;
3470
3471 wxString newTcValue = tc->GetValue();
3472 if ( m_prevTcValue == newTcValue )
3473 return;
3474 m_prevTcValue = newTcValue;
3475 }
3476 else if ( wnd->IsKindOf(CLASSINFO(wxComboCtrl)) )
3477 {
3478 wxComboCtrl* cc = (wxComboCtrl*) wnd;
3479
3480 wxString newTcValue = cc->GetTextCtrl()->GetValue();
3481 if ( m_prevTcValue == newTcValue )
3482 return;
3483 m_prevTcValue = newTcValue;
3484 }
3485 }
3486
3487 SetInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT);
3488
3489 bool validationFailure = false;
3490 bool buttonWasHandled = false;
3491
3492 //
3493 // Try common button handling
3494 if ( m_wndEditor2 && event.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED )
3495 {
3496 wxPGEditorDialogAdapter* adapter = selected->GetEditorDialog();
3497
3498 if ( adapter )
3499 {
3500 buttonWasHandled = true;
3501 // Store as res2, as previously (and still currently alternatively)
3502 // dialogs can be shown by handling wxEVT_COMMAND_BUTTON_CLICKED
3503 // in wxPGProperty::OnEvent().
3504 adapter->ShowDialog( this, selected );
3505 delete adapter;
3506 }
3507 }
3508
3509 if ( !buttonWasHandled )
3510 {
3511 if ( wnd || m_wndEditor2 )
3512 {
3513 // First call editor class' event handler.
3514 const wxPGEditor* editor = selected->GetEditorClass();
3515
3516 if ( editor->OnEvent( this, selected, editorWnd, event ) )
3517 {
3518 // If changes, validate them
3519 if ( DoEditorValidate() )
3520 {
3521 if ( editor->GetValueFromControl( pendingValue,
3522 selected,
3523 wnd ) )
3524 valueIsPending = true;
3525 }
3526 else
3527 {
3528 validationFailure = true;
3529 }
3530 }
3531 }
3532
3533 // Then the property's custom handler (must be always called, unless
3534 // validation failed).
3535 if ( !validationFailure )
3536 buttonWasHandled = selected->OnEvent( this, editorWnd, event );
3537 }
3538
3539 // SetValueInEvent(), as called in one of the functions referred above
3540 // overrides editor's value.
3541 if ( m_iFlags & wxPG_FL_VALUE_CHANGE_IN_EVENT )
3542 {
3543 valueIsPending = true;
3544 pendingValue = m_changeInEventValue;
3545 selFlags |= wxPG_SEL_DIALOGVAL;
3546 }
3547
3548 if ( !validationFailure && valueIsPending )
3549 if ( !PerformValidation(selected, pendingValue) )
3550 validationFailure = true;
3551
3552 if ( validationFailure)
3553 {
3554 OnValidationFailure(selected, pendingValue);
3555 }
3556 else if ( valueIsPending )
3557 {
3558 selFlags |= ( !wasUnspecified && selected->IsValueUnspecified() && usesAutoUnspecified ) ? wxPG_SEL_SETUNSPEC : 0;
3559
3560 DoPropertyChanged(selected, selFlags);
3561 EditorsValueWasNotModified();
3562
3563 // Regardless of editor type, unfocus editor on
3564 // text-editing related enter press.
3565 if ( event.GetEventType() == wxEVT_COMMAND_TEXT_ENTER )
3566 {
3567 SetFocusOnCanvas();
3568 }
3569 }
3570 else
3571 {
3572 // No value after all
3573
3574 // Regardless of editor type, unfocus editor on
3575 // text-editing related enter press.
3576 if ( event.GetEventType() == wxEVT_COMMAND_TEXT_ENTER )
3577 {
3578 SetFocusOnCanvas();
3579 }
3580
3581 // Let unhandled button click events go to the parent
3582 if ( !buttonWasHandled && event.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED )
3583 {
3584 wxCommandEvent evt(wxEVT_COMMAND_BUTTON_CLICKED,GetId());
3585 GetEventHandler()->AddPendingEvent(evt);
3586 }
3587 }
3588
3589 ClearInternalFlag(wxPG_FL_IN_HANDLECUSTOMEDITOREVENT);
3590 }
3591
3592 // -----------------------------------------------------------------------
3593 // wxPropertyGrid editor control helper methods
3594 // -----------------------------------------------------------------------
3595
3596 wxRect wxPropertyGrid::GetEditorWidgetRect( wxPGProperty* p, int column ) const
3597 {
3598 int itemy = p->GetY2(m_lineHeight);
3599 int splitterX = m_pState->DoGetSplitterPosition(column-1);
3600 int colEnd = splitterX + m_pState->m_colWidths[column];
3601 int imageOffset = 0;
3602
3603 int vx, vy; // Top left corner of client
3604 GetViewStart(&vx, &vy);
3605 vy *= wxPG_PIXELS_PER_UNIT;
3606
3607 if ( column == 1 )
3608 {
3609 // TODO: If custom image detection changes from current, change this.
3610 if ( m_iFlags & wxPG_FL_CUR_USES_CUSTOM_IMAGE )
3611 {
3612 //m_iFlags |= wxPG_FL_CUR_USES_CUSTOM_IMAGE;
3613 int iw = p->OnMeasureImage().x;
3614 if ( iw < 1 )
3615 iw = wxPG_CUSTOM_IMAGE_WIDTH;
3616 imageOffset = p->GetImageOffset(iw);
3617 }
3618 }
3619 else if ( column == 0 )
3620 {
3621 splitterX += (p->m_depth - 1) * m_subgroup_extramargin;
3622 }
3623
3624 return wxRect
3625 (
3626 splitterX+imageOffset+wxPG_XBEFOREWIDGET+wxPG_CONTROL_MARGIN+1,
3627 itemy-vy,
3628 colEnd-splitterX-wxPG_XBEFOREWIDGET-wxPG_CONTROL_MARGIN-imageOffset-1,
3629 m_lineHeight-1
3630 );
3631 }
3632
3633 // -----------------------------------------------------------------------
3634
3635 wxRect wxPropertyGrid::GetImageRect( wxPGProperty* p, int item ) const
3636 {
3637 wxSize sz = GetImageSize(p, item);
3638 return wxRect(wxPG_CONTROL_MARGIN + wxCC_CUSTOM_IMAGE_MARGIN1,
3639 wxPG_CUSTOM_IMAGE_SPACINGY,
3640 sz.x,
3641 sz.y);
3642 }
3643
3644 // return size of custom paint image
3645 wxSize wxPropertyGrid::GetImageSize( wxPGProperty* p, int item ) const
3646 {
3647 // If called with NULL property, then return default image
3648 // size for properties that use image.
3649 if ( !p )
3650 return wxSize(wxPG_CUSTOM_IMAGE_WIDTH,wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight));
3651
3652 wxSize cis = p->OnMeasureImage(item);
3653
3654 int choiceCount = p->m_choices.GetCount();
3655 int comVals = p->GetDisplayedCommonValueCount();
3656 if ( item >= choiceCount && comVals > 0 )
3657 {
3658 unsigned int cvi = item-choiceCount;
3659 cis = GetCommonValue(cvi)->GetRenderer()->GetImageSize(NULL, 1, cvi);
3660 }
3661 else if ( item >= 0 && choiceCount == 0 )
3662 return wxSize(0, 0);
3663
3664 if ( cis.x < 0 )
3665 {
3666 if ( cis.x <= -1 )
3667 cis.x = wxPG_CUSTOM_IMAGE_WIDTH;
3668 }
3669 if ( cis.y <= 0 )
3670 {
3671 if ( cis.y >= -1 )
3672 cis.y = wxPG_STD_CUST_IMAGE_HEIGHT(m_lineHeight);
3673 else
3674 cis.y = -cis.y;
3675 }
3676 return cis;
3677 }
3678
3679 // -----------------------------------------------------------------------
3680
3681 // takes scrolling into account
3682 void wxPropertyGrid::ImprovedClientToScreen( int* px, int* py )
3683 {
3684 int vx, vy;
3685 GetViewStart(&vx,&vy);
3686 vy*=wxPG_PIXELS_PER_UNIT;
3687 vx*=wxPG_PIXELS_PER_UNIT;
3688 *px -= vx;
3689 *py -= vy;
3690 ClientToScreen( px, py );
3691 }
3692
3693 // -----------------------------------------------------------------------
3694
3695 wxPropertyGridHitTestResult wxPropertyGrid::HitTest( const wxPoint& pt ) const
3696 {
3697 wxPoint pt2;
3698 GetViewStart(&pt2.x,&pt2.y);
3699 pt2.x *= wxPG_PIXELS_PER_UNIT;
3700 pt2.y *= wxPG_PIXELS_PER_UNIT;
3701 pt2.x += pt.x;
3702 pt2.y += pt.y;
3703
3704 return m_pState->HitTest(pt2);
3705 }
3706
3707 // -----------------------------------------------------------------------
3708
3709 // custom set cursor
3710 void wxPropertyGrid::CustomSetCursor( int type, bool override )
3711 {
3712 if ( type == m_curcursor && !override ) return;
3713
3714 wxCursor* cursor = &wxPG_DEFAULT_CURSOR;
3715
3716 if ( type == wxCURSOR_SIZEWE )
3717 cursor = m_cursorSizeWE;
3718
3719 SetCursor( *cursor );
3720
3721 m_curcursor = type;
3722 }
3723
3724 // -----------------------------------------------------------------------
3725
3726 wxString
3727 wxPropertyGrid::GetUnspecifiedValueText( int argFlags ) const
3728 {
3729 const wxPGCell& ua = GetUnspecifiedValueAppearance();
3730
3731 if ( ua.HasText() &&
3732 !(argFlags & wxPG_FULL_VALUE) &&
3733 !(argFlags & wxPG_EDITABLE_VALUE) )
3734 return ua.GetText();
3735
3736 return wxEmptyString;
3737 }
3738
3739 // -----------------------------------------------------------------------
3740 // wxPropertyGrid property selection, editor creation
3741 // -----------------------------------------------------------------------
3742
3743 //
3744 // This class forwards events from property editor controls to wxPropertyGrid.
3745 class wxPropertyGridEditorEventForwarder : public wxEvtHandler
3746 {
3747 public:
3748 wxPropertyGridEditorEventForwarder( wxPropertyGrid* propGrid )
3749 : wxEvtHandler(), m_propGrid(propGrid)
3750 {
3751 }
3752
3753 virtual ~wxPropertyGridEditorEventForwarder()
3754 {
3755 }
3756
3757 private:
3758 bool ProcessEvent( wxEvent& event )
3759 {
3760 // Always skip
3761 event.Skip();
3762
3763 m_propGrid->HandleCustomEditorEvent(event);
3764
3765 //
3766 // NB: On wxMSW, a wxTextCtrl with wxTE_PROCESS_ENTER
3767 // may beep annoyingly if that event is skipped
3768 // and passed to parent event handler.
3769 if ( event.GetEventType() == wxEVT_COMMAND_TEXT_ENTER )
3770 return true;
3771
3772 return wxEvtHandler::ProcessEvent(event);
3773 }
3774
3775 wxPropertyGrid* m_propGrid;
3776 };
3777
3778 // Setups event handling for child control
3779 void wxPropertyGrid::SetupChildEventHandling( wxWindow* argWnd )
3780 {
3781 wxWindowID id = argWnd->GetId();
3782
3783 if ( argWnd == m_wndEditor )
3784 {
3785 argWnd->Connect(id, wxEVT_MOTION,
3786 wxMouseEventHandler(wxPropertyGrid::OnMouseMoveChild),
3787 NULL, this);
3788 argWnd->Connect(id, wxEVT_LEFT_UP,
3789 wxMouseEventHandler(wxPropertyGrid::OnMouseUpChild),
3790 NULL, this);
3791 argWnd->Connect(id, wxEVT_LEFT_DOWN,
3792 wxMouseEventHandler(wxPropertyGrid::OnMouseClickChild),
3793 NULL, this);
3794 argWnd->Connect(id, wxEVT_RIGHT_UP,
3795 wxMouseEventHandler(wxPropertyGrid::OnMouseRightClickChild),
3796 NULL, this);
3797 argWnd->Connect(id, wxEVT_ENTER_WINDOW,
3798 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry),
3799 NULL, this);
3800 argWnd->Connect(id, wxEVT_LEAVE_WINDOW,
3801 wxMouseEventHandler(wxPropertyGrid::OnMouseEntry),
3802 NULL, this);
3803 }
3804
3805 wxPropertyGridEditorEventForwarder* forwarder;
3806 forwarder = new wxPropertyGridEditorEventForwarder(this);
3807 argWnd->PushEventHandler(forwarder);
3808
3809 argWnd->Connect(id, wxEVT_KEY_DOWN,
3810 wxCharEventHandler(wxPropertyGrid::OnChildKeyDown),
3811 NULL, this);
3812 }
3813
3814 void wxPropertyGrid::DestroyEditorWnd( wxWindow* wnd )
3815 {
3816 if ( !wnd )
3817 return;
3818
3819 wnd->Hide();
3820
3821 // Do not free editors immediately (for sake of processing events)
3822 wxPendingDelete.Append(wnd);
3823 }
3824
3825 void wxPropertyGrid::FreeEditors()
3826 {
3827 //
3828 // Return focus back to canvas from children (this is required at least for
3829 // GTK+, which, unlike Windows, clears focus when control is destroyed
3830 // instead of moving it to closest parent).
3831 wxWindow* focus = wxWindow::FindFocus();
3832 if ( focus )
3833 {
3834 wxWindow* parent = focus->GetParent();
3835 while ( parent )
3836 {
3837 if ( parent == this )
3838 {
3839 SetFocusOnCanvas();
3840 break;
3841 }
3842 parent = parent->GetParent();
3843 }
3844 }
3845
3846 // Do not free editors immediately if processing events
3847 if ( m_wndEditor2 )
3848 {
3849 wxEvtHandler* handler = m_wndEditor2->PopEventHandler(false);
3850 m_wndEditor2->Hide();
3851 wxPendingDelete.Append( handler );
3852 DestroyEditorWnd(m_wndEditor2);
3853 m_wndEditor2 = NULL;
3854 }
3855
3856 if ( m_wndEditor )
3857 {
3858 wxEvtHandler* handler = m_wndEditor->PopEventHandler(false);
3859 m_wndEditor->Hide();
3860 wxPendingDelete.Append( handler );
3861 DestroyEditorWnd(m_wndEditor);
3862 m_wndEditor = NULL;
3863 }
3864 }
3865
3866 // Call with NULL to de-select property
3867 bool wxPropertyGrid::DoSelectProperty( wxPGProperty* p, unsigned int flags )
3868 {
3869 /*
3870 if (p)
3871 {
3872 wxLogDebug(wxT("SelectProperty( %s (%s[%i]) )"),p->m_label.c_str(),
3873 p->m_parent->m_label.c_str(),p->GetIndexInParent());
3874 }
3875 else
3876 {
3877 wxLogDebug(wxT("SelectProperty( NULL, -1 )"));
3878 }
3879 */
3880
3881 if ( m_inDoSelectProperty )
3882 return true;
3883
3884 m_inDoSelectProperty = 1;
3885
3886 if ( !m_pState )
3887 {
3888 m_inDoSelectProperty = 0;
3889 return false;
3890 }
3891
3892 wxArrayPGProperty prevSelection = m_pState->m_selection;
3893 wxPGProperty* prevFirstSel;
3894
3895 if ( prevSelection.size() > 0 )
3896 prevFirstSel = prevSelection[0];
3897 else
3898 prevFirstSel = NULL;
3899
3900 if ( prevFirstSel && prevFirstSel->HasFlag(wxPG_PROP_BEING_DELETED) )
3901 prevFirstSel = NULL;
3902
3903 // Always send event, as this is indirect call
3904 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE);
3905
3906 /*
3907 if ( prevFirstSel )
3908 wxPrintf( "Selected %s\n", prevFirstSel->GetClassInfo()->GetClassName() );
3909 else
3910 wxPrintf( "None selected\n" );
3911
3912 if (p)
3913 wxPrintf( "P = %s\n", p->GetClassInfo()->GetClassName() );
3914 else
3915 wxPrintf( "P = NULL\n" );
3916 */
3917
3918 // If we are frozen, then just set the values.
3919 if ( m_frozen )
3920 {
3921 m_iFlags &= ~(wxPG_FL_ABNORMAL_EDITOR);
3922 m_editorFocused = 0;
3923 m_pState->DoSetSelection(p);
3924
3925 // If frozen, always free controls. But don't worry, as Thaw will
3926 // recall SelectProperty to recreate them.
3927 FreeEditors();
3928
3929 // Prevent any further selection measures in this call
3930 p = NULL;
3931 }
3932 else
3933 {
3934 // Is it the same?
3935 if ( prevFirstSel == p &&
3936 prevSelection.size() <= 1 &&
3937 !(flags & wxPG_SEL_FORCE) )
3938 {
3939 // Only set focus if not deselecting
3940 if ( p )
3941 {
3942 if ( flags & wxPG_SEL_FOCUS )
3943 {
3944 if ( m_wndEditor )
3945 {
3946 m_wndEditor->SetFocus();
3947 m_editorFocused = 1;
3948 }
3949 }
3950 else
3951 {
3952 SetFocusOnCanvas();
3953 }
3954 }
3955
3956 m_inDoSelectProperty = 0;
3957 return true;
3958 }
3959
3960 //
3961 // First, deactivate previous
3962 if ( prevFirstSel )
3963 {
3964 OnValidationFailureReset(prevFirstSel);
3965
3966 // Must double-check if this is an selected in case of forceswitch
3967 if ( p != prevFirstSel )
3968 {
3969 if ( !CommitChangesFromEditor(flags) )
3970 {
3971 // Validation has failed, so we can't exit the previous editor
3972 //::wxMessageBox(_("Please correct the value or press ESC to cancel the edit."),
3973 // _("Invalid Value"),wxOK|wxICON_ERROR);
3974 m_inDoSelectProperty = 0;
3975 return false;
3976 }
3977 }
3978
3979 FreeEditors();
3980
3981 m_iFlags &= ~(wxPG_FL_ABNORMAL_EDITOR);
3982 EditorsValueWasNotModified();
3983 }
3984
3985 SetInternalFlag(wxPG_FL_IN_SELECT_PROPERTY);
3986
3987 m_pState->DoSetSelection(p);
3988
3989 // Redraw unselected
3990 for ( unsigned int i=0; i<prevSelection.size(); i++ )
3991 {
3992 DrawItem(prevSelection[i]);
3993 }
3994
3995 //
3996 // Then, activate the one given.
3997 if ( p )
3998 {
3999 int propY = p->GetY2(m_lineHeight);
4000
4001 int splitterX = GetSplitterPosition();
4002 m_editorFocused = 0;
4003 m_iFlags |= wxPG_FL_PRIMARY_FILLS_ENTIRE;
4004 if ( p != prevFirstSel )
4005 m_iFlags &= ~(wxPG_FL_VALIDATION_FAILED);
4006
4007 wxASSERT( m_wndEditor == NULL );
4008
4009 //
4010 // Only create editor for non-disabled non-caption
4011 if ( !p->IsCategory() && !(p->m_flags & wxPG_PROP_DISABLED) )
4012 {
4013 // do this for non-caption items
4014
4015 m_selColumn = 1;
4016
4017 // Do we need to paint the custom image, if any?
4018 m_iFlags &= ~(wxPG_FL_CUR_USES_CUSTOM_IMAGE);
4019 if ( (p->m_flags & wxPG_PROP_CUSTOMIMAGE) &&
4020 !p->GetEditorClass()->CanContainCustomImage()
4021 )
4022 m_iFlags |= wxPG_FL_CUR_USES_CUSTOM_IMAGE;
4023
4024 wxRect grect = GetEditorWidgetRect(p, m_selColumn);
4025 wxPoint goodPos = grect.GetPosition();
4026
4027 // Editor appearance can now be considered clear
4028 m_editorAppearance.SetEmptyData();
4029
4030 const wxPGEditor* editor = p->GetEditorClass();
4031 wxCHECK_MSG(editor, false,
4032 wxT("NULL editor class not allowed"));
4033
4034 m_iFlags &= ~wxPG_FL_FIXED_WIDTH_EDITOR;
4035
4036 wxPGWindowList wndList =
4037 editor->CreateControls(this,
4038 p,
4039 goodPos,
4040 grect.GetSize());
4041
4042 m_wndEditor = wndList.m_primary;
4043 m_wndEditor2 = wndList.m_secondary;
4044 wxWindow* primaryCtrl = GetEditorControl();
4045
4046 //
4047 // Essentially, primaryCtrl == m_wndEditor
4048 //
4049
4050 // NOTE: It is allowed for m_wndEditor to be NULL - in this
4051 // case value is drawn as normal, and m_wndEditor2 is
4052 // assumed to be a right-aligned button that triggers
4053 // a separate editorCtrl window.
4054
4055 if ( m_wndEditor )
4056 {
4057 wxASSERT_MSG( m_wndEditor->GetParent() == GetPanel(),
4058 "CreateControls must use result of "
4059 "wxPropertyGrid::GetPanel() as parent "
4060 "of controls." );
4061
4062 // Set validator, if any
4063 #if wxUSE_VALIDATORS
4064 wxValidator* validator = p->GetValidator();
4065 if ( validator )
4066 primaryCtrl->SetValidator(*validator);
4067 #endif
4068
4069 if ( m_wndEditor->GetSize().y > (m_lineHeight+6) )
4070 m_iFlags |= wxPG_FL_ABNORMAL_EDITOR;
4071
4072 // If it has modified status, use bold font
4073 // (must be done before capturing m_ctrlXAdjust)
4074 if ( (p->m_flags & wxPG_PROP_MODIFIED) &&
4075 (m_windowStyle & wxPG_BOLD_MODIFIED) )
4076 SetCurControlBoldFont();
4077
4078 // Store x relative to splitter (we'll need it).
4079 m_ctrlXAdjust = m_wndEditor->GetPosition().x - splitterX;
4080
4081 // Check if background clear is not necessary
4082 wxPoint pos = m_wndEditor->GetPosition();
4083 if ( pos.x > (splitterX+1) || pos.y > propY )
4084 {
4085 m_iFlags &= ~(wxPG_FL_PRIMARY_FILLS_ENTIRE);
4086 }
4087
4088 m_wndEditor->SetSizeHints(3, 3);
4089
4090 SetupChildEventHandling(primaryCtrl);
4091
4092 // Focus and select all (wxTextCtrl, wxComboBox etc)
4093 if ( flags & wxPG_SEL_FOCUS )
4094 {
4095 primaryCtrl->SetFocus();
4096
4097 p->GetEditorClass()->OnFocus(p, primaryCtrl);
4098 }
4099 else
4100 {
4101 if ( p->IsValueUnspecified() )
4102 SetEditorAppearance(m_unspecifiedAppearance,
4103 true);
4104 }
4105 }
4106
4107 if ( m_wndEditor2 )
4108 {
4109 wxASSERT_MSG( m_wndEditor2->GetParent() == GetPanel(),
4110 "CreateControls must use result of "
4111 "wxPropertyGrid::GetPanel() as parent "
4112 "of controls." );
4113
4114 // Get proper id for wndSecondary
4115 m_wndSecId = m_wndEditor2->GetId();
4116 wxWindowList children = m_wndEditor2->GetChildren();
4117 wxWindowList::iterator node = children.begin();
4118 if ( node != children.end() )
4119 m_wndSecId = ((wxWindow*)*node)->GetId();
4120
4121 m_wndEditor2->SetSizeHints(3,3);
4122
4123 m_wndEditor2->Show();
4124
4125 SetupChildEventHandling(m_wndEditor2);
4126
4127 // If no primary editor, focus to button to allow
4128 // it to interprete ENTER etc.
4129 // NOTE: Due to problems focusing away from it, this
4130 // has been disabled.
4131 /*
4132 if ( (flags & wxPG_SEL_FOCUS) && !m_wndEditor )
4133 m_wndEditor2->SetFocus();
4134 */
4135 }
4136
4137 if ( flags & wxPG_SEL_FOCUS )
4138 m_editorFocused = 1;
4139
4140 }
4141 else
4142 {
4143 // Make sure focus is in grid canvas (important for wxGTK,
4144 // at least)
4145 SetFocusOnCanvas();
4146 }
4147
4148 EditorsValueWasNotModified();
4149
4150 // If it's inside collapsed section, expand parent, scroll, etc.
4151 // Also, if it was partially visible, scroll it into view.
4152 if ( !(flags & wxPG_SEL_NONVISIBLE) )
4153 EnsureVisible( p );
4154
4155 if ( m_wndEditor )
4156 {
4157 m_wndEditor->Show(true);
4158 }
4159
4160 if ( !(flags & wxPG_SEL_NO_REFRESH) )
4161 DrawItem(p);
4162 }
4163 else
4164 {
4165 // Make sure focus is in grid canvas
4166 SetFocusOnCanvas();
4167 }
4168
4169 ClearInternalFlag(wxPG_FL_IN_SELECT_PROPERTY);
4170 }
4171
4172 #if wxUSE_STATUSBAR
4173
4174 //
4175 // Show help text in status bar.
4176 // (if found and grid not embedded in manager with help box and
4177 // style wxPG_EX_HELP_AS_TOOLTIPS is not used).
4178 //
4179
4180 if ( !(GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS) )
4181 {
4182 wxStatusBar* statusbar = NULL;
4183 if ( !(m_iFlags & wxPG_FL_NOSTATUSBARHELP) )
4184 {
4185 wxFrame* frame = wxDynamicCast(::wxGetTopLevelParent(this),wxFrame);
4186 if ( frame )
4187 statusbar = frame->GetStatusBar();
4188 }
4189
4190 if ( statusbar )
4191 {
4192 const wxString* pHelpString = (const wxString*) NULL;
4193
4194 if ( p )
4195 {
4196 pHelpString = &p->GetHelpString();
4197 if ( pHelpString->length() )
4198 {
4199 // Set help box text.
4200 statusbar->SetStatusText( *pHelpString );
4201 m_iFlags |= wxPG_FL_STRING_IN_STATUSBAR;
4202 }
4203 }
4204
4205 if ( (!pHelpString || !pHelpString->length()) &&
4206 (m_iFlags & wxPG_FL_STRING_IN_STATUSBAR) )
4207 {
4208 // Clear help box - but only if it was written
4209 // by us at previous time.
4210 statusbar->SetStatusText( m_emptyString );
4211 m_iFlags &= ~(wxPG_FL_STRING_IN_STATUSBAR);
4212 }
4213 }
4214 }
4215 #endif
4216
4217 m_inDoSelectProperty = 0;
4218
4219 // call wx event handler (here so that it also occurs on deselection)
4220 if ( !(flags & wxPG_SEL_DONT_SEND_EVENT) )
4221 SendEvent( wxEVT_PG_SELECTED, p, NULL );
4222
4223 return true;
4224 }
4225
4226 // -----------------------------------------------------------------------
4227
4228 bool wxPropertyGrid::UnfocusEditor()
4229 {
4230 wxPGProperty* selected = GetSelection();
4231
4232 if ( !selected || !m_wndEditor || m_frozen )
4233 return true;
4234
4235 if ( !CommitChangesFromEditor(0) )
4236 return false;
4237
4238 SetFocusOnCanvas();
4239 DrawItem(selected);
4240
4241 return true;
4242 }
4243
4244 // -----------------------------------------------------------------------
4245
4246 void wxPropertyGrid::RefreshEditor()
4247 {
4248 wxPGProperty* p = GetSelection();
4249 if ( !p )
4250 return;
4251
4252 wxWindow* wnd = GetEditorControl();
4253 if ( !wnd )
4254 return;
4255
4256 // Set editor font boldness - must do this before
4257 // calling UpdateControl().
4258 if ( HasFlag(wxPG_BOLD_MODIFIED) )
4259 {
4260 if ( p->HasFlag(wxPG_PROP_MODIFIED) )
4261 wnd->SetFont(GetCaptionFont());
4262 else
4263 wnd->SetFont(GetFont());
4264 }
4265
4266 const wxPGEditor* editorClass = p->GetEditorClass();
4267
4268 editorClass->UpdateControl(p, wnd);
4269
4270 if ( p->IsValueUnspecified() )
4271 SetEditorAppearance(m_unspecifiedAppearance, true);
4272 }
4273
4274 // -----------------------------------------------------------------------
4275
4276 bool wxPropertyGrid::SelectProperty( wxPGPropArg id, bool focus )
4277 {
4278 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
4279
4280 int flags = wxPG_SEL_DONT_SEND_EVENT;
4281 if ( focus )
4282 flags |= wxPG_SEL_FOCUS;
4283
4284 return DoSelectProperty(p, flags);
4285 }
4286
4287 // -----------------------------------------------------------------------
4288 // wxPropertyGrid expand/collapse state
4289 // -----------------------------------------------------------------------
4290
4291 bool wxPropertyGrid::DoCollapse( wxPGProperty* p, bool sendEvents )
4292 {
4293 wxPGProperty* pwc = wxStaticCast(p, wxPGProperty);
4294 wxPGProperty* selected = GetSelection();
4295
4296 // If active editor was inside collapsed section, then disable it
4297 if ( selected && selected->IsSomeParent(p) )
4298 {
4299 DoClearSelection();
4300 }
4301
4302 // Store dont-center-splitter flag 'cause we need to temporarily set it
4303 bool prevDontCenterSplitter = m_pState->m_dontCenterSplitter;
4304 m_pState->m_dontCenterSplitter = true;
4305
4306 bool res = m_pState->DoCollapse(pwc);
4307
4308 if ( res )
4309 {
4310 if ( sendEvents )
4311 SendEvent( wxEVT_PG_ITEM_COLLAPSED, p );
4312
4313 RecalculateVirtualSize();
4314 Refresh();
4315 }
4316
4317 m_pState->m_dontCenterSplitter = prevDontCenterSplitter;
4318
4319 return res;
4320 }
4321
4322 // -----------------------------------------------------------------------
4323
4324 bool wxPropertyGrid::DoExpand( wxPGProperty* p, bool sendEvents )
4325 {
4326 wxCHECK_MSG( p, false, wxT("invalid property id") );
4327
4328 wxPGProperty* pwc = (wxPGProperty*)p;
4329
4330 // Store dont-center-splitter flag 'cause we need to temporarily set it
4331 bool prevDontCenterSplitter = m_pState->m_dontCenterSplitter;
4332 m_pState->m_dontCenterSplitter = true;
4333
4334 bool res = m_pState->DoExpand(pwc);
4335
4336 if ( res )
4337 {
4338 if ( sendEvents )
4339 SendEvent( wxEVT_PG_ITEM_EXPANDED, p );
4340
4341 RecalculateVirtualSize();
4342 Refresh();
4343 }
4344
4345 m_pState->m_dontCenterSplitter = prevDontCenterSplitter;
4346
4347 return res;
4348 }
4349
4350 // -----------------------------------------------------------------------
4351
4352 bool wxPropertyGrid::DoHideProperty( wxPGProperty* p, bool hide, int flags )
4353 {
4354 if ( m_frozen )
4355 return m_pState->DoHideProperty(p, hide, flags);
4356
4357 wxArrayPGProperty selection = m_pState->m_selection; // Must use a copy
4358 int selRemoveCount = 0;
4359 for ( unsigned int i=0; i<selection.size(); i++ )
4360 {
4361 wxPGProperty* selected = selection[i];
4362 if ( selected == p || selected->IsSomeParent(p) )
4363 {
4364 if ( !DoRemoveFromSelection(p, flags) )
4365 return false;
4366 selRemoveCount += 1;
4367 }
4368 }
4369
4370 m_pState->DoHideProperty(p, hide, flags);
4371
4372 RecalculateVirtualSize();
4373 Refresh();
4374
4375 return true;
4376 }
4377
4378
4379 // -----------------------------------------------------------------------
4380 // wxPropertyGrid size related methods
4381 // -----------------------------------------------------------------------
4382
4383 void wxPropertyGrid::RecalculateVirtualSize( int forceXPos )
4384 {
4385 // Don't check for !HasInternalFlag(wxPG_FL_INITIALIZED) here. Otherwise
4386 // virtual size calculation may go wrong.
4387 if ( HasInternalFlag(wxPG_FL_RECALCULATING_VIRTUAL_SIZE) ||
4388 m_frozen ||
4389 !m_pState )
4390 return;
4391
4392 //
4393 // If virtual height was changed, then recalculate editor control position(s)
4394 if ( m_pState->m_vhCalcPending )
4395 CorrectEditorWidgetPosY();
4396
4397 m_pState->EnsureVirtualHeight();
4398
4399 wxASSERT_LEVEL_2_MSG(
4400 m_pState->GetVirtualHeight() == m_pState->GetActualVirtualHeight(),
4401 "VirtualHeight and ActualVirtualHeight should match"
4402 );
4403
4404 m_iFlags |= wxPG_FL_RECALCULATING_VIRTUAL_SIZE;
4405
4406 int x = m_pState->m_width;
4407 int y = m_pState->m_virtualHeight;
4408
4409 int width, height;
4410 GetClientSize(&width,&height);
4411
4412 // Now adjust virtual size.
4413 SetVirtualSize(x, y);
4414
4415 int xAmount = 0;
4416 int xPos = 0;
4417
4418 //
4419 // Adjust scrollbars
4420 if ( HasVirtualWidth() )
4421 {
4422 xAmount = x/wxPG_PIXELS_PER_UNIT;
4423 xPos = GetScrollPos( wxHORIZONTAL );
4424 }
4425
4426 if ( forceXPos != -1 )
4427 xPos = forceXPos;
4428 // xPos too high?
4429 else if ( xPos > (xAmount-(width/wxPG_PIXELS_PER_UNIT)) )
4430 xPos = 0;
4431
4432 int yAmount = y / wxPG_PIXELS_PER_UNIT;
4433 int yPos = GetScrollPos( wxVERTICAL );
4434
4435 SetScrollbars( wxPG_PIXELS_PER_UNIT, wxPG_PIXELS_PER_UNIT,
4436 xAmount, yAmount, xPos, yPos, true );
4437
4438 // Must re-get size now
4439 GetClientSize(&width,&height);
4440
4441 if ( !HasVirtualWidth() )
4442 {
4443 m_pState->SetVirtualWidth(width);
4444 x = width;
4445 }
4446
4447 m_width = width;
4448 m_height = height;
4449
4450 m_pState->CheckColumnWidths();
4451
4452 if ( GetSelection() )
4453 CorrectEditorWidgetSizeX();
4454
4455 m_iFlags &= ~wxPG_FL_RECALCULATING_VIRTUAL_SIZE;
4456 }
4457
4458 // -----------------------------------------------------------------------
4459
4460 void wxPropertyGrid::OnResize( wxSizeEvent& event )
4461 {
4462 if ( !(m_iFlags & wxPG_FL_INITIALIZED) )
4463 return;
4464
4465 int width, height;
4466 GetClientSize(&width, &height);
4467
4468 m_width = width;
4469 m_height = height;
4470
4471 #if wxPG_DOUBLE_BUFFER
4472 if ( !(GetExtraStyle() & wxPG_EX_NATIVE_DOUBLE_BUFFERING) )
4473 {
4474 int dblh = (m_lineHeight*2);
4475 if ( !m_doubleBuffer )
4476 {
4477 // Create double buffer bitmap to draw on, if none
4478 int w = (width>250)?width:250;
4479 int h = height + dblh;
4480 h = (h>400)?h:400;
4481 m_doubleBuffer = new wxBitmap( w, h );
4482 }
4483 else
4484 {
4485 int w = m_doubleBuffer->GetWidth();
4486 int h = m_doubleBuffer->GetHeight();
4487
4488 // Double buffer must be large enough
4489 if ( w < width || h < (height+dblh) )
4490 {
4491 if ( w < width ) w = width;
4492 if ( h < (height+dblh) ) h = height + dblh;
4493 delete m_doubleBuffer;
4494 m_doubleBuffer = new wxBitmap( w, h );
4495 }
4496 }
4497 }
4498
4499 #endif
4500
4501 m_pState->OnClientWidthChange( width, event.GetSize().x - m_ncWidth, true );
4502 m_ncWidth = event.GetSize().x;
4503
4504 if ( !m_frozen )
4505 {
4506 if ( m_pState->m_itemsAdded )
4507 PrepareAfterItemsAdded();
4508 else
4509 // Without this, virtual size (atleast under wxGTK) will be skewed
4510 RecalculateVirtualSize();
4511
4512 Refresh();
4513 }
4514 }
4515
4516 // -----------------------------------------------------------------------
4517
4518 void wxPropertyGrid::SetVirtualWidth( int width )
4519 {
4520 if ( width == -1 )
4521 {
4522 // Disable virtual width
4523 width = GetClientSize().x;
4524 ClearInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH);
4525 }
4526 else
4527 {
4528 // Enable virtual width
4529 SetInternalFlag(wxPG_FL_HAS_VIRTUAL_WIDTH);
4530 }
4531 m_pState->SetVirtualWidth( width );
4532 }
4533
4534 void wxPropertyGrid::SetFocusOnCanvas()
4535 {
4536 SetFocusIgnoringChildren();
4537 m_editorFocused = 0;
4538 }
4539
4540 // -----------------------------------------------------------------------
4541 // wxPropertyGrid mouse event handling
4542 // -----------------------------------------------------------------------
4543
4544 // selFlags uses same values DoSelectProperty's flags
4545 // Returns true if event was vetoed.
4546 bool wxPropertyGrid::SendEvent( int eventType, wxPGProperty* p,
4547 wxVariant* pValue,
4548 unsigned int selFlags,
4549 unsigned int column )
4550 {
4551 // selFlags should have wxPG_SEL_NOVALIDATE if event is not
4552 // vetoable.
4553
4554 // Send property grid event of specific type and with specific property
4555 wxPropertyGridEvent evt( eventType, m_eventObject->GetId() );
4556 evt.SetPropertyGrid(this);
4557 evt.SetEventObject(m_eventObject);
4558 evt.SetProperty(p);
4559 evt.SetColumn(column);
4560 if ( eventType == wxEVT_PG_CHANGING )
4561 {
4562 wxASSERT( pValue );
4563 evt.SetCanVeto(true);
4564 m_validationInfo.m_pValue = pValue;
4565 evt.SetupValidationInfo();
4566 }
4567 else
4568 {
4569 if ( p )
4570 evt.SetPropertyValue(p->GetValue());
4571
4572 if ( !(selFlags & wxPG_SEL_NOVALIDATE) )
4573 evt.SetCanVeto(true);
4574 }
4575
4576 wxPropertyGridEvent* prevProcessedEvent = m_processedEvent;
4577 m_processedEvent = &evt;
4578 m_eventObject->HandleWindowEvent(evt);
4579 m_processedEvent = prevProcessedEvent;
4580
4581 return evt.WasVetoed();
4582 }
4583
4584 // -----------------------------------------------------------------------
4585
4586 // Return false if should be skipped
4587 bool wxPropertyGrid::HandleMouseClick( int x, unsigned int y, wxMouseEvent &event )
4588 {
4589 bool res = true;
4590
4591 // Need to set focus?
4592 if ( !(m_iFlags & wxPG_FL_FOCUSED) )
4593 {
4594 SetFocusOnCanvas();
4595 }
4596
4597 wxPropertyGridPageState* state = m_pState;
4598 int splitterHit;
4599 int splitterHitOffset;
4600 int columnHit = state->HitTestH( x, &splitterHit, &splitterHitOffset );
4601
4602 wxPGProperty* p = DoGetItemAtY(y);
4603
4604 if ( p )
4605 {
4606 int depth = (int)p->GetDepth() - 1;
4607
4608 int marginEnds = m_marginWidth + ( depth * m_subgroup_extramargin );
4609
4610 if ( x >= marginEnds )
4611 {
4612 // Outside margin.
4613
4614 if ( p->IsCategory() )
4615 {
4616 // This is category.
4617 wxPropertyCategory* pwc = (wxPropertyCategory*)p;
4618
4619 int textX = m_marginWidth + ((unsigned int)((pwc->m_depth-1)*m_subgroup_extramargin));
4620
4621 // Expand, collapse, activate etc. if click on text or left of splitter.
4622 if ( x >= textX
4623 &&
4624 ( x < (textX+pwc->GetTextExtent(this, m_captionFont)+(wxPG_CAPRECTXMARGIN*2)) ||
4625 columnHit == 0
4626 )
4627 )
4628 {
4629 if ( !AddToSelectionFromInputEvent( p,
4630 columnHit,
4631 &event ) )
4632 return res;
4633
4634 // On double-click, expand/collapse.
4635 if ( event.ButtonDClick() && !(m_windowStyle & wxPG_HIDE_MARGIN) )
4636 {
4637 if ( pwc->IsExpanded() ) DoCollapse( p, true );
4638 else DoExpand( p, true );
4639 }
4640 }
4641 }
4642 else if ( splitterHit == -1 )
4643 {
4644 // Click on value.
4645 unsigned int selFlag = 0;
4646 if ( columnHit == 1 )
4647 {
4648 m_iFlags |= wxPG_FL_ACTIVATION_BY_CLICK;
4649 selFlag = wxPG_SEL_FOCUS;
4650 }
4651 if ( !AddToSelectionFromInputEvent( p,
4652 columnHit,
4653 &event,
4654 selFlag ) )
4655 return res;
4656
4657 m_iFlags &= ~(wxPG_FL_ACTIVATION_BY_CLICK);
4658
4659 if ( p->GetChildCount() && !p->IsCategory() )
4660 // On double-click, expand/collapse.
4661 if ( event.ButtonDClick() && !(m_windowStyle & wxPG_HIDE_MARGIN) )
4662 {
4663 wxPGProperty* pwc = (wxPGProperty*)p;
4664 if ( pwc->IsExpanded() ) DoCollapse( p, true );
4665 else DoExpand( p, true );
4666 }
4667
4668 res = false;
4669 }
4670 else
4671 {
4672 // click on splitter
4673 if ( !(m_windowStyle & wxPG_STATIC_SPLITTER) )
4674 {
4675 if ( event.GetEventType() == wxEVT_LEFT_DCLICK )
4676 {
4677 // Double-clicking the splitter causes auto-centering
4678 if ( m_pState->GetColumnCount() <= 2 )
4679 {
4680 ResetColumnSizes( true );
4681
4682 SendEvent(wxEVT_PG_COL_DRAGGING,
4683 m_propHover,
4684 NULL,
4685 wxPG_SEL_NOVALIDATE,
4686 (unsigned int)m_draggedSplitter);
4687 }
4688 }
4689 else if ( m_dragStatus == 0 )
4690 {
4691 //
4692 // Begin draggin the splitter
4693 //
4694
4695 // send event
4696 DoEndLabelEdit(true, wxPG_SEL_NOVALIDATE);
4697
4698 // Allow application to veto dragging
4699 if ( !SendEvent(wxEVT_PG_COL_BEGIN_DRAG,
4700 p, NULL, 0,
4701 (unsigned int)splitterHit) )
4702 {
4703 if ( m_wndEditor )
4704 {
4705 // Changes must be committed here or the
4706 // value won't be drawn correctly
4707 if ( !CommitChangesFromEditor() )
4708 return res;
4709
4710 m_wndEditor->Show ( false );
4711 }
4712
4713 if ( !(m_iFlags & wxPG_FL_MOUSE_CAPTURED) )
4714 {
4715 CaptureMouse();
4716 m_iFlags |= wxPG_FL_MOUSE_CAPTURED;
4717 }
4718
4719 m_dragStatus = 1;
4720 m_draggedSplitter = splitterHit;
4721 m_dragOffset = splitterHitOffset;
4722
4723 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
4724 // Fixes button disappearance bug
4725 if ( m_wndEditor2 )
4726 m_wndEditor2->Show ( false );
4727 #endif
4728
4729 m_startingSplitterX = x - splitterHitOffset;
4730 }
4731 }
4732 }
4733 }
4734 }
4735 else
4736 {
4737 // Click on margin.
4738 if ( p->GetChildCount() )
4739 {
4740 int nx = x + m_marginWidth - marginEnds; // Normalize x.
4741
4742 // Fine tune cell button x
4743 if ( !p->IsCategory() )
4744 nx -= IN_CELL_EXPANDER_BUTTON_X_ADJUST;
4745
4746 if ( (nx >= m_gutterWidth && nx < (m_gutterWidth+m_iconWidth)) )
4747 {
4748 int y2 = y % m_lineHeight;
4749 if ( (y2 >= m_buttonSpacingY && y2 < (m_buttonSpacingY+m_iconHeight)) )
4750 {
4751 // On click on expander button, expand/collapse
4752 if ( ((wxPGProperty*)p)->IsExpanded() )
4753 DoCollapse( p, true );
4754 else
4755 DoExpand( p, true );
4756 }
4757 }
4758 }
4759 }
4760 }
4761 return res;
4762 }
4763
4764 // -----------------------------------------------------------------------
4765
4766 bool wxPropertyGrid::HandleMouseRightClick( int WXUNUSED(x),
4767 unsigned int WXUNUSED(y),
4768 wxMouseEvent& event )
4769 {
4770 if ( m_propHover )
4771 {
4772 // Select property here as well
4773 wxPGProperty* p = m_propHover;
4774 AddToSelectionFromInputEvent(p, m_colHover, &event);
4775
4776 // Send right click event.
4777 SendEvent( wxEVT_PG_RIGHT_CLICK, p );
4778
4779 return true;
4780 }
4781 return false;
4782 }
4783
4784 // -----------------------------------------------------------------------
4785
4786 bool wxPropertyGrid::HandleMouseDoubleClick( int WXUNUSED(x),
4787 unsigned int WXUNUSED(y),
4788 wxMouseEvent& event )
4789 {
4790 if ( m_propHover )
4791 {
4792 // Select property here as well
4793 wxPGProperty* p = m_propHover;
4794
4795 AddToSelectionFromInputEvent(p, m_colHover, &event);
4796
4797 // Send double-click event.
4798 SendEvent( wxEVT_PG_DOUBLE_CLICK, m_propHover );
4799
4800 return true;
4801 }
4802 return false;
4803 }
4804
4805 // -----------------------------------------------------------------------
4806
4807 #if wxPG_SUPPORT_TOOLTIPS
4808
4809 void wxPropertyGrid::SetToolTip( const wxString& tipString )
4810 {
4811 if ( tipString.length() )
4812 {
4813 wxScrolledWindow::SetToolTip(tipString);
4814 }
4815 else
4816 {
4817 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4818 wxScrolledWindow::SetToolTip( m_emptyString );
4819 #else
4820 wxScrolledWindow::SetToolTip( NULL );
4821 #endif
4822 }
4823 }
4824
4825 #endif // #if wxPG_SUPPORT_TOOLTIPS
4826
4827 // -----------------------------------------------------------------------
4828
4829 // Return false if should be skipped
4830 bool wxPropertyGrid::HandleMouseMove( int x, unsigned int y,
4831 wxMouseEvent &event )
4832 {
4833 // Safety check (needed because mouse capturing may
4834 // otherwise freeze the control)
4835 if ( m_dragStatus > 0 && !event.Dragging() )
4836 {
4837 HandleMouseUp(x, y, event);
4838 }
4839
4840 wxPropertyGridPageState* state = m_pState;
4841 int splitterHit;
4842 int splitterHitOffset;
4843 int columnHit = state->HitTestH( x, &splitterHit, &splitterHitOffset );
4844 int splitterX = x - splitterHitOffset;
4845
4846 m_colHover = columnHit;
4847
4848 if ( m_dragStatus > 0 )
4849 {
4850 if ( x > (m_marginWidth + wxPG_DRAG_MARGIN) &&
4851 x < (m_pState->m_width - wxPG_DRAG_MARGIN) )
4852 {
4853
4854 int newSplitterX = x - m_dragOffset;
4855
4856 // Splitter redraw required?
4857 if ( newSplitterX != splitterX )
4858 {
4859 // Move everything
4860 DoSetSplitterPosition(newSplitterX,
4861 m_draggedSplitter,
4862 wxPG_SPLITTER_REFRESH |
4863 wxPG_SPLITTER_FROM_EVENT);
4864
4865 SendEvent(wxEVT_PG_COL_DRAGGING,
4866 m_propHover,
4867 NULL,
4868 wxPG_SEL_NOVALIDATE,
4869 (unsigned int)m_draggedSplitter);
4870 }
4871
4872 m_dragStatus = 2;
4873 }
4874
4875 return false;
4876 }
4877 else
4878 {
4879
4880 int ih = m_lineHeight;
4881 int sy = y;
4882
4883 #if wxPG_SUPPORT_TOOLTIPS
4884 wxPGProperty* prevHover = m_propHover;
4885 unsigned char prevSide = m_mouseSide;
4886 #endif
4887 int curPropHoverY = y - (y % ih);
4888
4889 // On which item it hovers
4890 if ( !m_propHover
4891 ||
4892 ( sy < m_propHoverY || sy >= (m_propHoverY+ih) )
4893 )
4894 {
4895 // Mouse moves on another property
4896
4897 m_propHover = DoGetItemAtY(y);
4898 m_propHoverY = curPropHoverY;
4899
4900 // Send hover event
4901 SendEvent( wxEVT_PG_HIGHLIGHTED, m_propHover );
4902 }
4903
4904 #if wxPG_SUPPORT_TOOLTIPS
4905 // Store which side we are on
4906 m_mouseSide = 0;
4907 if ( columnHit == 1 )
4908 m_mouseSide = 2;
4909 else if ( columnHit == 0 )
4910 m_mouseSide = 1;
4911
4912 //
4913 // If tooltips are enabled, show label or value as a tip
4914 // in case it doesn't otherwise show in full length.
4915 //
4916 if ( m_windowStyle & wxPG_TOOLTIPS )
4917 {
4918 wxToolTip* tooltip = GetToolTip();
4919
4920 if ( m_propHover != prevHover || prevSide != m_mouseSide )
4921 {
4922 if ( m_propHover && !m_propHover->IsCategory() )
4923 {
4924
4925 if ( GetExtraStyle() & wxPG_EX_HELP_AS_TOOLTIPS )
4926 {
4927 // Show help string as a tooltip
4928 wxString tipString = m_propHover->GetHelpString();
4929
4930 SetToolTip(tipString);
4931 }
4932 else
4933 {
4934 // Show cropped value string as a tooltip
4935 wxString tipString;
4936 int space = 0;
4937
4938 if ( m_mouseSide == 1 )
4939 {
4940 tipString = m_propHover->m_label;
4941 space = splitterX-m_marginWidth-3;
4942 }
4943 else if ( m_mouseSide == 2 )
4944 {
4945 tipString = m_propHover->GetDisplayedString();
4946
4947 space = m_width - splitterX;
4948 if ( m_propHover->m_flags & wxPG_PROP_CUSTOMIMAGE )
4949 space -= wxPG_CUSTOM_IMAGE_WIDTH +
4950 wxCC_CUSTOM_IMAGE_MARGIN1 +
4951 wxCC_CUSTOM_IMAGE_MARGIN2;
4952 }
4953
4954 if ( space )
4955 {
4956 int tw, th;
4957 GetTextExtent( tipString, &tw, &th, 0, 0 );
4958 if ( tw > space )
4959 {
4960 SetToolTip( tipString );
4961 }
4962 }
4963 else
4964 {
4965 if ( tooltip )
4966 {
4967 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4968 SetToolTip( m_emptyString );
4969 #else
4970 wxScrolledWindow::SetToolTip( NULL );
4971 #endif
4972 }
4973 }
4974
4975 }
4976 }
4977 else
4978 {
4979 if ( tooltip )
4980 {
4981 #if wxPG_ALLOW_EMPTY_TOOLTIPS
4982 SetToolTip( m_emptyString );
4983 #else
4984 wxScrolledWindow::SetToolTip( NULL );
4985 #endif
4986 }
4987 }
4988 }
4989 }
4990 #endif
4991
4992 if ( splitterHit == -1 ||
4993 !m_propHover ||
4994 HasFlag(wxPG_STATIC_SPLITTER) )
4995 {
4996 // hovering on something else
4997 if ( m_curcursor != wxCURSOR_ARROW )
4998 CustomSetCursor( wxCURSOR_ARROW );
4999 }
5000 else
5001 {
5002 // Do not allow splitter cursor on caption items.
5003 // (also not if we were dragging and its started
5004 // outside the splitter region)
5005
5006 if ( !m_propHover->IsCategory() &&
5007 !event.Dragging() )
5008 {
5009
5010 // hovering on splitter
5011
5012 // NB: Condition disabled since MouseLeave event (from the
5013 // editor control) cannot be reliably detected.
5014 //if ( m_curcursor != wxCURSOR_SIZEWE )
5015 CustomSetCursor( wxCURSOR_SIZEWE, true );
5016
5017 return false;
5018 }
5019 else
5020 {
5021 // hovering on something else
5022 if ( m_curcursor != wxCURSOR_ARROW )
5023 CustomSetCursor( wxCURSOR_ARROW );
5024 }
5025 }
5026
5027 //
5028 // Multi select by dragging
5029 //
5030 if ( (GetExtraStyle() & wxPG_EX_MULTIPLE_SELECTION) &&
5031 event.LeftIsDown() &&
5032 m_propHover &&
5033 GetSelection() &&
5034 columnHit != 1 &&
5035 !state->DoIsPropertySelected(m_propHover) )
5036 {
5037 // Additional requirement is that the hovered property
5038 // is adjacent to edges of selection.
5039 const wxArrayPGProperty& selection = GetSelectedProperties();
5040
5041 // Since categories cannot be selected along with 'other'
5042 // properties, exclude them from iterator flags.
5043 int iterFlags = wxPG_ITERATE_VISIBLE & (~wxPG_PROP_CATEGORY);
5044
5045 for ( int i=(selection.size()-1); i>=0; i-- )
5046 {
5047 // TODO: This could be optimized by keeping track of
5048 // which properties are at the edges of selection.
5049 wxPGProperty* selProp = selection[i];
5050 if ( state->ArePropertiesAdjacent(m_propHover, selProp,
5051 iterFlags) )
5052 {
5053 DoAddToSelection(m_propHover);
5054 break;
5055 }
5056 }
5057 }
5058 }
5059 return true;
5060 }
5061
5062 // -----------------------------------------------------------------------
5063
5064 // Also handles Leaving event
5065 bool wxPropertyGrid::HandleMouseUp( int x, unsigned int WXUNUSED(y),
5066 wxMouseEvent &WXUNUSED(event) )
5067 {
5068 wxPropertyGridPageState* state = m_pState;
5069 bool res = false;
5070
5071 int splitterHit;
5072 int splitterHitOffset;
5073 state->HitTestH( x, &splitterHit, &splitterHitOffset );
5074
5075 // No event type check - basicly calling this method should
5076 // just stop dragging.
5077 // Left up after dragged?
5078 if ( m_dragStatus >= 1 )
5079 {
5080 //
5081 // End Splitter Dragging
5082 //
5083 // DO NOT ENABLE FOLLOWING LINE!
5084 // (it is only here as a reminder to not to do it)
5085 //splitterX = x;
5086
5087 SendEvent(wxEVT_PG_COL_END_DRAG,
5088 m_propHover,
5089 NULL,
5090 wxPG_SEL_NOVALIDATE,
5091 (unsigned int)m_draggedSplitter);
5092
5093 // Disable splitter auto-centering (but only if moved any -
5094 // otherwise we end up disabling auto-center even after a
5095 // recentering double-click).
5096 int posDiff = abs(m_startingSplitterX -
5097 GetSplitterPosition(m_draggedSplitter));
5098
5099 if ( posDiff > 1 )
5100 state->m_dontCenterSplitter = true;
5101
5102 // This is necessary to return cursor
5103 if ( m_iFlags & wxPG_FL_MOUSE_CAPTURED )
5104 {
5105 ReleaseMouse();
5106 m_iFlags &= ~(wxPG_FL_MOUSE_CAPTURED);
5107 }
5108
5109 // Set back the default cursor, if necessary
5110 if ( splitterHit == -1 ||
5111 !m_propHover )
5112 {
5113 CustomSetCursor( wxCURSOR_ARROW );
5114 }
5115
5116 m_dragStatus = 0;
5117
5118 // Control background needs to be cleared
5119 wxPGProperty* selected = GetSelection();
5120 if ( !(m_iFlags & wxPG_FL_PRIMARY_FILLS_ENTIRE) && selected )
5121 DrawItem( selected );
5122
5123 if ( m_wndEditor )
5124 {
5125 m_wndEditor->Show ( true );
5126 }
5127
5128 #if wxPG_REFRESH_CONTROLS_AFTER_REPAINT
5129 // Fixes button disappearance bug
5130 if ( m_wndEditor2 )
5131 m_wndEditor2->Show ( true );
5132 #endif
5133
5134 // This clears the focus.
5135 m_editorFocused = 0;
5136
5137 }
5138 return res;
5139 }
5140
5141 // -----------------------------------------------------------------------
5142
5143 bool wxPropertyGrid::OnMouseCommon( wxMouseEvent& event, int* px, int* py )
5144 {
5145 int splitterX = GetSplitterPosition();
5146
5147 int ux, uy;
5148 CalcUnscrolledPosition( event.m_x, event.m_y, &ux, &uy );
5149
5150 wxWindow* wnd = GetEditorControl();
5151
5152 // Hide popup on clicks
5153 if ( event.GetEventType() != wxEVT_MOTION )
5154 if ( wnd && wnd->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox)) )
5155 {
5156 ((wxOwnerDrawnComboBox*)wnd)->HidePopup();
5157 }
5158
5159 wxRect r;
5160 if ( wnd )
5161 r = wnd->GetRect();
5162 if ( wnd == NULL || m_dragStatus ||
5163 (
5164 ux <= (splitterX + wxPG_SPLITTERX_DETECTMARGIN2) ||
5165 ux >= (r.x+r.width) ||
5166 event.m_y < r.y ||
5167 event.m_y >= (r.y+r.height)
5168 )
5169 )
5170 {
5171 *px = ux;
5172 *py = uy;
5173 return true;
5174 }
5175 else
5176 {
5177 if ( m_curcursor != wxCURSOR_ARROW ) CustomSetCursor ( wxCURSOR_ARROW );
5178 }
5179 return false;
5180 }
5181
5182 // -----------------------------------------------------------------------
5183
5184 void wxPropertyGrid::OnMouseClick( wxMouseEvent &event )
5185 {
5186 int x, y;
5187 if ( OnMouseCommon( event, &x, &y ) )
5188 {
5189 HandleMouseClick(x,y,event);
5190 }
5191 event.Skip();
5192 }
5193
5194 // -----------------------------------------------------------------------
5195
5196 void wxPropertyGrid::OnMouseRightClick( wxMouseEvent &event )
5197 {
5198 int x, y;
5199 CalcUnscrolledPosition( event.m_x, event.m_y, &x, &y );
5200 HandleMouseRightClick(x,y,event);
5201 event.Skip();
5202 }
5203
5204 // -----------------------------------------------------------------------
5205
5206 void wxPropertyGrid::OnMouseDoubleClick( wxMouseEvent &event )
5207 {
5208 // Always run standard mouse-down handler as well
5209 OnMouseClick(event);
5210
5211 int x, y;
5212 CalcUnscrolledPosition( event.m_x, event.m_y, &x, &y );
5213 HandleMouseDoubleClick(x,y,event);
5214 event.Skip();
5215 }
5216
5217 // -----------------------------------------------------------------------
5218
5219 void wxPropertyGrid::OnMouseMove( wxMouseEvent &event )
5220 {
5221 int x, y;
5222 if ( OnMouseCommon( event, &x, &y ) )
5223 {
5224 HandleMouseMove(x,y,event);
5225 }
5226 event.Skip();
5227 }
5228
5229 // -----------------------------------------------------------------------
5230
5231 void wxPropertyGrid::OnMouseUp( wxMouseEvent &event )
5232 {
5233 int x, y;
5234 if ( OnMouseCommon( event, &x, &y ) )
5235 {
5236 HandleMouseUp(x,y,event);
5237 }
5238 event.Skip();
5239 }
5240
5241 // -----------------------------------------------------------------------
5242
5243 void wxPropertyGrid::OnMouseEntry( wxMouseEvent &event )
5244 {
5245 // This may get called from child control as well, so event's
5246 // mouse position cannot be relied on.
5247
5248 if ( event.Entering() )
5249 {
5250 if ( !(m_iFlags & wxPG_FL_MOUSE_INSIDE) )
5251 {
5252 // TODO: Fix this (detect parent and only do
5253 // cursor trick if it is a manager).
5254 wxASSERT( GetParent() );
5255 GetParent()->SetCursor(wxNullCursor);
5256
5257 m_iFlags |= wxPG_FL_MOUSE_INSIDE;
5258 }
5259 else
5260 GetParent()->SetCursor(wxNullCursor);
5261 }
5262 else if ( event.Leaving() )
5263 {
5264 // Without this, wxSpinCtrl editor will sometimes have wrong cursor
5265 SetCursor( wxNullCursor );
5266
5267 // Get real cursor position
5268 wxPoint pt = ScreenToClient(::wxGetMousePosition());
5269
5270 if ( ( pt.x <= 0 || pt.y <= 0 || pt.x >= m_width || pt.y >= m_height ) )
5271 {
5272 {
5273 if ( (m_iFlags & wxPG_FL_MOUSE_INSIDE) )
5274 {
5275 m_iFlags &= ~(wxPG_FL_MOUSE_INSIDE);
5276 }
5277
5278 if ( m_dragStatus )
5279 wxPropertyGrid::HandleMouseUp ( -1, 10000, event );
5280 }
5281 }
5282 }
5283
5284 event.Skip();
5285 }
5286
5287 // -----------------------------------------------------------------------
5288
5289 // Common code used by various OnMouseXXXChild methods.
5290 bool wxPropertyGrid::OnMouseChildCommon( wxMouseEvent &event, int* px, int *py )
5291 {
5292 wxWindow* topCtrlWnd = (wxWindow*)event.GetEventObject();
5293 wxASSERT( topCtrlWnd );
5294 int x, y;
5295 event.GetPosition(&x,&y);
5296
5297 int splitterX = GetSplitterPosition();
5298
5299 wxRect r = topCtrlWnd->GetRect();
5300 if ( !m_dragStatus &&
5301 x > (splitterX-r.x+wxPG_SPLITTERX_DETECTMARGIN2) &&
5302 y >= 0 && y < r.height \
5303 )
5304 {
5305 if ( m_curcursor != wxCURSOR_ARROW ) CustomSetCursor ( wxCURSOR_ARROW );
5306 event.Skip();
5307 }
5308 else
5309 {
5310 CalcUnscrolledPosition( event.m_x + r.x, event.m_y + r.y, \
5311 px, py );
5312 return true;
5313 }
5314 return false;
5315 }
5316
5317 void wxPropertyGrid::OnMouseClickChild( wxMouseEvent &event )
5318 {
5319 int x,y;
5320 if ( OnMouseChildCommon(event,&x,&y) )
5321 {
5322 bool res = HandleMouseClick(x,y,event);
5323 if ( !res ) event.Skip();
5324 }
5325 }
5326
5327 void wxPropertyGrid::OnMouseRightClickChild( wxMouseEvent &event )
5328 {
5329 int x,y;
5330 wxASSERT( m_wndEditor );
5331 // These coords may not be exact (about +-2),
5332 // but that should not matter (right click is about item, not position).
5333 wxPoint pt = m_wndEditor->GetPosition();
5334 CalcUnscrolledPosition( event.m_x + pt.x, event.m_y + pt.y, &x, &y );
5335
5336 // FIXME: Used to set m_propHover to selection here. Was it really
5337 // necessary?
5338
5339 bool res = HandleMouseRightClick(x,y,event);
5340 if ( !res ) event.Skip();
5341 }
5342
5343 void wxPropertyGrid::OnMouseMoveChild( wxMouseEvent &event )
5344 {
5345 int x,y;
5346 if ( OnMouseChildCommon(event,&x,&y) )
5347 {
5348 bool res = HandleMouseMove(x,y,event);
5349 if ( !res ) event.Skip();
5350 }
5351 }
5352
5353 void wxPropertyGrid::OnMouseUpChild( wxMouseEvent &event )
5354 {
5355 int x,y;
5356 if ( OnMouseChildCommon(event,&x,&y) )
5357 {
5358 bool res = HandleMouseUp(x,y,event);
5359 if ( !res ) event.Skip();
5360 }
5361 }
5362
5363 // -----------------------------------------------------------------------
5364 // wxPropertyGrid keyboard event handling
5365 // -----------------------------------------------------------------------
5366
5367 int wxPropertyGrid::KeyEventToActions(wxKeyEvent &event, int* pSecond) const
5368 {
5369 // Translates wxKeyEvent to wxPG_ACTION_XXX
5370
5371 int keycode = event.GetKeyCode();
5372 int modifiers = event.GetModifiers();
5373
5374 wxASSERT( !(modifiers&~(0xFFFF)) );
5375
5376 int hashMapKey = (keycode & 0xFFFF) | ((modifiers & 0xFFFF) << 16);
5377
5378 wxPGHashMapI2I::const_iterator it = m_actionTriggers.find(hashMapKey);
5379
5380 if ( it == m_actionTriggers.end() )
5381 return 0;
5382
5383 if ( pSecond )
5384 {
5385 int second = (it->second>>16) & 0xFFFF;
5386 *pSecond = second;
5387 }
5388
5389 return (it->second & 0xFFFF);
5390 }
5391
5392 void wxPropertyGrid::AddActionTrigger( int action, int keycode, int modifiers )
5393 {
5394 wxASSERT( !(modifiers&~(0xFFFF)) );
5395
5396 int hashMapKey = (keycode & 0xFFFF) | ((modifiers & 0xFFFF) << 16);
5397
5398 wxPGHashMapI2I::iterator it = m_actionTriggers.find(hashMapKey);
5399
5400 if ( it != m_actionTriggers.end() )
5401 {
5402 // This key combination is already used
5403
5404 // Can add secondary?
5405 wxASSERT_MSG( !(it->second&~(0xFFFF)),
5406 wxT("You can only add up to two separate actions per key combination.") );
5407
5408 action = it->second | (action<<16);
5409 }
5410
5411 m_actionTriggers[hashMapKey] = action;
5412 }
5413
5414 void wxPropertyGrid::ClearActionTriggers( int action )
5415 {
5416 wxPGHashMapI2I::iterator it;
5417 bool didSomething;
5418
5419 do
5420 {
5421 didSomething = false;
5422
5423 for ( it = m_actionTriggers.begin();
5424 it != m_actionTriggers.end();
5425 it++ )
5426 {
5427 if ( it->second == action )
5428 {
5429 m_actionTriggers.erase(it);
5430 didSomething = true;
5431 break;
5432 }
5433 }
5434 }
5435 while ( didSomething );
5436 }
5437
5438 void wxPropertyGrid::HandleKeyEvent( wxKeyEvent &event, bool fromChild )
5439 {
5440 //
5441 // Handles key event when editor control is not focused.
5442 //
5443
5444 wxCHECK2(!m_frozen, return);
5445
5446 // Travelsal between items, collapsing/expanding, etc.
5447 wxPGProperty* selected = GetSelection();
5448 int keycode = event.GetKeyCode();
5449 bool editorFocused = IsEditorFocused();
5450
5451 if ( keycode == WXK_TAB )
5452 {
5453 wxWindow* mainControl;
5454
5455 if ( HasInternalFlag(wxPG_FL_IN_MANAGER) )
5456 mainControl = GetParent();
5457 else
5458 mainControl = this;
5459
5460 if ( !event.ShiftDown() )
5461 {
5462 if ( !editorFocused && m_wndEditor )
5463 {
5464 DoSelectProperty( selected, wxPG_SEL_FOCUS );
5465 }
5466 else
5467 {
5468 // Tab traversal workaround for platforms on which
5469 // wxWindow::Navigate() may navigate into first child
5470 // instead of next sibling. Does not work perfectly
5471 // in every scenario (for instance, when property grid
5472 // is either first or last control).
5473 #if defined(__WXGTK__)
5474 wxWindow* sibling = mainControl->GetNextSibling();
5475 if ( sibling )
5476 sibling->SetFocusFromKbd();
5477 #else
5478 Navigate(wxNavigationKeyEvent::IsForward);
5479 #endif
5480 }
5481 }
5482 else
5483 {
5484 if ( editorFocused )
5485 {
5486 UnfocusEditor();
5487 }
5488 else
5489 {
5490 #if defined(__WXGTK__)
5491 wxWindow* sibling = mainControl->GetPrevSibling();
5492 if ( sibling )
5493 sibling->SetFocusFromKbd();
5494 #else
5495 Navigate(wxNavigationKeyEvent::IsBackward);
5496 #endif
5497 }
5498 }
5499
5500 return;
5501 }
5502
5503 // Ignore Alt and Control when they are down alone
5504 if ( keycode == WXK_ALT ||
5505 keycode == WXK_CONTROL )
5506 {
5507 event.Skip();
5508 return;
5509 }
5510
5511 int secondAction;
5512 int action = KeyEventToActions(event, &secondAction);
5513
5514 if ( editorFocused && action == wxPG_ACTION_CANCEL_EDIT )
5515 {
5516 //
5517 // Esc cancels any changes
5518 if ( IsEditorsValueModified() )
5519 {
5520 EditorsValueWasNotModified();
5521
5522 // Update the control as well
5523 selected->GetEditorClass()->
5524 SetControlStringValue( selected,
5525 GetEditorControl(),
5526 selected->GetDisplayedString() );
5527 }
5528
5529 OnValidationFailureReset(selected);
5530
5531 UnfocusEditor();
5532 return;
5533 }
5534
5535 // Except for TAB and ESC, handle child control events in child control
5536 if ( fromChild )
5537 {
5538 // Only propagate event if it had modifiers
5539 if ( !event.HasModifiers() )
5540 {
5541 event.StopPropagation();
5542 }
5543 event.Skip();
5544 return;
5545 }
5546
5547 bool wasHandled = false;
5548
5549 if ( selected )
5550 {
5551 // Show dialog?
5552 if ( ButtonTriggerKeyTest(action, event) )
5553 return;
5554
5555 wxPGProperty* p = selected;
5556
5557 // Travel and expand/collapse
5558 int selectDir = -2;
5559
5560 if ( p->GetChildCount() )
5561 {
5562 if ( action == wxPG_ACTION_COLLAPSE_PROPERTY || secondAction == wxPG_ACTION_COLLAPSE_PROPERTY )
5563 {
5564 if ( (m_windowStyle & wxPG_HIDE_MARGIN) || Collapse(p) )
5565 wasHandled = true;
5566 }
5567 else if ( action == wxPG_ACTION_EXPAND_PROPERTY || secondAction == wxPG_ACTION_EXPAND_PROPERTY )
5568 {
5569 if ( (m_windowStyle & wxPG_HIDE_MARGIN) || Expand(p) )
5570 wasHandled = true;
5571 }
5572 }
5573
5574 if ( !wasHandled )
5575 {
5576 if ( action == wxPG_ACTION_PREV_PROPERTY || secondAction == wxPG_ACTION_PREV_PROPERTY )
5577 {
5578 selectDir = -1;
5579 }
5580 else if ( action == wxPG_ACTION_NEXT_PROPERTY || secondAction == wxPG_ACTION_NEXT_PROPERTY )
5581 {
5582 selectDir = 1;
5583 }
5584 }
5585
5586 if ( selectDir >= -1 )
5587 {
5588 p = wxPropertyGridIterator::OneStep( m_pState, wxPG_ITERATE_VISIBLE, p, selectDir );
5589 if ( p )
5590 DoSelectProperty(p);
5591 wasHandled = true;
5592 }
5593 }
5594 else
5595 {
5596 // If nothing was selected, select the first item now
5597 // (or navigate out of tab).
5598 if ( action != wxPG_ACTION_CANCEL_EDIT && secondAction != wxPG_ACTION_CANCEL_EDIT )
5599 {
5600 wxPGProperty* p = wxPropertyGridInterface::GetFirst();
5601 if ( p ) DoSelectProperty(p);
5602 wasHandled = true;
5603 }
5604 }
5605
5606 if ( !wasHandled )
5607 event.Skip();
5608 }
5609
5610 // -----------------------------------------------------------------------
5611
5612 void wxPropertyGrid::OnKey( wxKeyEvent &event )
5613 {
5614 // If there was editor open and focused, then this event should not
5615 // really be processed here.
5616 if ( IsEditorFocused() )
5617 {
5618 // However, if event had modifiers, it is probably still best
5619 // to skip it.
5620 if ( event.HasModifiers() )
5621 event.Skip();
5622 else
5623 event.StopPropagation();
5624 return;
5625 }
5626
5627 HandleKeyEvent(event, false);
5628 }
5629
5630 // -----------------------------------------------------------------------
5631
5632 bool wxPropertyGrid::ButtonTriggerKeyTest( int action, wxKeyEvent& event )
5633 {
5634 if ( action == -1 )
5635 {
5636 int secondAction;
5637 action = KeyEventToActions(event, &secondAction);
5638 }
5639
5640 // Does the keycode trigger button?
5641 if ( action == wxPG_ACTION_PRESS_BUTTON &&
5642 m_wndEditor2 )
5643 {
5644 wxCommandEvent evt(wxEVT_COMMAND_BUTTON_CLICKED, m_wndEditor2->GetId());
5645 GetEventHandler()->AddPendingEvent(evt);
5646 return true;
5647 }
5648
5649 return false;
5650 }
5651
5652 // -----------------------------------------------------------------------
5653
5654 void wxPropertyGrid::OnChildKeyDown( wxKeyEvent &event )
5655 {
5656 HandleKeyEvent(event, true);
5657 }
5658
5659 // -----------------------------------------------------------------------
5660 // wxPropertyGrid miscellaneous event handling
5661 // -----------------------------------------------------------------------
5662
5663 void wxPropertyGrid::OnIdle( wxIdleEvent& WXUNUSED(event) )
5664 {
5665 //
5666 // Check if the focus is in this control or one of its children
5667 wxWindow* newFocused = wxWindow::FindFocus();
5668
5669 if ( newFocused != m_curFocused )
5670 HandleFocusChange( newFocused );
5671
5672 //
5673 // Check if top-level parent has changed
5674 if ( GetExtraStyle() & wxPG_EX_ENABLE_TLP_TRACKING )
5675 {
5676 wxWindow* tlp = ::wxGetTopLevelParent(this);
5677 if ( tlp != m_tlp )
5678 OnTLPChanging(tlp);
5679 }
5680
5681 //
5682 // Resolve pending property removals
5683 if ( m_deletedProperties.size() > 0 )
5684 {
5685 wxArrayPGProperty& arr = m_deletedProperties;
5686 for ( unsigned int i=0; i<arr.size(); i++ )
5687 {
5688 DeleteProperty(arr[i]);
5689 }
5690 arr.clear();
5691 }
5692 if ( m_removedProperties.size() > 0 )
5693 {
5694 wxArrayPGProperty& arr = m_removedProperties;
5695 for ( unsigned int i=0; i<arr.size(); i++ )
5696 {
5697 RemoveProperty(arr[i]);
5698 }
5699 arr.clear();
5700 }
5701 }
5702
5703 bool wxPropertyGrid::IsEditorFocused() const
5704 {
5705 wxWindow* focus = wxWindow::FindFocus();
5706
5707 if ( focus == m_wndEditor || focus == m_wndEditor2 ||
5708 focus == GetEditorControl() )
5709 return true;
5710
5711 return false;
5712 }
5713
5714 // Called by focus event handlers. newFocused is the window that becomes focused.
5715 void wxPropertyGrid::HandleFocusChange( wxWindow* newFocused )
5716 {
5717 unsigned int oldFlags = m_iFlags;
5718 bool wasEditorFocused = false;
5719 wxWindow* wndEditor = m_wndEditor;
5720
5721 m_iFlags &= ~(wxPG_FL_FOCUSED);
5722
5723 wxWindow* parent = newFocused;
5724
5725 // This must be one of nextFocus' parents.
5726 while ( parent )
5727 {
5728 if ( parent == wndEditor )
5729 {
5730 wasEditorFocused = true;
5731 }
5732 // Use m_eventObject, which is either wxPropertyGrid or
5733 // wxPropertyGridManager, as appropriate.
5734 else if ( parent == m_eventObject )
5735 {
5736 m_iFlags |= wxPG_FL_FOCUSED;
5737 break;
5738 }
5739 parent = parent->GetParent();
5740 }
5741
5742 // Notify editor control when it receives a focus
5743 if ( wasEditorFocused && m_curFocused != newFocused )
5744 {
5745 wxPGProperty* p = GetSelection();
5746 if ( p )
5747 {
5748 const wxPGEditor* editor = p->GetEditorClass();
5749 ResetEditorAppearance();
5750 editor->OnFocus(p, GetEditorControl());
5751 }
5752 }
5753
5754 m_curFocused = newFocused;
5755
5756 if ( (m_iFlags & wxPG_FL_FOCUSED) !=
5757 (oldFlags & wxPG_FL_FOCUSED) )
5758 {
5759 if ( !(m_iFlags & wxPG_FL_FOCUSED) )
5760 {
5761 // Need to store changed value
5762 CommitChangesFromEditor();
5763 }
5764 else
5765 {
5766 /*
5767 //
5768 // Preliminary code for tab-order respecting
5769 // tab-traversal (but should be moved to
5770 // OnNav handler)
5771 //
5772 wxWindow* prevFocus = event.GetWindow();
5773 wxWindow* useThis = this;
5774 if ( m_iFlags & wxPG_FL_IN_MANAGER )
5775 useThis = GetParent();
5776
5777 if ( prevFocus &&
5778 prevFocus->GetParent() == useThis->GetParent() )
5779 {
5780 wxList& children = useThis->GetParent()->GetChildren();
5781
5782 wxNode* node = children.Find(prevFocus);
5783
5784 if ( node->GetNext() &&
5785 useThis == node->GetNext()->GetData() )
5786 DoSelectProperty(GetFirst());
5787 else if ( node->GetPrevious () &&
5788 useThis == node->GetPrevious()->GetData() )
5789 DoSelectProperty(GetLastProperty());
5790
5791 }
5792 */
5793 }
5794
5795 // Redraw selected
5796 wxPGProperty* selected = GetSelection();
5797 if ( selected && (m_iFlags & wxPG_FL_INITIALIZED) )
5798 DrawItem( selected );
5799 }
5800 }
5801
5802 void wxPropertyGrid::OnFocusEvent( wxFocusEvent& event )
5803 {
5804 if ( event.GetEventType() == wxEVT_SET_FOCUS )
5805 HandleFocusChange((wxWindow*)event.GetEventObject());
5806 // Line changed to "else" when applying wxPropertyGrid patch #1675902
5807 //else if ( event.GetWindow() )
5808 else
5809 HandleFocusChange(event.GetWindow());
5810
5811 event.Skip();
5812 }
5813
5814 // -----------------------------------------------------------------------
5815
5816 void wxPropertyGrid::OnChildFocusEvent( wxChildFocusEvent& event )
5817 {
5818 HandleFocusChange((wxWindow*)event.GetEventObject());
5819 event.Skip();
5820 }
5821
5822 // -----------------------------------------------------------------------
5823
5824 void wxPropertyGrid::OnScrollEvent( wxScrollWinEvent &event )
5825 {
5826 m_iFlags |= wxPG_FL_SCROLLED;
5827
5828 event.Skip();
5829 }
5830
5831 // -----------------------------------------------------------------------
5832
5833 void wxPropertyGrid::OnCaptureChange( wxMouseCaptureChangedEvent& WXUNUSED(event) )
5834 {
5835 if ( m_iFlags & wxPG_FL_MOUSE_CAPTURED )
5836 {
5837 m_iFlags &= ~(wxPG_FL_MOUSE_CAPTURED);
5838 }
5839 }
5840
5841 // -----------------------------------------------------------------------
5842 // Property editor related functions
5843 // -----------------------------------------------------------------------
5844
5845 // noDefCheck = true prevents infinite recursion.
5846 wxPGEditor* wxPropertyGrid::DoRegisterEditorClass( wxPGEditor* editorClass,
5847 const wxString& editorName,
5848 bool noDefCheck )
5849 {
5850 wxASSERT( editorClass );
5851
5852 if ( !noDefCheck && wxPGGlobalVars->m_mapEditorClasses.empty() )
5853 RegisterDefaultEditors();
5854
5855 wxString name = editorName;
5856 if ( name.length() == 0 )
5857 name = editorClass->GetName();
5858
5859 // Existing editor under this name?
5860 wxPGHashMapS2P::iterator vt_it = wxPGGlobalVars->m_mapEditorClasses.find(name);
5861
5862 if ( vt_it != wxPGGlobalVars->m_mapEditorClasses.end() )
5863 {
5864 // If this name was already used, try class name.
5865 name = editorClass->GetClassInfo()->GetClassName();
5866 vt_it = wxPGGlobalVars->m_mapEditorClasses.find(name);
5867 }
5868
5869 wxCHECK_MSG( vt_it == wxPGGlobalVars->m_mapEditorClasses.end(),
5870 (wxPGEditor*) vt_it->second,
5871 "Editor with given name was already registered" );
5872
5873 wxPGGlobalVars->m_mapEditorClasses[name] = (void*)editorClass;
5874
5875 return editorClass;
5876 }
5877
5878 // Use this in RegisterDefaultEditors.
5879 #define wxPGRegisterDefaultEditorClass(EDITOR) \
5880 if ( wxPGEditor_##EDITOR == NULL ) \
5881 { \
5882 wxPGEditor_##EDITOR = wxPropertyGrid::RegisterEditorClass( \
5883 new wxPG##EDITOR##Editor, true ); \
5884 }
5885
5886 // Registers all default editor classes
5887 void wxPropertyGrid::RegisterDefaultEditors()
5888 {
5889 wxPGRegisterDefaultEditorClass( TextCtrl );
5890 wxPGRegisterDefaultEditorClass( Choice );
5891 wxPGRegisterDefaultEditorClass( ComboBox );
5892 wxPGRegisterDefaultEditorClass( TextCtrlAndButton );
5893 #if wxPG_INCLUDE_CHECKBOX
5894 wxPGRegisterDefaultEditorClass( CheckBox );
5895 #endif
5896 wxPGRegisterDefaultEditorClass( ChoiceAndButton );
5897
5898 // Register SpinCtrl etc. editors before use
5899 RegisterAdditionalEditors();
5900 }
5901
5902 // -----------------------------------------------------------------------
5903 // wxPGStringTokenizer
5904 // Needed to handle C-style string lists (e.g. "str1" "str2")
5905 // -----------------------------------------------------------------------
5906
5907 wxPGStringTokenizer::wxPGStringTokenizer( const wxString& str, wxChar delimeter )
5908 : m_str(&str), m_curPos(str.begin()), m_delimeter(delimeter)
5909 {
5910 }
5911
5912 wxPGStringTokenizer::~wxPGStringTokenizer()
5913 {
5914 }
5915
5916 bool wxPGStringTokenizer::HasMoreTokens()
5917 {
5918 const wxString& str = *m_str;
5919
5920 wxString::const_iterator i = m_curPos;
5921
5922 wxUniChar delim = m_delimeter;
5923 wxUniChar a;
5924 wxUniChar prev_a = wxT('\0');
5925
5926 bool inToken = false;
5927
5928 while ( i != str.end() )
5929 {
5930 a = *i;
5931
5932 if ( !inToken )
5933 {
5934 if ( a == delim )
5935 {
5936 inToken = true;
5937 m_readyToken.clear();
5938 }
5939 }
5940 else
5941 {
5942 if ( prev_a != wxT('\\') )
5943 {
5944 if ( a != delim )
5945 {
5946 if ( a != wxT('\\') )
5947 m_readyToken << a;
5948 }
5949 else
5950 {
5951 ++i;
5952 m_curPos = i;
5953 return true;
5954 }
5955 prev_a = a;
5956 }
5957 else
5958 {
5959 m_readyToken << a;
5960 prev_a = wxT('\0');
5961 }
5962 }
5963 ++i;
5964 }
5965
5966 m_curPos = str.end();
5967
5968 if ( inToken )
5969 return true;
5970
5971 return false;
5972 }
5973
5974 wxString wxPGStringTokenizer::GetNextToken()
5975 {
5976 return m_readyToken;
5977 }
5978
5979 // -----------------------------------------------------------------------
5980 // wxPGChoiceEntry
5981 // -----------------------------------------------------------------------
5982
5983 wxPGChoiceEntry::wxPGChoiceEntry()
5984 : wxPGCell(), m_value(wxPG_INVALID_VALUE)
5985 {
5986 }
5987
5988 // -----------------------------------------------------------------------
5989 // wxPGChoicesData
5990 // -----------------------------------------------------------------------
5991
5992 wxPGChoicesData::wxPGChoicesData()
5993 {
5994 }
5995
5996 wxPGChoicesData::~wxPGChoicesData()
5997 {
5998 Clear();
5999 }
6000
6001 void wxPGChoicesData::Clear()
6002 {
6003 m_items.clear();
6004 }
6005
6006 void wxPGChoicesData::CopyDataFrom( wxPGChoicesData* data )
6007 {
6008 wxASSERT( m_items.size() == 0 );
6009
6010 m_items = data->m_items;
6011 }
6012
6013 wxPGChoiceEntry& wxPGChoicesData::Insert( int index,
6014 const wxPGChoiceEntry& item )
6015 {
6016 wxVector<wxPGChoiceEntry>::iterator it;
6017 if ( index == -1 )
6018 {
6019 it = m_items.end();
6020 index = (int) m_items.size();
6021 }
6022 else
6023 {
6024 it = m_items.begin() + index;
6025 }
6026
6027 m_items.insert(it, item);
6028
6029 wxPGChoiceEntry& ownEntry = m_items[index];
6030
6031 // Need to fix value?
6032 if ( ownEntry.GetValue() == wxPG_INVALID_VALUE )
6033 ownEntry.SetValue(index);
6034
6035 return ownEntry;
6036 }
6037
6038 // -----------------------------------------------------------------------
6039 // wxPropertyGridEvent
6040 // -----------------------------------------------------------------------
6041
6042 IMPLEMENT_DYNAMIC_CLASS(wxPropertyGridEvent, wxCommandEvent)
6043
6044
6045 wxDEFINE_EVENT( wxEVT_PG_SELECTED, wxPropertyGridEvent );
6046 wxDEFINE_EVENT( wxEVT_PG_CHANGING, wxPropertyGridEvent );
6047 wxDEFINE_EVENT( wxEVT_PG_CHANGED, wxPropertyGridEvent );
6048 wxDEFINE_EVENT( wxEVT_PG_HIGHLIGHTED, wxPropertyGridEvent );
6049 wxDEFINE_EVENT( wxEVT_PG_RIGHT_CLICK, wxPropertyGridEvent );
6050 wxDEFINE_EVENT( wxEVT_PG_PAGE_CHANGED, wxPropertyGridEvent );
6051 wxDEFINE_EVENT( wxEVT_PG_ITEM_EXPANDED, wxPropertyGridEvent );
6052 wxDEFINE_EVENT( wxEVT_PG_ITEM_COLLAPSED, wxPropertyGridEvent );
6053 wxDEFINE_EVENT( wxEVT_PG_DOUBLE_CLICK, wxPropertyGridEvent );
6054 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_BEGIN, wxPropertyGridEvent );
6055 wxDEFINE_EVENT( wxEVT_PG_LABEL_EDIT_ENDING, wxPropertyGridEvent );
6056 wxDEFINE_EVENT( wxEVT_PG_COL_BEGIN_DRAG, wxPropertyGridEvent );
6057 wxDEFINE_EVENT( wxEVT_PG_COL_DRAGGING, wxPropertyGridEvent );
6058 wxDEFINE_EVENT( wxEVT_PG_COL_END_DRAG, wxPropertyGridEvent );
6059
6060 // -----------------------------------------------------------------------
6061
6062 void wxPropertyGridEvent::Init()
6063 {
6064 m_validationInfo = NULL;
6065 m_column = 1;
6066 m_canVeto = false;
6067 m_wasVetoed = false;
6068 }
6069
6070 // -----------------------------------------------------------------------
6071
6072 wxPropertyGridEvent::wxPropertyGridEvent(wxEventType commandType, int id)
6073 : wxCommandEvent(commandType,id)
6074 {
6075 m_property = NULL;
6076 Init();
6077 }
6078
6079 // -----------------------------------------------------------------------
6080
6081 wxPropertyGridEvent::wxPropertyGridEvent(const wxPropertyGridEvent& event)
6082 : wxCommandEvent(event)
6083 {
6084 m_eventType = event.GetEventType();
6085 m_eventObject = event.m_eventObject;
6086 m_pg = event.m_pg;
6087 OnPropertyGridSet();
6088 m_property = event.m_property;
6089 m_validationInfo = event.m_validationInfo;
6090 m_canVeto = event.m_canVeto;
6091 m_wasVetoed = event.m_wasVetoed;
6092 }
6093
6094 // -----------------------------------------------------------------------
6095
6096 void wxPropertyGridEvent::OnPropertyGridSet()
6097 {
6098 if ( !m_pg )
6099 return;
6100
6101 #if wxUSE_THREADS
6102 wxCriticalSectionLocker(wxPGGlobalVars->m_critSect);
6103 #endif
6104 m_pg->m_liveEvents.push_back(this);
6105 }
6106
6107 // -----------------------------------------------------------------------
6108
6109 wxPropertyGridEvent::~wxPropertyGridEvent()
6110 {
6111 if ( m_pg )
6112 {
6113 #if wxUSE_THREADS
6114 wxCriticalSectionLocker(wxPGGlobalVars->m_critSect);
6115 #endif
6116
6117 // Use iterate from the back since it is more likely that the event
6118 // being desroyed is at the end of the array.
6119 wxVector<wxPropertyGridEvent*>& liveEvents = m_pg->m_liveEvents;
6120
6121 for ( int i = liveEvents.size()-1; i >= 0; i-- )
6122 {
6123 if ( liveEvents[i] == this )
6124 {
6125 liveEvents.erase(liveEvents.begin() + i);
6126 break;
6127 }
6128 }
6129 }
6130 }
6131
6132 // -----------------------------------------------------------------------
6133
6134 wxEvent* wxPropertyGridEvent::Clone() const
6135 {
6136 return new wxPropertyGridEvent( *this );
6137 }
6138
6139 // -----------------------------------------------------------------------
6140 // wxPropertyGridPopulator
6141 // -----------------------------------------------------------------------
6142
6143 wxPropertyGridPopulator::wxPropertyGridPopulator()
6144 {
6145 m_state = NULL;
6146 m_pg = NULL;
6147 wxPGGlobalVars->m_offline++;
6148 }
6149
6150 // -----------------------------------------------------------------------
6151
6152 void wxPropertyGridPopulator::SetState( wxPropertyGridPageState* state )
6153 {
6154 m_state = state;
6155 m_propHierarchy.clear();
6156 }
6157
6158 // -----------------------------------------------------------------------
6159
6160 void wxPropertyGridPopulator::SetGrid( wxPropertyGrid* pg )
6161 {
6162 m_pg = pg;
6163 pg->Freeze();
6164 }
6165
6166 // -----------------------------------------------------------------------
6167
6168 wxPropertyGridPopulator::~wxPropertyGridPopulator()
6169 {
6170 //
6171 // Free unused sets of choices
6172 wxPGHashMapS2P::iterator it;
6173
6174 for( it = m_dictIdChoices.begin(); it != m_dictIdChoices.end(); ++it )
6175 {
6176 wxPGChoicesData* data = (wxPGChoicesData*) it->second;
6177 data->DecRef();
6178 }
6179
6180 if ( m_pg )
6181 {
6182 m_pg->Thaw();
6183 m_pg->GetPanel()->Refresh();
6184 }
6185 wxPGGlobalVars->m_offline--;
6186 }
6187
6188 // -----------------------------------------------------------------------
6189
6190 wxPGProperty* wxPropertyGridPopulator::Add( const wxString& propClass,
6191 const wxString& propLabel,
6192 const wxString& propName,
6193 const wxString* propValue,
6194 wxPGChoices* pChoices )
6195 {
6196 wxClassInfo* classInfo = wxClassInfo::FindClass(propClass);
6197 wxPGProperty* parent = GetCurParent();
6198
6199 if ( parent->HasFlag(wxPG_PROP_AGGREGATE) )
6200 {
6201 ProcessError(wxString::Format(wxT("new children cannot be added to '%s'"),parent->GetName().c_str()));
6202 return NULL;
6203 }
6204
6205 if ( !classInfo || !classInfo->IsKindOf(CLASSINFO(wxPGProperty)) )
6206 {
6207 ProcessError(wxString::Format(wxT("'%s' is not valid property class"),propClass.c_str()));
6208 return NULL;
6209 }
6210
6211 wxPGProperty* property = (wxPGProperty*) classInfo->CreateObject();
6212
6213 property->SetLabel(propLabel);
6214 property->DoSetName(propName);
6215
6216 if ( pChoices && pChoices->IsOk() )
6217 property->SetChoices(*pChoices);
6218
6219 m_state->DoInsert(parent, -1, property);
6220
6221 if ( propValue )
6222 property->SetValueFromString( *propValue, wxPG_FULL_VALUE|
6223 wxPG_PROGRAMMATIC_VALUE );
6224
6225 return property;
6226 }
6227
6228 // -----------------------------------------------------------------------
6229
6230 void wxPropertyGridPopulator::AddChildren( wxPGProperty* property )
6231 {
6232 m_propHierarchy.push_back(property);
6233 DoScanForChildren();
6234 m_propHierarchy.pop_back();
6235 }
6236
6237 // -----------------------------------------------------------------------
6238
6239 wxPGChoices wxPropertyGridPopulator::ParseChoices( const wxString& choicesString,
6240 const wxString& idString )
6241 {
6242 wxPGChoices choices;
6243
6244 // Using id?
6245 if ( choicesString[0] == wxT('@') )
6246 {
6247 wxString ids = choicesString.substr(1);
6248 wxPGHashMapS2P::iterator it = m_dictIdChoices.find(ids);
6249 if ( it == m_dictIdChoices.end() )
6250 ProcessError(wxString::Format(wxT("No choices defined for id '%s'"),ids.c_str()));
6251 else
6252 choices.AssignData((wxPGChoicesData*)it->second);
6253 }
6254 else
6255 {
6256 bool found = false;
6257 if ( idString.length() )
6258 {
6259 wxPGHashMapS2P::iterator it = m_dictIdChoices.find(idString);
6260 if ( it != m_dictIdChoices.end() )
6261 {
6262 choices.AssignData((wxPGChoicesData*)it->second);
6263 found = true;
6264 }
6265 }
6266
6267 if ( !found )
6268 {
6269 // Parse choices string
6270 wxString::const_iterator it = choicesString.begin();
6271 wxString label;
6272 wxString value;
6273 int state = 0;
6274 bool labelValid = false;
6275
6276 for ( ; it != choicesString.end(); ++it )
6277 {
6278 wxChar c = *it;
6279
6280 if ( state != 1 )
6281 {
6282 if ( c == wxT('"') )
6283 {
6284 if ( labelValid )
6285 {
6286 long l;
6287 if ( !value.ToLong(&l, 0) ) l = wxPG_INVALID_VALUE;
6288 choices.Add(label, l);
6289 }
6290 labelValid = false;
6291 //wxLogDebug(wxT("%s, %s"),label.c_str(),value.c_str());
6292 value.clear();
6293 label.clear();
6294 state = 1;
6295 }
6296 else if ( c == wxT('=') )
6297 {
6298 if ( labelValid )
6299 {
6300 state = 2;
6301 }
6302 }
6303 else if ( state == 2 && (wxIsalnum(c) || c == wxT('x')) )
6304 {
6305 value << c;
6306 }
6307 }
6308 else
6309 {
6310 if ( c == wxT('"') )
6311 {
6312 state = 0;
6313 labelValid = true;
6314 }
6315 else
6316 label << c;
6317 }
6318 }
6319
6320 if ( labelValid )
6321 {
6322 long l;
6323 if ( !value.ToLong(&l, 0) ) l = wxPG_INVALID_VALUE;
6324 choices.Add(label, l);
6325 }
6326
6327 if ( !choices.IsOk() )
6328 {
6329 choices.EnsureData();
6330 }
6331
6332 // Assign to id
6333 if ( idString.length() )
6334 m_dictIdChoices[idString] = choices.GetData();
6335 }
6336 }
6337
6338 return choices;
6339 }
6340
6341 // -----------------------------------------------------------------------
6342
6343 bool wxPropertyGridPopulator::ToLongPCT( const wxString& s, long* pval, long max )
6344 {
6345 if ( s.Last() == wxT('%') )
6346 {
6347 wxString s2 = s.substr(0,s.length()-1);
6348 long val;
6349 if ( s2.ToLong(&val, 10) )
6350 {
6351 *pval = (val*max)/100;
6352 return true;
6353 }
6354 return false;
6355 }
6356
6357 return s.ToLong(pval, 10);
6358 }
6359
6360 // -----------------------------------------------------------------------
6361
6362 bool wxPropertyGridPopulator::AddAttribute( const wxString& name,
6363 const wxString& type,
6364 const wxString& value )
6365 {
6366 int l = m_propHierarchy.size();
6367 if ( !l )
6368 return false;
6369
6370 wxPGProperty* p = m_propHierarchy[l-1];
6371 wxString valuel = value.Lower();
6372 wxVariant variant;
6373
6374 if ( type.length() == 0 )
6375 {
6376 long v;
6377
6378 // Auto-detect type
6379 if ( valuel == wxT("true") || valuel == wxT("yes") || valuel == wxT("1") )
6380 variant = true;
6381 else if ( valuel == wxT("false") || valuel == wxT("no") || valuel == wxT("0") )
6382 variant = false;
6383 else if ( value.ToLong(&v, 0) )
6384 variant = v;
6385 else
6386 variant = value;
6387 }
6388 else
6389 {
6390 if ( type == wxT("string") )
6391 {
6392 variant = value;
6393 }
6394 else if ( type == wxT("int") )
6395 {
6396 long v = 0;
6397 value.ToLong(&v, 0);
6398 variant = v;
6399 }
6400 else if ( type == wxT("bool") )
6401 {
6402 if ( valuel == wxT("true") || valuel == wxT("yes") || valuel == wxT("1") )
6403 variant = true;
6404 else
6405 variant = false;
6406 }
6407 else
6408 {
6409 ProcessError(wxString::Format(wxT("Invalid attribute type '%s'"),type.c_str()));
6410 return false;
6411 }
6412 }
6413
6414 p->SetAttribute( name, variant );
6415
6416 return true;
6417 }
6418
6419 // -----------------------------------------------------------------------
6420
6421 void wxPropertyGridPopulator::ProcessError( const wxString& msg )
6422 {
6423 wxLogError(_("Error in resource: %s"),msg.c_str());
6424 }
6425
6426 // -----------------------------------------------------------------------
6427
6428 #endif // wxUSE_PROPGRID