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