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