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