]> git.saurik.com Git - wxWidgets.git/blame - src/propgrid/property.cpp
applying patch, fixes #10523
[wxWidgets.git] / src / propgrid / property.cpp
CommitLineData
1c4293cb
VZ
1/////////////////////////////////////////////////////////////////////////////
2// Name: src/propgrid/property.cpp
3// Purpose: wxPGProperty and related support classes
4// Author: Jaakko Salli
5// Modified by:
6// Created: 2008-08-23
ea5af9c5 7// RCS-ID: $Id$
1c4293cb
VZ
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
f4bc1aa2
JS
19#if wxUSE_PROPGRID
20
1c4293cb
VZ
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"
1c4293cb
VZ
32 #include "wx/pen.h"
33 #include "wx/brush.h"
1c4293cb 34 #include "wx/settings.h"
1c4293cb 35 #include "wx/intl.h"
1c4293cb
VZ
36#endif
37
3b211af1 38#include "wx/propgrid/propgrid.h"
1c4293cb
VZ
39
40
41#define PWC_CHILD_SUMMARY_LIMIT 16 // Maximum number of children summarized in a parent property's
42 // value field.
43
44#define PWC_CHILD_SUMMARY_CHAR_LIMIT 64 // Character limit of summary field when not editing
45
1425eca5
JS
46#if wxPG_COMPATIBILITY_1_4
47
48// Used to establish backwards compatiblity
49const char* g_invalidStringContent = "@__TOTALLY_INVALID_STRING__@";
50
51#endif
1c4293cb
VZ
52
53// -----------------------------------------------------------------------
54
55static void wxPGDrawFocusRect( wxDC& dc, const wxRect& rect )
56{
57#if defined(__WXMSW__) && !defined(__WXWINCE__)
58 // FIXME: Use DrawFocusRect code above (currently it draws solid line
59 // for caption focus but works ok for other stuff).
60 // Also, it seems that this code may not work in future wx versions.
61 dc.SetLogicalFunction(wxINVERT);
62
63 wxPen pen(*wxBLACK,1,wxDOT);
64 pen.SetCap(wxCAP_BUTT);
65 dc.SetPen(pen);
66 dc.SetBrush(*wxTRANSPARENT_BRUSH);
67
68 dc.DrawRectangle(rect);
69
70 dc.SetLogicalFunction(wxCOPY);
71#else
72 dc.SetLogicalFunction(wxINVERT);
73
74 dc.SetPen(wxPen(*wxBLACK,1,wxDOT));
75 dc.SetBrush(*wxTRANSPARENT_BRUSH);
76
77 dc.DrawRectangle(rect);
78
79 dc.SetLogicalFunction(wxCOPY);
80#endif
81}
82
83// -----------------------------------------------------------------------
84// wxPGCellRenderer
85// -----------------------------------------------------------------------
86
87wxSize wxPGCellRenderer::GetImageSize( const wxPGProperty* WXUNUSED(property),
88 int WXUNUSED(column),
89 int WXUNUSED(item) ) const
90{
91 return wxSize(0, 0);
92}
93
94void wxPGCellRenderer::DrawText( wxDC& dc, const wxRect& rect,
95 int xOffset, const wxString& text ) const
96{
97 if ( xOffset )
98 xOffset += wxCC_CUSTOM_IMAGE_MARGIN1 + wxCC_CUSTOM_IMAGE_MARGIN2;
99 dc.DrawText( text,
100 rect.x+xOffset+wxPG_XBEFORETEXT,
101 rect.y+((rect.height-dc.GetCharHeight())/2) );
102}
103
104void wxPGCellRenderer::DrawEditorValue( wxDC& dc, const wxRect& rect,
105 int xOffset, const wxString& text,
106 wxPGProperty* property,
107 const wxPGEditor* editor ) const
108{
109 if ( xOffset )
110 xOffset += wxCC_CUSTOM_IMAGE_MARGIN1 + wxCC_CUSTOM_IMAGE_MARGIN2;
111
112 int yOffset = ((rect.height-dc.GetCharHeight())/2);
113
114 if ( editor )
115 {
116 wxRect rect2(rect);
117 rect2.x += xOffset;
118 rect2.y += yOffset;
119 rect2.height -= yOffset;
120 editor->DrawValue( dc, rect2, property, text );
121 }
122 else
123 {
124 dc.DrawText( text,
125 rect.x+xOffset+wxPG_XBEFORETEXT,
126 rect.y+yOffset );
127 }
128}
129
130void wxPGCellRenderer::DrawCaptionSelectionRect( wxDC& dc, int x, int y, int w, int h ) const
131{
132 wxRect focusRect(x,y+((h-dc.GetCharHeight())/2),w,h);
133 wxPGDrawFocusRect(dc,focusRect);
134}
135
136int wxPGCellRenderer::PreDrawCell( wxDC& dc, const wxRect& rect, const wxPGCell& cell, int flags ) const
137{
138 int imageOffset = 0;
139
d7e2b522
JS
140 // If possible, use cell colours
141 if ( !(flags & DontUseCellBgCol) )
1c4293cb 142 {
d7e2b522
JS
143 dc.SetPen(cell.GetBgCol());
144 dc.SetBrush(cell.GetBgCol());
145 }
1c4293cb 146
d7e2b522
JS
147 if ( !(flags & DontUseCellFgCol) )
148 {
149 dc.SetTextForeground(cell.GetFgCol());
1c4293cb
VZ
150 }
151
a2851207
JS
152 // Draw Background, but only if not rendering in control
153 // (as control already has rendered correct background).
154 if ( !(flags & (Control|ChoicePopup)) )
155 dc.DrawRectangle(rect);
d7e2b522 156
1c4293cb
VZ
157 const wxBitmap& bmp = cell.GetBitmap();
158 if ( bmp.Ok() &&
d7e2b522
JS
159 // Do not draw oversized bitmap outside choice popup
160 ((flags & ChoicePopup) || bmp.GetHeight() < rect.height )
1c4293cb
VZ
161 )
162 {
163 dc.DrawBitmap( bmp,
164 rect.x + wxPG_CONTROL_MARGIN + wxCC_CUSTOM_IMAGE_MARGIN1,
165 rect.y + wxPG_CUSTOM_IMAGE_SPACINGY,
166 true );
167 imageOffset = bmp.GetWidth();
168 }
169
170 return imageOffset;
171}
172
173// -----------------------------------------------------------------------
174// wxPGDefaultRenderer
175// -----------------------------------------------------------------------
176
177void wxPGDefaultRenderer::Render( wxDC& dc, const wxRect& rect,
178 const wxPropertyGrid* propertyGrid, wxPGProperty* property,
179 int column, int item, int flags ) const
180{
181 bool isUnspecified = property->IsValueUnspecified();
182
183 if ( column == 1 && item == -1 )
184 {
185 int cmnVal = property->GetCommonValue();
186 if ( cmnVal >= 0 )
187 {
188 // Common Value
189 if ( !isUnspecified )
190 DrawText( dc, rect, 0, propertyGrid->GetCommonValueLabel(cmnVal) );
191 return;
192 }
193 }
194
195 const wxPGEditor* editor = NULL;
d7e2b522 196 const wxPGCell* cell = NULL;
1c4293cb
VZ
197
198 wxString text;
199 int imageOffset = 0;
d7e2b522 200 int preDrawFlags = flags;
1c4293cb 201
d7e2b522 202 property->GetDisplayInfo(column, item, flags, &text, &cell);
1c4293cb 203
d7e2b522 204 imageOffset = PreDrawCell( dc, rect, *cell, preDrawFlags );
1c4293cb 205
d7e2b522 206 if ( column == 1 )
1c4293cb
VZ
207 {
208 if ( !isUnspecified )
209 {
210 editor = property->GetColumnEditor(column);
211
212 // Regular property value
213
214 wxSize imageSize = propertyGrid->GetImageSize(property, item);
215
216 wxPGPaintData paintdata;
217 paintdata.m_parent = propertyGrid;
218 paintdata.m_choiceItem = item;
219
220 if ( imageSize.x > 0 )
221 {
222 wxRect imageRect(rect.x + wxPG_CONTROL_MARGIN + wxCC_CUSTOM_IMAGE_MARGIN1,
223 rect.y+wxPG_CUSTOM_IMAGE_SPACINGY,
224 wxPG_CUSTOM_IMAGE_WIDTH,
225 rect.height-(wxPG_CUSTOM_IMAGE_SPACINGY*2));
226
1c4293cb
VZ
227 dc.SetPen( wxPen(propertyGrid->GetCellTextColour(), 1, wxSOLID) );
228
229 paintdata.m_drawnWidth = imageSize.x;
230 paintdata.m_drawnHeight = imageSize.y;
231
b7bc9d80 232 property->OnCustomPaint( dc, imageRect, paintdata );
1c4293cb
VZ
233
234 imageOffset = paintdata.m_drawnWidth;
235 }
236
1425eca5 237 text = property->GetValueAsString();
1c4293cb
VZ
238
239 // Add units string?
240 if ( propertyGrid->GetColumnCount() <= 2 )
241 {
242 wxString unitsString = property->GetAttribute(wxPGGlobalVars->m_strUnits, wxEmptyString);
243 if ( unitsString.length() )
244 text = wxString::Format(wxS("%s %s"), text.c_str(), unitsString.c_str() );
245 }
246 }
247
248 if ( text.length() == 0 )
249 {
250 // Try to show inline help if no text
251 wxVariant vInlineHelp = property->GetAttribute(wxPGGlobalVars->m_strInlineHelp);
252 if ( !vInlineHelp.IsNull() )
253 {
254 text = vInlineHelp.GetString();
255 dc.SetTextForeground(propertyGrid->GetCellDisabledTextColour());
256 }
257 }
258 }
1c4293cb
VZ
259
260 DrawEditorValue( dc, rect, imageOffset, text, property, editor );
261
262 // active caption gets nice dotted rectangle
263 if ( property->IsCategory() /*&& column == 0*/ )
264 {
265 if ( flags & Selected )
266 {
267 if ( imageOffset > 0 )
268 imageOffset += wxCC_CUSTOM_IMAGE_MARGIN2 + 4;
269
270 DrawCaptionSelectionRect( dc,
271 rect.x+wxPG_XBEFORETEXT-wxPG_CAPRECTXMARGIN+imageOffset,
272 rect.y-wxPG_CAPRECTYMARGIN+1,
273 ((wxPropertyCategory*)property)->GetTextExtent(propertyGrid,
274 propertyGrid->GetCaptionFont())
275 +(wxPG_CAPRECTXMARGIN*2),
276 propertyGrid->GetFontHeight()+(wxPG_CAPRECTYMARGIN*2) );
277 }
278 }
279}
280
281wxSize wxPGDefaultRenderer::GetImageSize( const wxPGProperty* property,
282 int column,
283 int item ) const
284{
285 if ( property && column == 1 )
286 {
287 if ( item == -1 )
288 {
289 wxBitmap* bmp = property->GetValueImage();
290
291 if ( bmp && bmp->Ok() )
292 return wxSize(bmp->GetWidth(),bmp->GetHeight());
293 }
294 }
295 return wxSize(0,0);
296}
297
d7e2b522
JS
298// -----------------------------------------------------------------------
299// wxPGCellData
300// -----------------------------------------------------------------------
301
302wxPGCellData::wxPGCellData()
303 : wxObjectRefData()
304{
305 m_hasValidText = false;
306}
307
1c4293cb
VZ
308// -----------------------------------------------------------------------
309// wxPGCell
310// -----------------------------------------------------------------------
311
312wxPGCell::wxPGCell()
d7e2b522 313 : wxObject()
1c4293cb
VZ
314{
315}
316
317wxPGCell::wxPGCell( const wxString& text,
318 const wxBitmap& bitmap,
319 const wxColour& fgCol,
320 const wxColour& bgCol )
d7e2b522
JS
321 : wxObject()
322{
323 wxPGCellData* data = new wxPGCellData();
324 m_refData = data;
325 data->m_text = text;
326 data->m_bitmap = bitmap;
327 data->m_fgCol = fgCol;
328 data->m_bgCol = bgCol;
329 data->m_hasValidText = true;
330}
331
332wxObjectRefData *wxPGCell::CloneRefData( const wxObjectRefData *data ) const
333{
334 wxPGCellData* c = new wxPGCellData();
335 const wxPGCellData* o = (const wxPGCellData*) data;
336 c->m_text = o->m_text;
337 c->m_bitmap = o->m_bitmap;
338 c->m_fgCol = o->m_fgCol;
339 c->m_bgCol = o->m_bgCol;
340 c->m_hasValidText = o->m_hasValidText;
341 return c;
342}
343
344void wxPGCell::SetText( const wxString& text )
345{
346 AllocExclusive();
347
348 GetData()->SetText(text);
349}
350
351void wxPGCell::SetBitmap( const wxBitmap& bitmap )
1c4293cb 352{
d7e2b522
JS
353 AllocExclusive();
354
355 GetData()->SetBitmap(bitmap);
356}
357
358void wxPGCell::SetFgCol( const wxColour& col )
359{
360 AllocExclusive();
361
362 GetData()->SetFgCol(col);
363}
364
365void wxPGCell::SetBgCol( const wxColour& col )
366{
367 AllocExclusive();
368
369 GetData()->SetBgCol(col);
370}
371
372void wxPGCell::MergeFrom( const wxPGCell& srcCell )
373{
374 AllocExclusive();
375
376 wxPGCellData* data = GetData();
377
378 if ( srcCell.HasText() )
379 data->SetText(srcCell.GetText());
380
381 if ( srcCell.GetFgCol().IsOk() )
382 data->SetFgCol(srcCell.GetFgCol());
383
384 if ( srcCell.GetBgCol().IsOk() )
385 data->SetBgCol(srcCell.GetBgCol());
386
387 if ( srcCell.GetBitmap().IsOk() )
388 data->SetBitmap(srcCell.GetBitmap());
1c4293cb
VZ
389}
390
391// -----------------------------------------------------------------------
392// wxPGProperty
393// -----------------------------------------------------------------------
394
395IMPLEMENT_ABSTRACT_CLASS(wxPGProperty, wxObject)
396
397wxString* wxPGProperty::sm_wxPG_LABEL = NULL;
398
399void wxPGProperty::Init()
400{
401 m_commonValue = -1;
402 m_arrIndex = 0xFFFF;
403 m_parent = NULL;
404
d3b9f782 405 m_parentState = NULL;
1c4293cb
VZ
406
407 m_clientData = NULL;
408 m_clientObject = NULL;
409
d3b9f782 410 m_customEditor = NULL;
1c4293cb 411#if wxUSE_VALIDATORS
d3b9f782 412 m_validator = NULL;
1c4293cb 413#endif
d3b9f782 414 m_valueBitmap = NULL;
1c4293cb
VZ
415
416 m_maxLen = 0; // infinite maximum length
417
418 m_flags = wxPG_PROP_PROPERTY;
419
420 m_depth = 1;
1c4293cb
VZ
421
422 SetExpanded(true);
423}
424
425
426void wxPGProperty::Init( const wxString& label, const wxString& name )
427{
428 // We really need to check if &label and &name are NULL pointers
429 // (this can if we are called before property grid has been initalized)
430
431 if ( (&label) != NULL && label != wxPG_LABEL )
432 m_label = label;
433
434 if ( (&name) != NULL && name != wxPG_LABEL )
435 DoSetName( name );
436 else
437 DoSetName( m_label );
438
439 Init();
440}
441
2fd4a524
JS
442void wxPGProperty::InitAfterAdded( wxPropertyGridPageState* pageState,
443 wxPropertyGrid* propgrid )
444{
445 //
446 // Called after property has been added to grid or page
447 // (so propgrid can be NULL, too).
448
449 wxPGProperty* parent = m_parent;
450 bool parentIsRoot = parent->IsKindOf(CLASSINFO(wxPGRootProperty));
451
452 m_parentState = pageState;
453
1425eca5
JS
454#if wxPG_COMPATIBILITY_1_4
455 // Make sure deprecated virtual functions are not implemented
456 wxString s = GetValueAsString( 0xFFFF );
457 wxASSERT_MSG( s == g_invalidStringContent,
458 "Implement ValueToString() instead of GetValueAsString()" );
459#endif
460
d7e2b522 461 if ( !parentIsRoot && !parent->IsCategory() )
2fd4a524 462 {
d7e2b522 463 m_cells = parent->m_cells;
2fd4a524
JS
464 }
465
466 // If in hideable adding mode, or if assigned parent is hideable, then
467 // make this one hideable.
468 if (
469 ( !parentIsRoot && parent->HasFlag(wxPG_PROP_HIDDEN) ) ||
470 ( propgrid && (propgrid->HasInternalFlag(wxPG_FL_ADDING_HIDEABLES)) )
471 )
472 SetFlag( wxPG_PROP_HIDDEN );
473
474 // Set custom image flag.
475 int custImgHeight = OnMeasureImage().y;
476 if ( custImgHeight < 0 )
477 {
478 SetFlag(wxPG_PROP_CUSTOMIMAGE);
479 }
480
481 if ( propgrid && (propgrid->HasFlag(wxPG_LIMITED_EDITING)) )
482 SetFlag(wxPG_PROP_NOEDITOR);
483
484 // Make sure parent has some parental flags
485 if ( !parent->HasFlag(wxPG_PROP_PARENTAL_FLAGS) )
486 parent->SetParentalType(wxPG_PROP_MISC_PARENT);
487
488 if ( !IsCategory() )
489 {
490 // This is not a category.
491
492 // Depth.
493 //
494 unsigned char depth = 1;
495 if ( !parentIsRoot )
496 {
497 depth = parent->m_depth;
498 if ( !parent->IsCategory() )
499 depth++;
500 }
501 m_depth = depth;
502 unsigned char greyDepth = depth;
503
504 if ( !parentIsRoot )
505 {
506 wxPropertyCategory* pc;
507
508 if ( parent->IsCategory() )
509 pc = (wxPropertyCategory* ) parent;
510 else
511 // This conditional compile is necessary to
512 // bypass some compiler bug.
513 pc = pageState->GetPropertyCategory(parent);
514
515 if ( pc )
516 greyDepth = pc->GetDepth();
517 else
518 greyDepth = parent->m_depthBgCol;
519 }
520
521 m_depthBgCol = greyDepth;
522 }
523 else
524 {
525 // This is a category.
526
527 // depth
528 unsigned char depth = 1;
529 if ( !parentIsRoot )
530 {
531 depth = parent->m_depth + 1;
532 }
533 m_depth = depth;
534 m_depthBgCol = depth;
535 }
536
537 //
538 // Has initial children
539 if ( GetChildCount() )
540 {
2fd4a524 541 // Check parental flags
b0f0eda8 542 wxASSERT_MSG( (m_flags & wxPG_PROP_PARENTAL_FLAGS),
2fd4a524
JS
543 "Call SetFlag(wxPG_PROP_MISC_PARENT) or"
544 "SetFlag(wxPG_PROP_AGGREGATE) before calling"
545 "wxPGProperty::AddChild()." );
546
547 if ( HasFlag(wxPG_PROP_AGGREGATE) )
548 {
549 // Properties with private children are not expanded by default.
550 SetExpanded(false);
551 }
552 else if ( propgrid && propgrid->HasFlag(wxPG_HIDE_MARGIN) )
553 {
554 // ...unless it cannot be expanded by user and therefore must
555 // remain visible at all times
556 SetExpanded(true);
557 }
558
559 //
560 // Prepare children recursively
561 for ( unsigned int i=0; i<GetChildCount(); i++ )
562 {
563 wxPGProperty* child = Item(i);
564 child->InitAfterAdded(pageState, pageState->GetGrid());
565 }
566
567 if ( propgrid && (propgrid->GetExtraStyle() & wxPG_EX_AUTO_UNSPECIFIED_VALUES) )
568 SetFlagRecursively(wxPG_PROP_AUTO_UNSPECIFIED, true);
569 }
570}
571
1c4293cb
VZ
572wxPGProperty::wxPGProperty()
573 : wxObject()
574{
575 Init();
576}
577
578
579wxPGProperty::wxPGProperty( const wxString& label, const wxString& name )
580 : wxObject()
581{
582 Init( label, name );
583}
584
585
586wxPGProperty::~wxPGProperty()
587{
588 delete m_clientObject;
589
590 Empty(); // this deletes items
591
592 delete m_valueBitmap;
593#if wxUSE_VALIDATORS
594 delete m_validator;
595#endif
596
1c4293cb
VZ
597 // This makes it easier for us to detect dangling pointers
598 m_parent = NULL;
599}
600
601
602bool wxPGProperty::IsSomeParent( wxPGProperty* candidate ) const
603{
604 wxPGProperty* parent = m_parent;
605 do
606 {
607 if ( parent == candidate )
608 return true;
609 parent = parent->m_parent;
610 } while ( parent );
611 return false;
612}
613
614
615wxString wxPGProperty::GetName() const
616{
617 wxPGProperty* parent = GetParent();
618
619 if ( !m_name.length() || !parent || parent->IsCategory() || parent->IsRoot() )
620 return m_name;
621
622 return m_parent->GetName() + wxS(".") + m_name;
623}
624
625wxPropertyGrid* wxPGProperty::GetGrid() const
626{
627 if ( !m_parentState )
628 return NULL;
629 return m_parentState->GetGrid();
630}
631
f7a094e1
JS
632int wxPGProperty::Index( const wxPGProperty* p ) const
633{
634 for ( unsigned int i = 0; i<m_children.size(); i++ )
635 {
636 if ( p == m_children[i] )
637 return i;
638 }
639 return wxNOT_FOUND;
640}
1c4293cb 641
1c4293cb
VZ
642bool wxPGProperty::ValidateValue( wxVariant& WXUNUSED(value), wxPGValidationInfo& WXUNUSED(validationInfo) ) const
643{
644 return true;
645}
646
647void wxPGProperty::OnSetValue()
648{
649}
650
651void wxPGProperty::RefreshChildren ()
652{
653}
654
d8812c6e
JS
655void wxPGProperty::OnValidationFailure( wxVariant& WXUNUSED(pendingValue) )
656{
657}
658
d7e2b522
JS
659void wxPGProperty::GetDisplayInfo( unsigned int column,
660 int choiceIndex,
661 int flags,
662 wxString* pString,
663 const wxPGCell** pCell )
664{
665 const wxPGCell* cell = NULL;
666
667 if ( !(flags & wxPGCellRenderer::ChoicePopup) )
668 {
669 // Not painting listi of choice popups, so get text from property
670 cell = &GetCell(column);
671 if ( cell->HasText() )
672 {
673 *pString = cell->GetText();
674 }
675 else
676 {
677 if ( column == 0 )
678 *pString = GetLabel();
679 else if ( column == 1 )
680 *pString = GetDisplayedString();
681 else if ( column == 2 )
682 *pString = GetAttribute(wxPGGlobalVars->m_strUnits, wxEmptyString);
683 }
684 }
685 else
686 {
687 wxASSERT( column == 1 );
688
689 if ( choiceIndex != wxNOT_FOUND )
690 {
691 const wxPGChoiceEntry& entry = m_choices[choiceIndex];
692 if ( entry.GetBitmap().IsOk() ||
693 entry.GetFgCol().IsOk() ||
694 entry.GetBgCol().IsOk() )
695 cell = &entry;
696 *pString = m_choices.GetLabel(choiceIndex);
697 }
698 }
699
700 if ( !cell )
701 cell = &GetCell(column);
702
703 wxASSERT_MSG( cell->GetData(),
704 wxString::Format("Invalid cell for property %s",
705 GetName().c_str()) );
706
707 *pCell = cell;
708}
709
710/*
711wxString wxPGProperty::GetColumnText( unsigned int col, int choiceIndex ) const
1c4293cb 712{
d7e2b522
JS
713
714 if ( col != 1 || choiceIndex == wxNOT_FOUND )
1c4293cb 715 {
d7e2b522
JS
716 const wxPGCell& cell = GetCell(col);
717 if ( cell->HasText() )
718 {
719 return cell->GetText();
720 }
721 else
722 {
723 if ( col == 0 )
724 return GetLabel();
725 else if ( col == 1 )
726 return GetDisplayedString();
727 else if ( col == 2 )
728 return GetAttribute(wxPGGlobalVars->m_strUnits, wxEmptyString);
729 }
1c4293cb
VZ
730 }
731 else
732 {
d7e2b522
JS
733 // Use choice
734 return m_choices.GetLabel(choiceIndex);
1c4293cb
VZ
735 }
736
737 return wxEmptyString;
738}
d7e2b522 739*/
1c4293cb 740
c82a80e8
JS
741void wxPGProperty::DoGenerateComposedValue( wxString& text,
742 int argFlags,
743 const wxVariantList* valueOverrides,
744 wxPGHashMapS2S* childResults ) const
1c4293cb
VZ
745{
746 int i;
f7a094e1 747 int iMax = m_children.size();
1c4293cb
VZ
748
749 text.clear();
750 if ( iMax == 0 )
751 return;
752
753 if ( iMax > PWC_CHILD_SUMMARY_LIMIT &&
754 !(argFlags & wxPG_FULL_VALUE) )
755 iMax = PWC_CHILD_SUMMARY_LIMIT;
756
757 int iMaxMinusOne = iMax-1;
758
759 if ( !IsTextEditable() )
760 argFlags |= wxPG_UNEDITABLE_COMPOSITE_FRAGMENT;
761
f7a094e1 762 wxPGProperty* curChild = m_children[0];
1c4293cb 763
1425eca5
JS
764 bool overridesLeft = false;
765 wxVariant overrideValue;
766 wxVariantList::const_iterator node;
767
768 if ( valueOverrides )
769 {
770 node = valueOverrides->begin();
771 if ( node != valueOverrides->end() )
772 {
773 overrideValue = *node;
774 overridesLeft = true;
775 }
776 }
777
1c4293cb
VZ
778 for ( i = 0; i < iMax; i++ )
779 {
1425eca5
JS
780 wxVariant childValue;
781
782 wxString childLabel = curChild->GetLabel();
783
784 // Check for value override
785 if ( overridesLeft && overrideValue.GetName() == childLabel )
786 {
787 if ( !overrideValue.IsNull() )
788 childValue = overrideValue;
789 else
790 childValue = curChild->GetValue();
b7bc9d80 791 ++node;
1425eca5
JS
792 if ( node != valueOverrides->end() )
793 overrideValue = *node;
794 else
795 overridesLeft = false;
796 }
797 else
798 {
799 childValue = curChild->GetValue();
800 }
801
1c4293cb 802 wxString s;
1425eca5
JS
803 if ( !childValue.IsNull() )
804 {
805 if ( overridesLeft &&
806 curChild->HasFlag(wxPG_PROP_COMPOSED_VALUE) &&
807 childValue.GetType() == wxPG_VARIANT_TYPE_LIST )
808 {
809 wxVariantList& childList = childValue.GetList();
c82a80e8
JS
810 DoGenerateComposedValue(s, argFlags|wxPG_COMPOSITE_FRAGMENT,
811 &childList, childResults);
1425eca5
JS
812 }
813 else
814 {
815 s = curChild->ValueToString(childValue,
816 argFlags|wxPG_COMPOSITE_FRAGMENT);
817 }
818 }
819
820 if ( childResults && curChild->GetChildCount() )
821 (*childResults)[curChild->GetName()] = s;
1c4293cb
VZ
822
823 bool skip = false;
824 if ( (argFlags & wxPG_UNEDITABLE_COMPOSITE_FRAGMENT) && !s.length() )
825 skip = true;
826
827 if ( !curChild->GetChildCount() || skip )
828 text += s;
829 else
830 text += wxS("[") + s + wxS("]");
831
832 if ( i < iMaxMinusOne )
833 {
834 if ( text.length() > PWC_CHILD_SUMMARY_CHAR_LIMIT &&
835 !(argFlags & wxPG_EDITABLE_VALUE) &&
836 !(argFlags & wxPG_FULL_VALUE) )
837 break;
838
839 if ( !skip )
840 {
841 if ( !curChild->GetChildCount() )
842 text += wxS("; ");
843 else
844 text += wxS(" ");
845 }
846
f7a094e1 847 curChild = m_children[i+1];
1c4293cb
VZ
848 }
849 }
850
f7a094e1 851 if ( (unsigned int)i < m_children.size() )
7036fd20
JS
852 {
853 if ( !text.EndsWith(wxS("; ")) )
854 text += wxS("; ...");
855 else
856 text += wxS("...");
857 }
1c4293cb
VZ
858}
859
1425eca5
JS
860wxString wxPGProperty::ValueToString( wxVariant& WXUNUSED(value),
861 int argFlags ) const
1c4293cb
VZ
862{
863 wxCHECK_MSG( GetChildCount() > 0,
864 wxString(),
1425eca5
JS
865 "If user property does not have any children, it must "
866 "override GetValueAsString" );
867
868 // FIXME: Currently code below only works if value is actually m_value
869 wxASSERT_MSG( argFlags & wxPG_VALUE_IS_CURRENT,
870 "Sorry, currently default wxPGProperty::ValueToString() "
871 "implementation only works if value is m_value." );
1c4293cb
VZ
872
873 wxString text;
c82a80e8 874 DoGenerateComposedValue(text, argFlags);
1c4293cb
VZ
875 return text;
876}
877
1425eca5 878wxString wxPGProperty::GetValueAsString( int argFlags ) const
1c4293cb 879{
1425eca5
JS
880#if wxPG_COMPATIBILITY_1_4
881 // This is backwards compatibility test
882 // That is, to make sure this function is not overridden
883 // (instead, ValueToString() should be).
884 if ( argFlags == 0xFFFF )
885 {
886 // Do not override! (for backwards compliancy)
887 return g_invalidStringContent;
888 }
889#endif
890
1c4293cb
VZ
891 if ( IsValueUnspecified() )
892 return wxEmptyString;
893
894 if ( m_commonValue == -1 )
1425eca5
JS
895 {
896 wxVariant value(GetValue());
897 return ValueToString(value, argFlags|wxPG_VALUE_IS_CURRENT);
898 }
1c4293cb
VZ
899
900 //
901 // Return common value's string representation
902 wxPropertyGrid* pg = GetGrid();
903 const wxPGCommonValue* cv = pg->GetCommonValue(m_commonValue);
904
905 if ( argFlags & wxPG_FULL_VALUE )
906 {
907 return cv->GetLabel();
908 }
909 else if ( argFlags & wxPG_EDITABLE_VALUE )
910 {
911 return cv->GetEditableText();
912 }
913 else
914 {
915 return cv->GetLabel();
916 }
917}
918
1425eca5
JS
919wxString wxPGProperty::GetValueString( int argFlags ) const
920{
921 return GetValueAsString(argFlags);
922}
923
1c4293cb
VZ
924bool wxPGProperty::IntToValue( wxVariant& variant, int number, int WXUNUSED(argFlags) ) const
925{
926 variant = (long)number;
927 return true;
928}
929
930// Convert semicolon delimited tokens into child values.
931bool wxPGProperty::StringToValue( wxVariant& variant, const wxString& text, int argFlags ) const
932{
933 if ( !GetChildCount() )
934 return false;
935
936 unsigned int curChild = 0;
937
f7a094e1 938 unsigned int iMax = m_children.size();
1c4293cb
VZ
939
940 if ( iMax > PWC_CHILD_SUMMARY_LIMIT &&
941 !(argFlags & wxPG_FULL_VALUE) )
942 iMax = PWC_CHILD_SUMMARY_LIMIT;
943
944 bool changed = false;
945
946 wxString token;
947 size_t pos = 0;
948
949 // Its best only to add non-empty group items
950 bool addOnlyIfNotEmpty = false;
951 const wxChar delimeter = wxS(';');
952
953 size_t tokenStart = 0xFFFFFF;
954
955 wxVariantList temp_list;
956 wxVariant list(temp_list);
957
f275b5db 958 int propagatedFlags = argFlags & (wxPG_REPORT_ERROR|wxPG_PROGRAMMATIC_VALUE);
1c4293cb
VZ
959
960#ifdef __WXDEBUG__
961 bool debug_print = false;
962#endif
963
964#ifdef __WXDEBUG__
965 if ( debug_print )
966 wxLogDebug(wxT(">> %s.StringToValue('%s')"),GetLabel().c_str(),text.c_str());
967#endif
968
969 wxString::const_iterator it = text.begin();
970 wxUniChar a;
971
972 if ( it != text.end() )
973 a = *it;
974 else
975 a = 0;
976
977 for ( ;; )
978 {
a64a1bf7
JS
979 // How many units we iterate string forward at the end of loop?
980 // We need to keep track of this or risk going to negative
981 // with it-- operation.
982 unsigned int strPosIncrement = 1;
983
1c4293cb
VZ
984 if ( tokenStart != 0xFFFFFF )
985 {
986 // Token is running
987 if ( a == delimeter || a == 0 )
988 {
989 token = text.substr(tokenStart,pos-tokenStart);
990 token.Trim(true);
991 size_t len = token.length();
992
993 if ( !addOnlyIfNotEmpty || len > 0 )
994 {
995 const wxPGProperty* child = Item(curChild);
f275b5db 996 wxVariant variant(child->GetValue());
ae82388e 997 wxString childName = child->GetBaseName();
f275b5db 998
1c4293cb
VZ
999 #ifdef __WXDEBUG__
1000 if ( debug_print )
ae82388e
JS
1001 wxLogDebug(wxT("token = '%s', child = %s"),
1002 token.c_str(), childName.c_str());
1c4293cb
VZ
1003 #endif
1004
f275b5db
JS
1005 // Add only if editable or setting programmatically
1006 if ( (argFlags & wxPG_PROGRAMMATIC_VALUE) ||
1007 !child->HasFlag(wxPG_PROP_DISABLED|wxPG_PROP_READONLY) )
1c4293cb 1008 {
f275b5db 1009 if ( len > 0 )
1c4293cb 1010 {
ae82388e
JS
1011 if ( child->StringToValue(variant, token,
1012 propagatedFlags|wxPG_COMPOSITE_FRAGMENT) )
1c4293cb 1013 {
ae82388e
JS
1014 // We really need to set the variant's name
1015 // *after* child->StringToValue() has been
1016 // called, since variant's value may be set by
1017 // assigning another variant into it, which
1018 // then usually causes name to be copied (ie.
1019 // usually cleared) as well. wxBoolProperty
1020 // being case in point with its use of
1021 // wxPGVariant_Bool macro as an optimization.
1022 variant.SetName(childName);
f275b5db 1023 list.Append(variant);
1c4293cb 1024
f275b5db
JS
1025 changed = true;
1026 }
1027 }
1028 else
1029 {
1030 // Empty, becomes unspecified
1031 variant.MakeNull();
ae82388e 1032 variant.SetName(childName);
f275b5db 1033 list.Append(variant);
1c4293cb
VZ
1034 changed = true;
1035 }
1036 }
1c4293cb
VZ
1037
1038 curChild++;
1039 if ( curChild >= iMax )
1040 break;
1041 }
1042
1043 tokenStart = 0xFFFFFF;
1044 }
1045 }
1046 else
1047 {
1048 // Token is not running
1049 if ( a != wxS(' ') )
1050 {
1051
1052 addOnlyIfNotEmpty = false;
1053
1054 // Is this a group of tokens?
1055 if ( a == wxS('[') )
1056 {
1057 int depth = 1;
1058
b7bc9d80 1059 if ( it != text.end() ) ++it;
1c4293cb
VZ
1060 pos++;
1061 size_t startPos = pos;
1062
1063 // Group item - find end
1064 while ( it != text.end() && depth > 0 )
1065 {
1066 a = *it;
b7bc9d80 1067 ++it;
1c4293cb
VZ
1068 pos++;
1069
1070 if ( a == wxS(']') )
1071 depth--;
1072 else if ( a == wxS('[') )
1073 depth++;
1074 }
1075
1076 token = text.substr(startPos,pos-startPos-1);
1077
1078 if ( !token.length() )
1079 break;
1080
1081 const wxPGProperty* child = Item(curChild);
1082
2bbd3749
JS
1083 wxVariant oldChildValue = child->GetValue();
1084 wxVariant variant(oldChildValue);
f275b5db
JS
1085
1086 if ( (argFlags & wxPG_PROGRAMMATIC_VALUE) ||
1087 !child->HasFlag(wxPG_PROP_DISABLED|wxPG_PROP_READONLY) )
1c4293cb 1088 {
a64a1bf7
JS
1089 wxString childName = child->GetBaseName();
1090
1091 bool stvRes = child->StringToValue( variant, token,
1092 propagatedFlags );
f275b5db
JS
1093 if ( stvRes || (variant != oldChildValue) )
1094 {
a64a1bf7
JS
1095 variant.SetName(childName);
1096 list.Append(variant);
1097
1098 changed = true;
f275b5db
JS
1099 }
1100 else
1101 {
a64a1bf7 1102 // No changes...
f275b5db 1103 }
1c4293cb
VZ
1104 }
1105
1106 curChild++;
1107 if ( curChild >= iMax )
1108 break;
1109
1110 addOnlyIfNotEmpty = true;
1111
1112 tokenStart = 0xFFFFFF;
1113 }
1114 else
1115 {
1116 tokenStart = pos;
1117
1118 if ( a == delimeter )
a64a1bf7 1119 strPosIncrement -= 1;
1c4293cb
VZ
1120 }
1121 }
1122 }
1123
1124 if ( a == 0 )
1125 break;
1126
a64a1bf7
JS
1127 it += strPosIncrement;
1128
1c4293cb
VZ
1129 if ( it != text.end() )
1130 {
1131 a = *it;
1132 }
1133 else
1134 {
1135 a = 0;
1136 }
a64a1bf7
JS
1137
1138 pos += strPosIncrement;
1c4293cb
VZ
1139 }
1140
1141 if ( changed )
1142 variant = list;
1143
1144 return changed;
1145}
1146
1147bool wxPGProperty::SetValueFromString( const wxString& text, int argFlags )
1148{
1149 wxVariant variant(m_value);
1150 bool res = StringToValue(variant, text, argFlags);
1151 if ( res )
1152 SetValue(variant);
1153 return res;
1154}
1155
1156bool wxPGProperty::SetValueFromInt( long number, int argFlags )
1157{
1158 wxVariant variant(m_value);
1159 bool res = IntToValue(variant, number, argFlags);
1160 if ( res )
1161 SetValue(variant);
1162 return res;
1163}
1164
1165wxSize wxPGProperty::OnMeasureImage( int WXUNUSED(item) ) const
1166{
1167 if ( m_valueBitmap )
1168 return wxSize(m_valueBitmap->GetWidth(),-1);
1169
1170 return wxSize(0,0);
1171}
1172
1173wxPGCellRenderer* wxPGProperty::GetCellRenderer( int WXUNUSED(column) ) const
1174{
1175 return wxPGGlobalVars->m_defaultRenderer;
1176}
1177
1178void wxPGProperty::OnCustomPaint( wxDC& dc,
1179 const wxRect& rect,
1180 wxPGPaintData& )
1181{
1182 wxBitmap* bmp = m_valueBitmap;
1183
1184 wxCHECK_RET( bmp && bmp->Ok(), wxT("invalid bitmap") );
1185
1186 wxCHECK_RET( rect.x >= 0, wxT("unexpected measure call") );
1187
1188 dc.DrawBitmap(*bmp,rect.x,rect.y);
1189}
1190
1191const wxPGEditor* wxPGProperty::DoGetEditorClass() const
1192{
c26873c8 1193 return wxPGEditor_TextCtrl;
1c4293cb
VZ
1194}
1195
1196// Default extra property event handling - that is, none at all.
1197bool wxPGProperty::OnEvent( wxPropertyGrid*, wxWindow*, wxEvent& )
1198{
1199 return false;
1200}
1201
1202
1203void wxPGProperty::SetValue( wxVariant value, wxVariant* pList, int flags )
1204{
104837f2
JS
1205 // If auto unspecified values are not wanted (via window or property style),
1206 // then get default value instead of wxNullVariant.
1207 if ( value.IsNull() && (flags & wxPG_SETVAL_BY_USER) &&
1208 !UsesAutoUnspecified() )
1209 {
1210 value = GetDefaultValue();
1211 }
1212
1c4293cb
VZ
1213 if ( !value.IsNull() )
1214 {
8f18b252
JS
1215 wxVariant tempListVariant;
1216
1c4293cb
VZ
1217 SetCommonValue(-1);
1218 // List variants are reserved a special purpose
1219 // as intermediate containers for child values
1220 // of properties with children.
0372d42e 1221 if ( value.GetType() == wxPG_VARIANT_TYPE_LIST )
1c4293cb 1222 {
8f18b252
JS
1223 //
1224 // However, situation is different for composed string properties
1225 if ( HasFlag(wxPG_PROP_COMPOSED_VALUE) )
1226 {
1227 tempListVariant = value;
1228 pList = &tempListVariant;
1229 }
1230
1c4293cb
VZ
1231 wxVariant newValue;
1232 AdaptListToValue(value, &newValue);
1233 value = newValue;
1234 //wxLogDebug(wxT(">> %s.SetValue() adapted list value to type '%s'"),GetName().c_str(),value.GetType().c_str());
1235 }
1236
1237 if ( HasFlag( wxPG_PROP_AGGREGATE) )
1238 flags |= wxPG_SETVAL_AGGREGATED;
1239
1240 if ( pList && !pList->IsNull() )
1241 {
0372d42e 1242 wxASSERT( pList->GetType() == wxPG_VARIANT_TYPE_LIST );
1c4293cb
VZ
1243 wxASSERT( GetChildCount() );
1244 wxASSERT( !IsCategory() );
1245
1246 wxVariantList& list = pList->GetList();
1247 wxVariantList::iterator node;
1248 unsigned int i = 0;
1249
1250 //wxLogDebug(wxT(">> %s.SetValue() pList parsing"),GetName().c_str());
1251
1252 // Children in list can be in any order, but we will give hint to
d665918b 1253 // GetPropertyByNameWH(). This optimizes for full list parsing.
b7bc9d80 1254 for ( node = list.begin(); node != list.end(); ++node )
1c4293cb
VZ
1255 {
1256 wxVariant& childValue = *((wxVariant*)*node);
d665918b 1257 wxPGProperty* child = GetPropertyByNameWH(childValue.GetName(), i);
1c4293cb
VZ
1258 if ( child )
1259 {
d665918b 1260 //wxLogDebug(wxT("%i: child = %s, childValue.GetType()=%s"),i,child->GetBaseName().c_str(),childValue.GetType().c_str());
0372d42e 1261 if ( childValue.GetType() == wxPG_VARIANT_TYPE_LIST )
1c4293cb
VZ
1262 {
1263 if ( child->HasFlag(wxPG_PROP_AGGREGATE) && !(flags & wxPG_SETVAL_AGGREGATED) )
1264 {
1265 wxVariant listRefCopy = childValue;
1266 child->SetValue(childValue, &listRefCopy, flags|wxPG_SETVAL_FROM_PARENT);
1267 }
1268 else
1269 {
1270 wxVariant oldVal = child->GetValue();
1271 child->SetValue(oldVal, &childValue, flags|wxPG_SETVAL_FROM_PARENT);
1272 }
1273 }
0372d42e 1274 else if ( child->GetValue() != childValue )
1c4293cb
VZ
1275 {
1276 // For aggregate properties, we will trust RefreshChildren()
1277 // to update child values.
1278 if ( !HasFlag(wxPG_PROP_AGGREGATE) )
1279 child->SetValue(childValue, NULL, flags|wxPG_SETVAL_FROM_PARENT);
8f18b252
JS
1280 if ( flags & wxPG_SETVAL_BY_USER )
1281 child->SetFlag(wxPG_PROP_MODIFIED);
1c4293cb
VZ
1282 }
1283 }
1284 i++;
1285 }
1286 }
1287
1288 if ( !value.IsNull() )
1289 {
0372d42e 1290 m_value = value;
1c4293cb 1291 OnSetValue();
1c4293cb
VZ
1292 }
1293
8f18b252 1294 if ( flags & wxPG_SETVAL_BY_USER )
1c4293cb
VZ
1295 SetFlag(wxPG_PROP_MODIFIED);
1296
1297 if ( HasFlag(wxPG_PROP_AGGREGATE) )
1298 RefreshChildren();
1299 }
1300 else
1301 {
1302 if ( m_commonValue != -1 )
1303 {
1304 wxPropertyGrid* pg = GetGrid();
1305 if ( !pg || m_commonValue != pg->GetUnspecifiedCommonValue() )
1306 SetCommonValue(-1);
1307 }
1308
1309 m_value = value;
1310
1311 // Set children to unspecified, but only if aggregate or
1312 // value is <composed>
1313 if ( AreChildrenComponents() )
1314 {
1315 unsigned int i;
1316 for ( i=0; i<GetChildCount(); i++ )
1317 Item(i)->SetValue(value, NULL, flags|wxPG_SETVAL_FROM_PARENT);
1318 }
1319 }
1320
daeb4e4d
JS
1321 if ( !(flags & wxPG_SETVAL_FROM_PARENT) )
1322 UpdateParentValues();
1323
1c4293cb
VZ
1324 //
1325 // Update editor control
1326 //
1327
1328 // We need to check for these, otherwise GetGrid() may fail.
1329 if ( flags & wxPG_SETVAL_REFRESH_EDITOR )
1330 RefreshEditor();
1331}
1332
1333
1334void wxPGProperty::SetValueInEvent( wxVariant value ) const
1335{
1336 GetGrid()->ValueChangeInEvent(value);
1337}
1338
1339void wxPGProperty::SetFlagRecursively( FlagType flag, bool set )
1340{
1341 if ( set )
1342 SetFlag(flag);
1343 else
1344 ClearFlag(flag);
1345
1346 unsigned int i;
1347 for ( i = 0; i < GetChildCount(); i++ )
1348 Item(i)->SetFlagRecursively(flag, set);
1349}
1350
1351void wxPGProperty::RefreshEditor()
1352{
f521bae6
JS
1353 if ( !m_parent )
1354 return;
1c4293cb 1355
f521bae6
JS
1356 wxPropertyGrid* pg = GetGrid();
1357 if ( pg && pg->GetSelectedProperty() == this )
a6353fe8 1358 pg->RefreshEditor();
f521bae6 1359}
1c4293cb
VZ
1360
1361wxVariant wxPGProperty::GetDefaultValue() const
1362{
1363 wxVariant defVal = GetAttribute(wxS("DefaultValue"));
1364 if ( !defVal.IsNull() )
1365 return defVal;
1366
1367 wxVariant value = GetValue();
1368
1369 if ( !value.IsNull() )
1370 {
0372d42e
JS
1371 wxString valueType(value.GetType());
1372
1373 if ( valueType == wxPG_VARIANT_TYPE_LONG )
1c4293cb 1374 return wxPGVariant_Zero;
0372d42e 1375 if ( valueType == wxPG_VARIANT_TYPE_STRING )
1c4293cb 1376 return wxPGVariant_EmptyString;
0372d42e 1377 if ( valueType == wxPG_VARIANT_TYPE_BOOL )
1c4293cb 1378 return wxPGVariant_False;
0372d42e 1379 if ( valueType == wxPG_VARIANT_TYPE_DOUBLE )
1c4293cb 1380 return wxVariant(0.0);
0372d42e 1381 if ( valueType == wxPG_VARIANT_TYPE_ARRSTRING )
1c4293cb 1382 return wxVariant(wxArrayString());
0372d42e
JS
1383 if ( valueType == wxS("wxLongLong") )
1384 return WXVARIANT(wxLongLong(0));
1385 if ( valueType == wxS("wxULongLong") )
1386 return WXVARIANT(wxULongLong(0));
1387 if ( valueType == wxS("wxColour") )
1388 return WXVARIANT(*wxBLACK);
1c4293cb 1389#if wxUSE_DATETIME
0372d42e 1390 if ( valueType == wxPG_VARIANT_TYPE_DATETIME )
1c4293cb
VZ
1391 return wxVariant(wxDateTime::Now());
1392#endif
0372d42e
JS
1393 if ( valueType == wxS("wxFont") )
1394 return WXVARIANT(*wxNORMAL_FONT);
1395 if ( valueType == wxS("wxPoint") )
1396 return WXVARIANT(wxPoint(0, 0));
1397 if ( valueType == wxS("wxSize") )
1398 return WXVARIANT(wxSize(0, 0));
1c4293cb
VZ
1399 }
1400
1401 return wxVariant();
1402}
1403
d7e2b522
JS
1404void wxPGProperty::EnsureCells( unsigned int column )
1405{
1406 if ( column >= m_cells.size() )
1407 {
1408 // Fill empty slots with default cells
1409 wxPropertyGrid* pg = GetGrid();
1410 wxPGCell defaultCell;
1411
1412 if ( !HasFlag(wxPG_PROP_CATEGORY) )
1413 defaultCell = pg->GetPropertyDefaultCell();
1414 else
1415 defaultCell = pg->GetCategoryDefaultCell();
1416
1417 // TODO: Replace with resize() call
1418 unsigned int cellCountMax = column+1;
1419
1420 for ( unsigned int i=m_cells.size(); i<cellCountMax; i++ )
1421 m_cells.push_back(defaultCell);
1422 }
1423}
1424
1425void wxPGProperty::SetCell( int column,
1426 const wxPGCell& cell )
1427{
1428 EnsureCells(column);
1429
1430 m_cells[column] = cell;
1431}
1432
1433void wxPGProperty::AdaptiveSetCell( unsigned int firstCol,
1434 unsigned int lastCol,
1435 const wxPGCell& cell,
1436 const wxPGCell& srcData,
1437 wxPGCellData* unmodCellData,
1438 FlagType ignoreWithFlags,
1439 bool recursively )
1440{
1441 //
1442 // Sets cell in memory optimizing fashion. That is, if
1443 // current cell data matches unmodCellData, we will
1444 // simply get reference to data from cell. Otherwise,
1445 // cell information from srcData is merged into current.
1446 //
1447
1448 if ( !(m_flags & ignoreWithFlags) && !IsRoot() )
1449 {
1450 EnsureCells(lastCol);
1451
1452 for ( unsigned int col=firstCol; col<=lastCol; col++ )
1453 {
1454 if ( m_cells[col].GetData() == unmodCellData )
1455 {
1456 // Data matches... use cell directly
1457 m_cells[col] = cell;
1458 }
1459 else
1460 {
1461 // Data did not match... merge valid information
1462 m_cells[col].MergeFrom(srcData);
1463 }
1464 }
1465 }
1466
1467 if ( recursively )
1468 {
1469 for ( unsigned int i=0; i<GetChildCount(); i++ )
1470 Item(i)->AdaptiveSetCell( firstCol,
1471 lastCol,
1472 cell,
1473 srcData,
1474 unmodCellData,
1475 ignoreWithFlags,
1476 recursively );
1477 }
1478}
1479
1480const wxPGCell& wxPGProperty::GetCell( unsigned int column ) const
1c4293cb 1481{
d7e2b522
JS
1482 if ( m_cells.size() > column )
1483 return m_cells[column];
1484
1485 wxPropertyGrid* pg = GetGrid();
1486
1487 if ( IsCategory() )
1488 return pg->GetCategoryDefaultCell();
1489
1490 return pg->GetPropertyDefaultCell();
1491}
1492
1493wxPGCell& wxPGProperty::GetCell( unsigned int column )
1494{
1495 EnsureCells(column);
1496 return m_cells[column];
1497}
1498
1499void wxPGProperty::SetBackgroundColour( const wxColour& colour,
1500 bool recursively )
1501{
1502 wxPGProperty* firstProp = this;
1503
1504 //
1505 // If category is tried to set recursively, skip it and only
1506 // affect the children.
1507 if ( recursively )
1508 {
1509 while ( firstProp->IsCategory() )
1510 {
1511 if ( !firstProp->GetChildCount() )
1512 return;
1513 firstProp = firstProp->Item(0);
1514 }
1515 }
1516
1517 wxPGCell& firstCell = firstProp->GetCell(0);
1518 wxPGCellData* firstCellData = firstCell.GetData();
1519
1520 wxPGCell newCell(firstCell);
1521 newCell.SetBgCol(colour);
1522 wxPGCell srcCell;
1523 srcCell.SetBgCol(colour);
1524
1525 AdaptiveSetCell( 0,
1526 GetParentState()->GetColumnCount()-1,
1527 newCell,
1528 srcCell,
1529 firstCellData,
1530 recursively ? wxPG_PROP_CATEGORY : 0,
1531 recursively );
1532}
1533
1534void wxPGProperty::SetTextColour( const wxColour& colour,
1535 bool recursively )
1536{
1537 wxPGProperty* firstProp = this;
1538
1539 //
1540 // If category is tried to set recursively, skip it and only
1541 // affect the children.
1542 if ( recursively )
1543 {
1544 while ( firstProp->IsCategory() )
1545 {
1546 if ( !firstProp->GetChildCount() )
1547 return;
1548 firstProp = firstProp->Item(0);
1549 }
1550 }
1c4293cb 1551
d7e2b522
JS
1552 wxPGCell& firstCell = firstProp->GetCell(0);
1553 wxPGCellData* firstCellData = firstCell.GetData();
1554
1555 wxPGCell newCell(firstCell);
1556 newCell.SetFgCol(colour);
1557 wxPGCell srcCell;
1558 srcCell.SetFgCol(colour);
1559
1560 AdaptiveSetCell( 0,
1561 GetParentState()->GetColumnCount()-1,
1562 newCell,
1563 srcCell,
1564 firstCellData,
1565 recursively ? wxPG_PROP_CATEGORY : 0,
1566 recursively );
1c4293cb
VZ
1567}
1568
1c4293cb
VZ
1569wxPGEditorDialogAdapter* wxPGProperty::GetEditorDialog() const
1570{
1571 return NULL;
1572}
1573
1574bool wxPGProperty::DoSetAttribute( const wxString& WXUNUSED(name), wxVariant& WXUNUSED(value) )
1575{
1576 return false;
1577}
1578
1579void wxPGProperty::SetAttribute( const wxString& name, wxVariant value )
1580{
1581 if ( DoSetAttribute( name, value ) )
1582 {
1583 // Support working without grid, when possible
1584 if ( wxPGGlobalVars->HasExtraStyle( wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES ) )
1585 return;
1586 }
1587
1588 m_attributes.Set( name, value );
1589}
1590
1591void wxPGProperty::SetAttributes( const wxPGAttributeStorage& attributes )
1592{
1593 wxPGAttributeStorage::const_iterator it = attributes.StartIteration();
1594 wxVariant variant;
1595
1596 while ( attributes.GetNext(it, variant) )
1597 SetAttribute( variant.GetName(), variant );
1598}
1599
1600wxVariant wxPGProperty::DoGetAttribute( const wxString& WXUNUSED(name) ) const
1601{
1602 return wxVariant();
1603}
1604
1605
1606wxVariant wxPGProperty::GetAttribute( const wxString& name ) const
1607{
1608 return m_attributes.FindValue(name);
1609}
1610
1611wxString wxPGProperty::GetAttribute( const wxString& name, const wxString& defVal ) const
1612{
1613 wxVariant variant = m_attributes.FindValue(name);
1614
1615 if ( !variant.IsNull() )
1616 return variant.GetString();
1617
1618 return defVal;
1619}
1620
1621long wxPGProperty::GetAttributeAsLong( const wxString& name, long defVal ) const
1622{
1623 wxVariant variant = m_attributes.FindValue(name);
1624
1625 return wxPGVariantToInt(variant, defVal);
1626}
1627
1628double wxPGProperty::GetAttributeAsDouble( const wxString& name, double defVal ) const
1629{
1630 double retVal;
1631 wxVariant variant = m_attributes.FindValue(name);
1632
1633 if ( wxPGVariantToDouble(variant, &retVal) )
1634 return retVal;
1635
1636 return defVal;
1637}
1638
1639wxVariant wxPGProperty::GetAttributesAsList() const
1640{
1641 wxVariantList tempList;
1642 wxVariant v( tempList, wxString::Format(wxS("@%s@attr"),m_name.c_str()) );
1643
1644 wxPGAttributeStorage::const_iterator it = m_attributes.StartIteration();
1645 wxVariant variant;
1646
1647 while ( m_attributes.GetNext(it, variant) )
1648 v.Append(variant);
1649
1650 return v;
1651}
1652
1653// Slots of utility flags are NULL
1654const unsigned int gs_propFlagToStringSize = 14;
1655
1656static const wxChar* gs_propFlagToString[gs_propFlagToStringSize] = {
1657 NULL,
1658 wxT("DISABLED"),
1659 wxT("HIDDEN"),
1660 NULL,
1661 wxT("NOEDITOR"),
1662 wxT("COLLAPSED"),
1663 NULL,
1664 NULL,
1665 NULL,
1666 NULL,
1667 NULL,
1668 NULL,
1669 NULL,
1670 NULL
1671};
1672
1673wxString wxPGProperty::GetFlagsAsString( FlagType flagsMask ) const
1674{
1675 wxString s;
1676 int relevantFlags = m_flags & flagsMask & wxPG_STRING_STORED_FLAGS;
1677 FlagType a = 1;
1678
1679 unsigned int i = 0;
1680 for ( i=0; i<gs_propFlagToStringSize; i++ )
1681 {
1682 if ( relevantFlags & a )
1683 {
1684 const wxChar* fs = gs_propFlagToString[i];
1685 wxASSERT(fs);
1686 if ( s.length() )
1687 s << wxS("|");
1688 s << fs;
1689 }
1690 a = a << 1;
1691 }
1692
1693 return s;
1694}
1695
1696void wxPGProperty::SetFlagsFromString( const wxString& str )
1697{
1698 FlagType flags = 0;
1699
1700 WX_PG_TOKENIZER1_BEGIN(str, wxS('|'))
1701 unsigned int i;
1702 for ( i=0; i<gs_propFlagToStringSize; i++ )
1703 {
1704 const wxChar* fs = gs_propFlagToString[i];
1705 if ( fs && str == fs )
1706 {
1707 flags |= (1<<i);
1708 break;
1709 }
1710 }
1711 WX_PG_TOKENIZER1_END()
1712
1713 m_flags = (m_flags & ~wxPG_STRING_STORED_FLAGS) | flags;
1714}
1715
1716wxValidator* wxPGProperty::DoGetValidator() const
1717{
d3b9f782 1718 return NULL;
1c4293cb
VZ
1719}
1720
939d9364 1721int wxPGProperty::InsertChoice( const wxString& label, int index, int value )
1c4293cb 1722{
939d9364
JS
1723 wxPropertyGrid* pg = GetGrid();
1724 int sel = GetChoiceSelection();
1725
1726 int newSel = sel;
1727
1728 if ( index == wxNOT_FOUND )
1729 index = m_choices.GetCount();
1730
1731 if ( index <= sel )
1732 newSel++;
1733
1734 m_choices.Insert(label, index, value);
1735
1736 if ( sel != newSel )
1737 SetChoiceSelection(newSel);
1738
1739 if ( this == pg->GetSelection() )
1740 GetEditorClass()->InsertItem(pg->GetEditorControl(),label,index);
1741
1742 return index;
1c4293cb
VZ
1743}
1744
939d9364
JS
1745
1746void wxPGProperty::DeleteChoice( int index )
1c4293cb 1747{
939d9364
JS
1748 wxPropertyGrid* pg = GetGrid();
1749
1750 int sel = GetChoiceSelection();
1751 int newSel = sel;
1752
1753 // Adjust current value
1754 if ( sel == index )
1755 {
1756 SetValueToUnspecified();
1757 newSel = 0;
1758 }
1759 else if ( index < sel )
1760 {
1761 newSel--;
1762 }
1763
1764 m_choices.RemoveAt(index);
1765
1766 if ( sel != newSel )
1767 SetChoiceSelection(newSel);
1768
1769 if ( this == pg->GetSelection() )
1770 GetEditorClass()->DeleteItem(pg->GetEditorControl(), index);
1c4293cb
VZ
1771}
1772
939d9364 1773int wxPGProperty::GetChoiceSelection() const
1c4293cb 1774{
939d9364
JS
1775 wxVariant value = GetValue();
1776 wxString valueType = value.GetType();
1777 int index = wxNOT_FOUND;
1778
1779 if ( IsValueUnspecified() || !m_choices.GetCount() )
1780 return wxNOT_FOUND;
1781
1782 if ( valueType == wxPG_VARIANT_TYPE_LONG )
1783 {
1784 index = value.GetLong();
1785 }
1786 else if ( valueType == wxPG_VARIANT_TYPE_STRING )
1787 {
1788 index = m_choices.Index(value.GetString());
1789 }
1790 else if ( valueType == wxPG_VARIANT_TYPE_BOOL )
1791 {
1792 index = value.GetBool()? 1 : 0;
1793 }
1794
1795 return index;
1c4293cb
VZ
1796}
1797
939d9364 1798void wxPGProperty::SetChoiceSelection( int newValue )
1c4293cb 1799{
939d9364
JS
1800 // Changes value of a property with choices, but only
1801 // works if the value type is long or string.
1802 wxString valueType = GetValue().GetType();
1803
1804 wxCHECK_RET( m_choices.IsOk(), wxT("invalid choiceinfo") );
1c4293cb 1805
939d9364
JS
1806 if ( valueType == wxPG_VARIANT_TYPE_STRING )
1807 {
1808 SetValue( m_choices.GetLabel(newValue) );
1809 }
1810 else // if ( valueType == wxPG_VARIANT_TYPE_LONG )
1811 {
1812 SetValue( (long) newValue );
1813 }
1c4293cb
VZ
1814}
1815
1816bool wxPGProperty::SetChoices( wxPGChoices& choices )
1817{
939d9364 1818 m_choices.Assign(choices);
1c4293cb 1819
1c4293cb 1820 {
939d9364
JS
1821 // This may be needed to trigger some initialization
1822 // (but don't do it if property is somewhat uninitialized)
1823 wxVariant defVal = GetDefaultValue();
1824 if ( defVal.IsNull() )
1825 return false;
1c4293cb 1826
939d9364 1827 SetValue(defVal);
1c4293cb 1828 }
939d9364
JS
1829
1830 return true;
1c4293cb
VZ
1831}
1832
1833
1834const wxPGEditor* wxPGProperty::GetEditorClass() const
1835{
1836 const wxPGEditor* editor;
1837
1838 if ( !m_customEditor )
1839 {
1840 editor = DoGetEditorClass();
1841 }
1842 else
1843 editor = m_customEditor;
1844
1845 //
1846 // Maybe override editor if common value specified
1847 if ( GetDisplayedCommonValueCount() )
1848 {
1849 // TextCtrlAndButton -> ComboBoxAndButton
1850 if ( editor->IsKindOf(CLASSINFO(wxPGTextCtrlAndButtonEditor)) )
c26873c8 1851 editor = wxPGEditor_ChoiceAndButton;
1c4293cb
VZ
1852
1853 // TextCtrl -> ComboBox
1854 else if ( editor->IsKindOf(CLASSINFO(wxPGTextCtrlEditor)) )
c26873c8 1855 editor = wxPGEditor_ComboBox;
1c4293cb
VZ
1856 }
1857
1858 return editor;
1859}
1860
1c4293cb
VZ
1861bool wxPGProperty::HasVisibleChildren() const
1862{
1863 unsigned int i;
1864
1865 for ( i=0; i<GetChildCount(); i++ )
1866 {
1867 wxPGProperty* child = Item(i);
1868
1869 if ( !child->HasFlag(wxPG_PROP_HIDDEN) )
1870 return true;
1871 }
1872
1873 return false;
1874}
1875
1c4293cb
VZ
1876bool wxPGProperty::RecreateEditor()
1877{
1878 wxPropertyGrid* pg = GetGrid();
1879 wxASSERT(pg);
1880
1881 wxPGProperty* selected = pg->GetSelection();
1882 if ( this == selected )
1883 {
1884 pg->DoSelectProperty(this, wxPG_SEL_FORCE);
1885 return true;
1886 }
1887 return false;
1888}
1889
1890
1891void wxPGProperty::SetValueImage( wxBitmap& bmp )
1892{
1893 delete m_valueBitmap;
1894
1895 if ( &bmp && bmp.Ok() )
1896 {
1897 // Resize the image
1898 wxSize maxSz = GetGrid()->GetImageSize();
1899 wxSize imSz(bmp.GetWidth(),bmp.GetHeight());
1900
1901 if ( imSz.x != maxSz.x || imSz.y != maxSz.y )
1902 {
1903 // Create a memory DC
1904 wxBitmap* bmpNew = new wxBitmap(maxSz.x,maxSz.y,bmp.GetDepth());
1905
1906 wxMemoryDC dc;
1907 dc.SelectObject(*bmpNew);
1908
1909 // Scale
1910 // FIXME: This is ugly - use image or wait for scaling patch.
1911 double scaleX = (double)maxSz.x / (double)imSz.x;
1912 double scaleY = (double)maxSz.y / (double)imSz.y;
1913
1914 dc.SetUserScale(scaleX,scaleY);
1915
1916 dc.DrawBitmap( bmp, 0, 0 );
1917
1918 m_valueBitmap = bmpNew;
1919 }
1920 else
1921 {
1922 m_valueBitmap = new wxBitmap(bmp);
1923 }
1924
1925 m_flags |= wxPG_PROP_CUSTOMIMAGE;
1926 }
1927 else
1928 {
1929 m_valueBitmap = NULL;
1930 m_flags &= ~(wxPG_PROP_CUSTOMIMAGE);
1931 }
1932}
1933
1934
1935wxPGProperty* wxPGProperty::GetMainParent() const
1936{
1937 const wxPGProperty* curChild = this;
1938 const wxPGProperty* curParent = m_parent;
1939
1940 while ( curParent && !curParent->IsCategory() )
1941 {
1942 curChild = curParent;
1943 curParent = curParent->m_parent;
1944 }
1945
1946 return (wxPGProperty*) curChild;
1947}
1948
1949
1950const wxPGProperty* wxPGProperty::GetLastVisibleSubItem() const
1951{
1952 //
1953 // Returns last visible sub-item, recursively.
1954 if ( !IsExpanded() || !GetChildCount() )
1955 return this;
1956
1957 return Last()->GetLastVisibleSubItem();
1958}
1959
1960
1961bool wxPGProperty::IsVisible() const
1962{
1963 const wxPGProperty* parent;
1964
1965 if ( HasFlag(wxPG_PROP_HIDDEN) )
1966 return false;
1967
1968 for ( parent = GetParent(); parent != NULL; parent = parent->GetParent() )
1969 {
1970 if ( !parent->IsExpanded() || parent->HasFlag(wxPG_PROP_HIDDEN) )
1971 return false;
1972 }
1973
1974 return true;
1975}
1976
1977wxPropertyGrid* wxPGProperty::GetGridIfDisplayed() const
1978{
1979 wxPropertyGridPageState* state = GetParentState();
1980 wxPropertyGrid* propGrid = state->GetGrid();
1981 if ( state == propGrid->GetState() )
1982 return propGrid;
1983 return NULL;
1984}
1985
1986
1987int wxPGProperty::GetY2( int lh ) const
1988{
1989 const wxPGProperty* parent;
1990 const wxPGProperty* child = this;
1991
1992 int y = 0;
1993
1994 for ( parent = GetParent(); parent != NULL; parent = child->GetParent() )
1995 {
1996 if ( !parent->IsExpanded() )
1997 return -1;
1998 y += parent->GetChildrenHeight(lh, child->GetIndexInParent());
1999 y += lh;
2000 child = parent;
2001 }
2002
2003 y -= lh; // need to reduce one level
2004
2005 return y;
2006}
2007
2008
2009int wxPGProperty::GetY() const
2010{
2011 return GetY2(GetGrid()->GetRowHeight());
2012}
2013
1c4293cb
VZ
2014// This is used by Insert etc.
2015void wxPGProperty::AddChild2( wxPGProperty* prop, int index, bool correct_mode )
2016{
f7a094e1 2017 if ( index < 0 || (size_t)index >= m_children.size() )
1c4293cb 2018 {
f7a094e1
JS
2019 if ( correct_mode ) prop->m_arrIndex = m_children.size();
2020 m_children.push_back( prop );
1c4293cb
VZ
2021 }
2022 else
2023 {
f7a094e1 2024 m_children.insert( m_children.begin()+index, prop);
1b895132 2025 if ( correct_mode ) FixIndicesOfChildren( index );
1c4293cb
VZ
2026 }
2027
2028 prop->m_parent = this;
2029}
2030
2031// This is used by properties that have fixed sub-properties
2032void wxPGProperty::AddChild( wxPGProperty* prop )
2033{
d665918b
JS
2034 wxASSERT_MSG( prop->GetBaseName().length(),
2035 "Property's children must have unique, non-empty names within their scope" );
2036
f7a094e1
JS
2037 prop->m_arrIndex = m_children.size();
2038 m_children.push_back( prop );
1c4293cb
VZ
2039
2040 int custImgHeight = prop->OnMeasureImage().y;
2041 if ( custImgHeight < 0 /*|| custImgHeight > 1*/ )
2042 prop->m_flags |= wxPG_PROP_CUSTOMIMAGE;
2043
2044 prop->m_parent = this;
2045}
2046
d8c74d04
JS
2047void wxPGProperty::RemoveChild( wxPGProperty* p )
2048{
2049 wxArrayPGProperty::iterator it;
2050 wxArrayPGProperty& children = m_children;
2051
2052 for ( it=children.begin(); it != children.end(); it++ )
2053 {
2054 if ( *it == p )
2055 {
2056 m_children.erase(it);
2057 break;
2058 }
2059 }
2060}
1c4293cb
VZ
2061
2062void wxPGProperty::AdaptListToValue( wxVariant& list, wxVariant* value ) const
2063{
2064 wxASSERT( GetChildCount() );
2065 wxASSERT( !IsCategory() );
2066
2067 *value = GetValue();
2068
2069 if ( !list.GetCount() )
2070 return;
2071
2072 wxASSERT( GetChildCount() >= (unsigned int)list.GetCount() );
2073
2074 bool allChildrenSpecified;
2075
2076 // Don't fully update aggregate properties unless all children have
2077 // specified value
2078 if ( HasFlag(wxPG_PROP_AGGREGATE) )
2079 allChildrenSpecified = AreAllChildrenSpecified(&list);
2080 else
2081 allChildrenSpecified = true;
2082
2083 wxVariant childValue = list[0];
2084 unsigned int i;
2085 unsigned int n = 0;
2086
d665918b 2087 //wxLogDebug(wxT(">> %s.AdaptListToValue()"),GetBaseName().c_str());
1c4293cb
VZ
2088
2089 for ( i=0; i<GetChildCount(); i++ )
2090 {
2091 const wxPGProperty* child = Item(i);
2092
d665918b 2093 if ( childValue.GetName() == child->GetBaseName() )
1c4293cb
VZ
2094 {
2095 //wxLogDebug(wxT(" %s(n=%i), %s"),childValue.GetName().c_str(),n,childValue.GetType().c_str());
2096
0372d42e 2097 if ( childValue.GetType() == wxPG_VARIANT_TYPE_LIST )
1c4293cb
VZ
2098 {
2099 wxVariant cv2(child->GetValue());
2100 child->AdaptListToValue(childValue, &cv2);
2101 childValue = cv2;
2102 }
2103
2104 if ( allChildrenSpecified )
2105 ChildChanged(*value, i, childValue);
2106 n++;
2107 if ( n == (unsigned int)list.GetCount() )
2108 break;
2109 childValue = list[n];
2110 }
2111 }
2112}
2113
2114
1b895132 2115void wxPGProperty::FixIndicesOfChildren( unsigned int starthere )
1c4293cb
VZ
2116{
2117 size_t i;
2118 for ( i=starthere;i<GetChildCount();i++)
2119 Item(i)->m_arrIndex = i;
2120}
2121
2122
2123// Returns (direct) child property with given name (or NULL if not found)
2124wxPGProperty* wxPGProperty::GetPropertyByName( const wxString& name ) const
2125{
2126 size_t i;
2127
2128 for ( i=0; i<GetChildCount(); i++ )
2129 {
2130 wxPGProperty* p = Item(i);
2131 if ( p->m_name == name )
2132 return p;
2133 }
2134
2135 // Does it have point, then?
2136 int pos = name.Find(wxS('.'));
2137 if ( pos <= 0 )
d3b9f782 2138 return NULL;
1c4293cb
VZ
2139
2140 wxPGProperty* p = GetPropertyByName(name. substr(0,pos));
2141
2142 if ( !p || !p->GetChildCount() )
2143 return NULL;
2144
2145 return p->GetPropertyByName(name.substr(pos+1,name.length()-pos-1));
2146}
2147
d665918b 2148wxPGProperty* wxPGProperty::GetPropertyByNameWH( const wxString& name, unsigned int hintIndex ) const
1c4293cb
VZ
2149{
2150 unsigned int i = hintIndex;
2151
2152 if ( i >= GetChildCount() )
2153 i = 0;
2154
2155 unsigned int lastIndex = i - 1;
2156
2157 if ( lastIndex >= GetChildCount() )
2158 lastIndex = GetChildCount() - 1;
2159
2160 for (;;)
2161 {
2162 wxPGProperty* p = Item(i);
d665918b 2163 if ( p->m_name == name )
1c4293cb
VZ
2164 return p;
2165
2166 if ( i == lastIndex )
2167 break;
2168
2169 i++;
2170 if ( i == GetChildCount() )
2171 i = 0;
2172 };
2173
2174 return NULL;
2175}
2176
2177int wxPGProperty::GetChildrenHeight( int lh, int iMax_ ) const
2178{
2179 // Returns height of children, recursively, and
2180 // by taking expanded/collapsed status into account.
2181 //
2182 // iMax is used when finding property y-positions.
2183 //
2184 unsigned int i = 0;
2185 int h = 0;
2186
2187 if ( iMax_ == -1 )
2188 iMax_ = GetChildCount();
2189
2190 unsigned int iMax = iMax_;
2191
2192 wxASSERT( iMax <= GetChildCount() );
2193
2194 if ( !IsExpanded() && GetParent() )
2195 return 0;
2196
2197 while ( i < iMax )
2198 {
2199 wxPGProperty* pwc = (wxPGProperty*) Item(i);
2200
2201 if ( !pwc->HasFlag(wxPG_PROP_HIDDEN) )
2202 {
2203 if ( !pwc->IsExpanded() ||
2204 pwc->GetChildCount() == 0 )
2205 h += lh;
2206 else
2207 h += pwc->GetChildrenHeight(lh) + lh;
2208 }
2209
2210 i++;
2211 }
2212
2213 return h;
2214}
2215
2216wxPGProperty* wxPGProperty::GetItemAtY( unsigned int y, unsigned int lh, unsigned int* nextItemY ) const
2217{
2218 wxASSERT( nextItemY );
2219
2220 // Linear search at the moment
2221 //
2222 // nextItemY = y of next visible property, final value will be written back.
2223 wxPGProperty* result = NULL;
2224 wxPGProperty* current = NULL;
2225 unsigned int iy = *nextItemY;
2226 unsigned int i = 0;
2227 unsigned int iMax = GetChildCount();
2228
2229 while ( i < iMax )
2230 {
2231 wxPGProperty* pwc = Item(i);
2232
2233 if ( !pwc->HasFlag(wxPG_PROP_HIDDEN) )
2234 {
2235 // Found?
2236 if ( y < iy )
2237 {
2238 result = current;
2239 break;
2240 }
2241
2242 iy += lh;
2243
2244 if ( pwc->IsExpanded() &&
2245 pwc->GetChildCount() > 0 )
2246 {
2247 result = (wxPGProperty*) pwc->GetItemAtY( y, lh, &iy );
2248 if ( result )
2249 break;
2250 }
2251
2252 current = pwc;
2253 }
2254
2255 i++;
2256 }
2257
2258 // Found?
2259 if ( !result && y < iy )
2260 result = current;
2261
2262 *nextItemY = iy;
2263
2264 /*
2265 if ( current )
2266 wxLogDebug(wxT("%s::GetItemAtY(%i) -> %s"),this->GetLabel().c_str(),y,current->GetLabel().c_str());
2267 else
2268 wxLogDebug(wxT("%s::GetItemAtY(%i) -> NULL"),this->GetLabel().c_str(),y);
2269 */
2270
2271 return (wxPGProperty*) result;
2272}
2273
2274void wxPGProperty::Empty()
2275{
2276 size_t i;
2277 if ( !HasFlag(wxPG_PROP_CHILDREN_ARE_COPIES) )
2278 {
2279 for ( i=0; i<GetChildCount(); i++ )
2280 {
f7a094e1 2281 delete m_children[i];
1c4293cb
VZ
2282 }
2283 }
2284
f7a094e1 2285 m_children.clear();
1c4293cb
VZ
2286}
2287
91c818f8
JS
2288void wxPGProperty::DeleteChildren()
2289{
2290 wxPropertyGridPageState* state = m_parentState;
2291
2292 while ( GetChildCount() )
2293 {
2294 wxPGProperty* child = Item(GetChildCount()-1);
2295 state->DoDelete(child, true);
2296 }
2297}
2298
1c4293cb
VZ
2299void wxPGProperty::ChildChanged( wxVariant& WXUNUSED(thisValue),
2300 int WXUNUSED(childIndex),
2301 wxVariant& WXUNUSED(childValue) ) const
2302{
2303}
2304
2305bool wxPGProperty::AreAllChildrenSpecified( wxVariant* pendingList ) const
2306{
2307 unsigned int i;
2308
2309 const wxVariantList* pList = NULL;
2310 wxVariantList::const_iterator node;
2311
2312 if ( pendingList )
2313 {
2314 pList = &pendingList->GetList();
2315 node = pList->begin();
2316 }
2317
1c4293cb
VZ
2318 for ( i=0; i<GetChildCount(); i++ )
2319 {
2320 wxPGProperty* child = Item(i);
2321 const wxVariant* listValue = NULL;
2322 wxVariant value;
2323
2324 if ( pendingList )
2325 {
d665918b 2326 const wxString& childName = child->GetBaseName();
1c4293cb 2327
b7bc9d80 2328 for ( ; node != pList->end(); ++node )
1c4293cb
VZ
2329 {
2330 const wxVariant& item = *((const wxVariant*)*node);
d665918b 2331 if ( item.GetName() == childName )
1c4293cb
VZ
2332 {
2333 listValue = &item;
2334 value = item;
2335 break;
2336 }
2337 }
2338 }
2339
2340 if ( !listValue )
2341 value = child->GetValue();
2342
2343 if ( value.IsNull() )
2344 return false;
2345
2346 // Check recursively
2347 if ( child->GetChildCount() )
2348 {
2349 const wxVariant* childList = NULL;
2350
0372d42e 2351 if ( listValue && listValue->GetType() == wxPG_VARIANT_TYPE_LIST )
1c4293cb
VZ
2352 childList = listValue;
2353
2354 if ( !child->AreAllChildrenSpecified((wxVariant*)childList) )
2355 return false;
2356 }
2357 }
2358
2359 return true;
2360}
2361
2362wxPGProperty* wxPGProperty::UpdateParentValues()
2363{
2364 wxPGProperty* parent = m_parent;
2365 if ( parent && parent->HasFlag(wxPG_PROP_COMPOSED_VALUE) &&
2366 !parent->IsCategory() && !parent->IsRoot() )
2367 {
2368 wxString s;
c82a80e8 2369 parent->DoGenerateComposedValue(s);
1c4293cb
VZ
2370 parent->m_value = s;
2371 return parent->UpdateParentValues();
2372 }
2373 return this;
2374}
2375
2376bool wxPGProperty::IsTextEditable() const
2377{
2378 if ( HasFlag(wxPG_PROP_READONLY) )
2379 return false;
2380
2381 if ( HasFlag(wxPG_PROP_NOEDITOR) &&
2382 (GetChildCount() ||
2383 wxString(GetEditorClass()->GetClassInfo()->GetClassName()).EndsWith(wxS("Button")))
2384 )
2385 return false;
2386
2387 return true;
2388}
2389
1c4293cb
VZ
2390// Call after fixed sub-properties added/removed after creation.
2391// if oldSelInd >= 0 and < new max items, then selection is
2392// moved to it. Note: oldSelInd -2 indicates that this property
2393// should be selected.
2394void wxPGProperty::SubPropsChanged( int oldSelInd )
2395{
2396 wxPropertyGridPageState* state = GetParentState();
2397 wxPropertyGrid* grid = state->GetGrid();
2398
2fd4a524
JS
2399 //
2400 // Re-repare children (recursively)
2401 for ( unsigned int i=0; i<GetChildCount(); i++ )
2402 {
2403 wxPGProperty* child = Item(i);
2404 child->InitAfterAdded(state, grid);
2405 }
1c4293cb 2406
d3b9f782 2407 wxPGProperty* sel = NULL;
f7a094e1
JS
2408 if ( oldSelInd >= (int)m_children.size() )
2409 oldSelInd = (int)m_children.size() - 1;
1c4293cb
VZ
2410
2411 if ( oldSelInd >= 0 )
f7a094e1 2412 sel = m_children[oldSelInd];
1c4293cb
VZ
2413 else if ( oldSelInd == -2 )
2414 sel = this;
2415
2416 if ( sel )
2417 state->DoSelectProperty(sel);
2418
2419 if ( state == grid->GetState() )
2420 {
2421 grid->GetPanel()->Refresh();
2422 }
2423}
2424
2425// -----------------------------------------------------------------------
2426// wxPGRootProperty
2427// -----------------------------------------------------------------------
2428
2429WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(wxPGRootProperty,none,TextCtrl)
2430IMPLEMENT_DYNAMIC_CLASS(wxPGRootProperty, wxPGProperty)
2431
2432
94b8ecf1 2433wxPGRootProperty::wxPGRootProperty( const wxString& name )
1c4293cb
VZ
2434 : wxPGProperty()
2435{
2436#ifdef __WXDEBUG__
94b8ecf1
JS
2437 m_name = name;
2438 m_label = m_name;
2439#else
2440 wxUnusedVar(name);
1c4293cb
VZ
2441#endif
2442 SetParentalType(0);
2443 m_depth = 0;
2444}
2445
2446
2447wxPGRootProperty::~wxPGRootProperty()
2448{
2449}
2450
2451
2452// -----------------------------------------------------------------------
2453// wxPropertyCategory
2454// -----------------------------------------------------------------------
2455
2456WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(wxPropertyCategory,none,TextCtrl)
2457IMPLEMENT_DYNAMIC_CLASS(wxPropertyCategory, wxPGProperty)
2458
2459void wxPropertyCategory::Init()
2460{
2461 // don't set colour - prepareadditem method should do this
2462 SetParentalType(wxPG_PROP_CATEGORY);
2463 m_capFgColIndex = 1;
2464 m_textExtent = -1;
2465}
2466
2467wxPropertyCategory::wxPropertyCategory()
2468 : wxPGProperty()
2469{
2470 Init();
2471}
2472
2473
2474wxPropertyCategory::wxPropertyCategory( const wxString &label, const wxString& name )
2475 : wxPGProperty(label,name)
2476{
2477 Init();
2478}
2479
2480
2481wxPropertyCategory::~wxPropertyCategory()
2482{
2483}
2484
2485
1425eca5
JS
2486wxString wxPropertyCategory::ValueToString( wxVariant& WXUNUSED(value),
2487 int WXUNUSED(argFlags) ) const
1c4293cb
VZ
2488{
2489 return wxEmptyString;
2490}
2491
2492int wxPropertyCategory::GetTextExtent( const wxWindow* wnd, const wxFont& font ) const
2493{
2494 if ( m_textExtent > 0 )
2495 return m_textExtent;
2496 int x = 0, y = 0;
2497 ((wxWindow*)wnd)->GetTextExtent( m_label, &x, &y, 0, 0, &font );
2498 return x;
2499}
2500
2501void wxPropertyCategory::CalculateTextExtent( wxWindow* wnd, const wxFont& font )
2502{
2503 int x = 0, y = 0;
2504 wnd->GetTextExtent( m_label, &x, &y, 0, 0, &font );
2505 m_textExtent = x;
2506}
2507
2728c3bf
JS
2508// -----------------------------------------------------------------------
2509// wxPGChoices
2510// -----------------------------------------------------------------------
2511
2512wxPGChoiceEntry& wxPGChoices::Add( const wxString& label, int value )
2513{
2514 AllocExclusive();
2515
2516 wxPGChoiceEntry entry(label, value);
2517 return m_data->Insert( -1, entry );
2518}
2519
2520// -----------------------------------------------------------------------
2521
2522wxPGChoiceEntry& wxPGChoices::Add( const wxString& label, const wxBitmap& bitmap, int value )
2523{
2524 AllocExclusive();
2525
2526 wxPGChoiceEntry entry(label, value);
2527 entry.SetBitmap(bitmap);
2528 return m_data->Insert( -1, entry );
2529}
2530
2531// -----------------------------------------------------------------------
2532
2533wxPGChoiceEntry& wxPGChoices::Insert( const wxPGChoiceEntry& entry, int index )
2534{
2535 AllocExclusive();
2536
2537 return m_data->Insert( index, entry );
2538}
2539
2540// -----------------------------------------------------------------------
2541
2542wxPGChoiceEntry& wxPGChoices::Insert( const wxString& label, int index, int value )
2543{
2544 AllocExclusive();
2545
2546 wxPGChoiceEntry entry(label, value);
2547 return m_data->Insert( index, entry );
2548}
2549
2550// -----------------------------------------------------------------------
2551
2552wxPGChoiceEntry& wxPGChoices::AddAsSorted( const wxString& label, int value )
2553{
2554 AllocExclusive();
2555
2556 size_t index = 0;
2557
2558 while ( index < GetCount() )
2559 {
2560 int cmpRes = GetLabel(index).Cmp(label);
2561 if ( cmpRes > 0 )
2562 break;
2563 index++;
2564 }
2565
2566 wxPGChoiceEntry entry(label, value);
2567 return m_data->Insert( index, entry );
2568}
2569
2570// -----------------------------------------------------------------------
2571
2572void wxPGChoices::Add( const wxChar** labels, const ValArrItem* values )
2573{
2574 AllocExclusive();
2575
2576 unsigned int itemcount = 0;
2577 const wxChar** p = &labels[0];
2578 while ( *p ) { p++; itemcount++; }
2579
2580 unsigned int i;
2581 for ( i = 0; i < itemcount; i++ )
2582 {
2583 int value = i;
2584 if ( values )
2585 value = values[i];
2586 wxPGChoiceEntry entry(labels[i], value);
2587 m_data->Insert( i, entry );
2588 }
2589}
2590
2591// -----------------------------------------------------------------------
2592
2593void wxPGChoices::Add( const wxArrayString& arr, const wxArrayInt& arrint )
2594{
2595 AllocExclusive();
2596
2597 unsigned int i;
2598 unsigned int itemcount = arr.size();
2599
2600 for ( i = 0; i < itemcount; i++ )
2601 {
2602 int value = i;
2603 if ( &arrint && arrint.size() )
2604 value = arrint[i];
2605 wxPGChoiceEntry entry(arr[i], value);
2606 m_data->Insert( i, entry );
2607 }
2608}
2609
2610// -----------------------------------------------------------------------
2611
2612void wxPGChoices::RemoveAt(size_t nIndex, size_t count)
2613{
2614 AllocExclusive();
2615
2616 wxASSERT( m_data->m_refCount != 0xFFFFFFF );
2617 m_data->m_items.erase(m_data->m_items.begin()+nIndex,
2618 m_data->m_items.begin()+nIndex+count);
2619}
2620
2621// -----------------------------------------------------------------------
2622
2623void wxPGChoices::Clear()
2624{
2625 if ( m_data != wxPGChoicesEmptyData )
2626 {
2627 AllocExclusive();
2628 m_data->Clear();
2629 }
2630}
2631
2632// -----------------------------------------------------------------------
2633
2634int wxPGChoices::Index( const wxString& str ) const
2635{
2636 if ( IsOk() )
2637 {
2638 unsigned int i;
2639 for ( i=0; i< m_data->GetCount(); i++ )
2640 {
2641 const wxPGChoiceEntry& entry = m_data->Item(i);
2642 if ( entry.HasText() && entry.GetText() == str )
2643 return i;
2644 }
2645 }
2646 return -1;
2647}
2648
2649// -----------------------------------------------------------------------
2650
2651int wxPGChoices::Index( int val ) const
2652{
2653 if ( IsOk() )
2654 {
2655 unsigned int i;
2656 for ( i=0; i< m_data->GetCount(); i++ )
2657 {
2658 const wxPGChoiceEntry& entry = m_data->Item(i);
2659 if ( entry.GetValue() == val )
2660 return i;
2661 }
2662 }
2663 return -1;
2664}
2665
2666// -----------------------------------------------------------------------
2667
2668wxArrayString wxPGChoices::GetLabels() const
2669{
2670 wxArrayString arr;
2671 unsigned int i;
2672
2673 if ( this && IsOk() )
2674 for ( i=0; i<GetCount(); i++ )
2675 arr.push_back(GetLabel(i));
2676
2677 return arr;
2678}
2679
2680// -----------------------------------------------------------------------
2681
2682wxArrayInt wxPGChoices::GetValuesForStrings( const wxArrayString& strings ) const
2683{
2684 wxArrayInt arr;
2685
2686 if ( IsOk() )
2687 {
2688 unsigned int i;
2689 for ( i=0; i< strings.size(); i++ )
2690 {
2691 int index = Index(strings[i]);
2692 if ( index >= 0 )
2693 arr.Add(GetValue(index));
2694 else
2695 arr.Add(wxPG_INVALID_VALUE);
2696 }
2697 }
2698
2699 return arr;
2700}
2701
2702// -----------------------------------------------------------------------
2703
2704wxArrayInt wxPGChoices::GetIndicesForStrings( const wxArrayString& strings,
2705 wxArrayString* unmatched ) const
2706{
2707 wxArrayInt arr;
2708
2709 if ( IsOk() )
2710 {
2711 unsigned int i;
2712 for ( i=0; i< strings.size(); i++ )
2713 {
2714 const wxString& str = strings[i];
2715 int index = Index(str);
2716 if ( index >= 0 )
2717 arr.Add(index);
2718 else if ( unmatched )
2719 unmatched->Add(str);
2720 }
2721 }
2722
2723 return arr;
2724}
2725
2726// -----------------------------------------------------------------------
2727
2728void wxPGChoices::AllocExclusive()
2729{
2730 EnsureData();
2731
2732 if ( m_data->m_refCount != 1 )
2733 {
2734 wxPGChoicesData* data = new wxPGChoicesData();
2735 data->CopyDataFrom(m_data);
2736 Free();
2737 m_data = data;
2738 }
2739}
2740
2741// -----------------------------------------------------------------------
2742
2743void wxPGChoices::AssignData( wxPGChoicesData* data )
2744{
2745 Free();
2746
2747 if ( data != wxPGChoicesEmptyData )
2748 {
2749 m_data = data;
2750 data->m_refCount++;
2751 }
2752}
2753
2754// -----------------------------------------------------------------------
2755
2756void wxPGChoices::Init()
2757{
2758 m_data = wxPGChoicesEmptyData;
2759}
2760
2761// -----------------------------------------------------------------------
2762
2763void wxPGChoices::Free()
2764{
2765 if ( m_data != wxPGChoicesEmptyData )
2766 {
2767 m_data->DecRef();
2768 m_data = wxPGChoicesEmptyData;
2769 }
2770}
2771
1c4293cb
VZ
2772// -----------------------------------------------------------------------
2773// wxPGAttributeStorage
2774// -----------------------------------------------------------------------
2775
2776wxPGAttributeStorage::wxPGAttributeStorage()
2777{
2778}
2779
2780wxPGAttributeStorage::~wxPGAttributeStorage()
2781{
2782 wxPGHashMapS2P::iterator it;
2783
b7bc9d80 2784 for ( it = m_map.begin(); it != m_map.end(); ++it )
1c4293cb
VZ
2785 {
2786 wxVariantData* data = (wxVariantData*) it->second;
2787 data->DecRef();
2788 }
2789}
2790
2791void wxPGAttributeStorage::Set( const wxString& name, const wxVariant& value )
2792{
2793 wxVariantData* data = value.GetData();
2794
2795 // Free old, if any
2796 wxPGHashMapS2P::iterator it = m_map.find(name);
2797 if ( it != m_map.end() )
1802a91d 2798 {
1c4293cb
VZ
2799 ((wxVariantData*)it->second)->DecRef();
2800
1802a91d
JS
2801 if ( !data )
2802 {
2803 // If Null variant, just remove from set
2804 m_map.erase(it);
2805 return;
2806 }
2807 }
2808
1c4293cb 2809 if ( data )
1802a91d 2810 {
1c4293cb
VZ
2811 data->IncRef();
2812
1802a91d
JS
2813 m_map[name] = data;
2814 }
1c4293cb
VZ
2815}
2816
f4bc1aa2 2817#endif // wxUSE_PROPGRID