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