1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/propgrid/property.cpp
3 // Purpose: wxPGProperty and related support classes
4 // Author: Jaakko Salli
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx/wx.h".
13 #include "wx/wxprec.h"
23 #include "wx/object.h"
25 #include "wx/string.h"
28 #include "wx/window.h"
31 #include "wx/dcmemory.h"
34 #include "wx/settings.h"
38 #include "wx/propgrid/propgrid.h"
41 #define PWC_CHILD_SUMMARY_LIMIT 16 // Maximum number of children summarized in a parent property's
44 #define PWC_CHILD_SUMMARY_CHAR_LIMIT 64 // Character limit of summary field when not editing
46 #if wxPG_COMPATIBILITY_1_4
48 // Used to establish backwards compatiblity
49 const char* g_invalidStringContent
= "@__TOTALLY_INVALID_STRING__@";
53 // -----------------------------------------------------------------------
55 static void wxPGDrawFocusRect( wxDC
& dc
, const wxRect
& rect
)
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
);
63 wxPen
pen(*wxBLACK
,1,wxDOT
);
64 pen
.SetCap(wxCAP_BUTT
);
66 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
68 dc
.DrawRectangle(rect
);
70 dc
.SetLogicalFunction(wxCOPY
);
72 dc
.SetLogicalFunction(wxINVERT
);
74 dc
.SetPen(wxPen(*wxBLACK
,1,wxDOT
));
75 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
77 dc
.DrawRectangle(rect
);
79 dc
.SetLogicalFunction(wxCOPY
);
83 // -----------------------------------------------------------------------
85 // -----------------------------------------------------------------------
87 wxSize
wxPGCellRenderer::GetImageSize( const wxPGProperty
* WXUNUSED(property
),
89 int WXUNUSED(item
) ) const
94 void wxPGCellRenderer::DrawText( wxDC
& dc
, const wxRect
& rect
,
95 int xOffset
, const wxString
& text
) const
98 xOffset
+= wxCC_CUSTOM_IMAGE_MARGIN1
+ wxCC_CUSTOM_IMAGE_MARGIN2
;
100 rect
.x
+xOffset
+wxPG_XBEFORETEXT
,
101 rect
.y
+((rect
.height
-dc
.GetCharHeight())/2) );
104 void wxPGCellRenderer::DrawEditorValue( wxDC
& dc
, const wxRect
& rect
,
105 int xOffset
, const wxString
& text
,
106 wxPGProperty
* property
,
107 const wxPGEditor
* editor
) const
110 xOffset
+= wxCC_CUSTOM_IMAGE_MARGIN1
+ wxCC_CUSTOM_IMAGE_MARGIN2
;
112 int yOffset
= ((rect
.height
-dc
.GetCharHeight())/2);
119 rect2
.height
-= yOffset
;
120 editor
->DrawValue( dc
, rect2
, property
, text
);
125 rect
.x
+xOffset
+wxPG_XBEFORETEXT
,
130 void wxPGCellRenderer::DrawCaptionSelectionRect( wxDC
& dc
, int x
, int y
, int w
, int h
) const
132 wxRect
focusRect(x
,y
+((h
-dc
.GetCharHeight())/2),w
,h
);
133 wxPGDrawFocusRect(dc
,focusRect
);
136 int wxPGCellRenderer::PreDrawCell( wxDC
& dc
, const wxRect
& rect
, const wxPGCell
& cell
, int flags
) const
140 // If possible, use cell colours
141 if ( !(flags
& DontUseCellBgCol
) )
143 dc
.SetPen(cell
.GetBgCol());
144 dc
.SetBrush(cell
.GetBgCol());
147 if ( !(flags
& DontUseCellFgCol
) )
149 dc
.SetTextForeground(cell
.GetFgCol());
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
);
157 const wxBitmap
& bmp
= cell
.GetBitmap();
159 // Do not draw oversized bitmap outside choice popup
160 ((flags
& ChoicePopup
) || bmp
.GetHeight() < rect
.height
)
164 rect
.x
+ wxPG_CONTROL_MARGIN
+ wxCC_CUSTOM_IMAGE_MARGIN1
,
165 rect
.y
+ wxPG_CUSTOM_IMAGE_SPACINGY
,
167 imageOffset
= bmp
.GetWidth();
173 // -----------------------------------------------------------------------
174 // wxPGDefaultRenderer
175 // -----------------------------------------------------------------------
177 void wxPGDefaultRenderer::Render( wxDC
& dc
, const wxRect
& rect
,
178 const wxPropertyGrid
* propertyGrid
, wxPGProperty
* property
,
179 int column
, int item
, int flags
) const
181 bool isUnspecified
= property
->IsValueUnspecified();
183 if ( column
== 1 && item
== -1 )
185 int cmnVal
= property
->GetCommonValue();
189 if ( !isUnspecified
)
190 DrawText( dc
, rect
, 0, propertyGrid
->GetCommonValueLabel(cmnVal
) );
195 const wxPGEditor
* editor
= NULL
;
196 const wxPGCell
* cell
= NULL
;
200 int preDrawFlags
= flags
;
202 property
->GetDisplayInfo(column
, item
, flags
, &text
, &cell
);
204 imageOffset
= PreDrawCell( dc
, rect
, *cell
, preDrawFlags
);
208 if ( !isUnspecified
)
210 editor
= property
->GetColumnEditor(column
);
212 // Regular property value
214 wxSize imageSize
= propertyGrid
->GetImageSize(property
, item
);
216 wxPGPaintData paintdata
;
217 paintdata
.m_parent
= propertyGrid
;
218 paintdata
.m_choiceItem
= item
;
220 if ( imageSize
.x
> 0 )
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));
227 dc
.SetPen( wxPen(propertyGrid
->GetCellTextColour(), 1, wxSOLID
) );
229 paintdata
.m_drawnWidth
= imageSize
.x
;
230 paintdata
.m_drawnHeight
= imageSize
.y
;
232 property
->OnCustomPaint( dc
, imageRect
, paintdata
);
234 imageOffset
= paintdata
.m_drawnWidth
;
237 text
= property
->GetValueAsString();
240 if ( propertyGrid
->GetColumnCount() <= 2 )
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() );
248 if ( text
.length() == 0 )
250 // Try to show inline help if no text
251 wxVariant vInlineHelp
= property
->GetAttribute(wxPGGlobalVars
->m_strInlineHelp
);
252 if ( !vInlineHelp
.IsNull() )
254 text
= vInlineHelp
.GetString();
255 dc
.SetTextForeground(propertyGrid
->GetCellDisabledTextColour());
260 DrawEditorValue( dc
, rect
, imageOffset
, text
, property
, editor
);
262 // active caption gets nice dotted rectangle
263 if ( property
->IsCategory() /*&& column == 0*/ )
265 if ( flags
& Selected
)
267 if ( imageOffset
> 0 )
268 imageOffset
+= wxCC_CUSTOM_IMAGE_MARGIN2
+ 4;
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) );
281 wxSize
wxPGDefaultRenderer::GetImageSize( const wxPGProperty
* property
,
285 if ( property
&& column
== 1 )
289 wxBitmap
* bmp
= property
->GetValueImage();
291 if ( bmp
&& bmp
->Ok() )
292 return wxSize(bmp
->GetWidth(),bmp
->GetHeight());
298 // -----------------------------------------------------------------------
300 // -----------------------------------------------------------------------
302 wxPGCellData::wxPGCellData()
305 m_hasValidText
= false;
308 // -----------------------------------------------------------------------
310 // -----------------------------------------------------------------------
317 wxPGCell::wxPGCell( const wxString
& text
,
318 const wxBitmap
& bitmap
,
319 const wxColour
& fgCol
,
320 const wxColour
& bgCol
)
323 wxPGCellData
* data
= new wxPGCellData();
326 data
->m_bitmap
= bitmap
;
327 data
->m_fgCol
= fgCol
;
328 data
->m_bgCol
= bgCol
;
329 data
->m_hasValidText
= true;
332 wxObjectRefData
*wxPGCell::CloneRefData( const wxObjectRefData
*data
) const
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
;
344 void wxPGCell::SetText( const wxString
& text
)
348 GetData()->SetText(text
);
351 void wxPGCell::SetBitmap( const wxBitmap
& bitmap
)
355 GetData()->SetBitmap(bitmap
);
358 void wxPGCell::SetFgCol( const wxColour
& col
)
362 GetData()->SetFgCol(col
);
365 void wxPGCell::SetBgCol( const wxColour
& col
)
369 GetData()->SetBgCol(col
);
372 void wxPGCell::MergeFrom( const wxPGCell
& srcCell
)
376 wxPGCellData
* data
= GetData();
378 if ( srcCell
.HasText() )
379 data
->SetText(srcCell
.GetText());
381 if ( srcCell
.GetFgCol().IsOk() )
382 data
->SetFgCol(srcCell
.GetFgCol());
384 if ( srcCell
.GetBgCol().IsOk() )
385 data
->SetBgCol(srcCell
.GetBgCol());
387 if ( srcCell
.GetBitmap().IsOk() )
388 data
->SetBitmap(srcCell
.GetBitmap());
391 // -----------------------------------------------------------------------
393 // -----------------------------------------------------------------------
395 IMPLEMENT_ABSTRACT_CLASS(wxPGProperty
, wxObject
)
397 wxString
* wxPGProperty::sm_wxPG_LABEL
= NULL
;
399 void wxPGProperty::Init()
405 m_parentState
= NULL
;
408 m_clientObject
= NULL
;
410 m_customEditor
= NULL
;
414 m_valueBitmap
= NULL
;
416 m_maxLen
= 0; // infinite maximum length
418 m_flags
= wxPG_PROP_PROPERTY
;
426 void wxPGProperty::Init( const wxString
& label
, const wxString
& name
)
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)
431 if ( (&label
) != NULL
&& label
!= wxPG_LABEL
)
434 if ( (&name
) != NULL
&& name
!= wxPG_LABEL
)
437 DoSetName( m_label
);
442 void wxPGProperty::InitAfterAdded( wxPropertyGridPageState
* pageState
,
443 wxPropertyGrid
* propgrid
)
446 // Called after property has been added to grid or page
447 // (so propgrid can be NULL, too).
449 wxPGProperty
* parent
= m_parent
;
450 bool parentIsRoot
= parent
->IsKindOf(CLASSINFO(wxPGRootProperty
));
452 m_parentState
= pageState
;
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()" );
461 if ( !parentIsRoot
&& !parent
->IsCategory() )
463 m_cells
= parent
->m_cells
;
466 // If in hideable adding mode, or if assigned parent is hideable, then
467 // make this one hideable.
469 ( !parentIsRoot
&& parent
->HasFlag(wxPG_PROP_HIDDEN
) ) ||
470 ( propgrid
&& (propgrid
->HasInternalFlag(wxPG_FL_ADDING_HIDEABLES
)) )
472 SetFlag( wxPG_PROP_HIDDEN
);
474 // Set custom image flag.
475 int custImgHeight
= OnMeasureImage().y
;
476 if ( custImgHeight
< 0 )
478 SetFlag(wxPG_PROP_CUSTOMIMAGE
);
481 if ( propgrid
&& (propgrid
->HasFlag(wxPG_LIMITED_EDITING
)) )
482 SetFlag(wxPG_PROP_NOEDITOR
);
484 // Make sure parent has some parental flags
485 if ( !parent
->HasFlag(wxPG_PROP_PARENTAL_FLAGS
) )
486 parent
->SetParentalType(wxPG_PROP_MISC_PARENT
);
490 // This is not a category.
494 unsigned char depth
= 1;
497 depth
= parent
->m_depth
;
498 if ( !parent
->IsCategory() )
502 unsigned char greyDepth
= depth
;
506 wxPropertyCategory
* pc
;
508 if ( parent
->IsCategory() )
509 pc
= (wxPropertyCategory
* ) parent
;
511 // This conditional compile is necessary to
512 // bypass some compiler bug.
513 pc
= pageState
->GetPropertyCategory(parent
);
516 greyDepth
= pc
->GetDepth();
518 greyDepth
= parent
->m_depthBgCol
;
521 m_depthBgCol
= greyDepth
;
525 // This is a category.
528 unsigned char depth
= 1;
531 depth
= parent
->m_depth
+ 1;
534 m_depthBgCol
= depth
;
538 // Has initial children
539 if ( GetChildCount() )
541 // Check parental flags
542 wxASSERT_MSG( (m_flags
& wxPG_PROP_PARENTAL_FLAGS
),
543 "Call SetFlag(wxPG_PROP_MISC_PARENT) or"
544 "SetFlag(wxPG_PROP_AGGREGATE) before calling"
545 "wxPGProperty::AddChild()." );
547 if ( HasFlag(wxPG_PROP_AGGREGATE
) )
549 // Properties with private children are not expanded by default.
552 else if ( propgrid
&& propgrid
->HasFlag(wxPG_HIDE_MARGIN
) )
554 // ...unless it cannot be expanded by user and therefore must
555 // remain visible at all times
560 // Prepare children recursively
561 for ( unsigned int i
=0; i
<GetChildCount(); i
++ )
563 wxPGProperty
* child
= Item(i
);
564 child
->InitAfterAdded(pageState
, pageState
->GetGrid());
567 if ( propgrid
&& (propgrid
->GetExtraStyle() & wxPG_EX_AUTO_UNSPECIFIED_VALUES
) )
568 SetFlagRecursively(wxPG_PROP_AUTO_UNSPECIFIED
, true);
572 wxPGProperty::wxPGProperty()
579 wxPGProperty::wxPGProperty( const wxString
& label
, const wxString
& name
)
586 wxPGProperty::~wxPGProperty()
588 delete m_clientObject
;
590 Empty(); // this deletes items
592 delete m_valueBitmap
;
597 // This makes it easier for us to detect dangling pointers
602 bool wxPGProperty::IsSomeParent( wxPGProperty
* candidate
) const
604 wxPGProperty
* parent
= m_parent
;
607 if ( parent
== candidate
)
609 parent
= parent
->m_parent
;
615 wxString
wxPGProperty::GetName() const
617 wxPGProperty
* parent
= GetParent();
619 if ( !m_name
.length() || !parent
|| parent
->IsCategory() || parent
->IsRoot() )
622 return m_parent
->GetName() + wxS(".") + m_name
;
625 wxPropertyGrid
* wxPGProperty::GetGrid() const
627 if ( !m_parentState
)
629 return m_parentState
->GetGrid();
632 int wxPGProperty::Index( const wxPGProperty
* p
) const
634 for ( unsigned int i
= 0; i
<m_children
.size(); i
++ )
636 if ( p
== m_children
[i
] )
642 bool wxPGProperty::ValidateValue( wxVariant
& WXUNUSED(value
), wxPGValidationInfo
& WXUNUSED(validationInfo
) ) const
647 void wxPGProperty::OnSetValue()
651 void wxPGProperty::RefreshChildren ()
655 void wxPGProperty::OnValidationFailure( wxVariant
& WXUNUSED(pendingValue
) )
659 void wxPGProperty::GetDisplayInfo( unsigned int column
,
663 const wxPGCell
** pCell
)
665 const wxPGCell
* cell
= NULL
;
667 if ( !(flags
& wxPGCellRenderer::ChoicePopup
) )
669 // Not painting listi of choice popups, so get text from property
670 cell
= &GetCell(column
);
671 if ( cell
->HasText() )
673 *pString
= cell
->GetText();
678 *pString
= GetLabel();
679 else if ( column
== 1 )
680 *pString
= GetDisplayedString();
681 else if ( column
== 2 )
682 *pString
= GetAttribute(wxPGGlobalVars
->m_strUnits
, wxEmptyString
);
687 wxASSERT( column
== 1 );
689 if ( choiceIndex
!= wxNOT_FOUND
)
691 const wxPGChoiceEntry
& entry
= m_choices
[choiceIndex
];
692 if ( entry
.GetBitmap().IsOk() ||
693 entry
.GetFgCol().IsOk() ||
694 entry
.GetBgCol().IsOk() )
696 *pString
= m_choices
.GetLabel(choiceIndex
);
701 cell
= &GetCell(column
);
703 wxASSERT_MSG( cell
->GetData(),
704 wxString::Format("Invalid cell for property %s",
705 GetName().c_str()) );
711 wxString wxPGProperty::GetColumnText( unsigned int col, int choiceIndex ) const
714 if ( col != 1 || choiceIndex == wxNOT_FOUND )
716 const wxPGCell& cell = GetCell(col);
717 if ( cell->HasText() )
719 return cell->GetText();
726 return GetDisplayedString();
728 return GetAttribute(wxPGGlobalVars->m_strUnits, wxEmptyString);
734 return m_choices.GetLabel(choiceIndex);
737 return wxEmptyString;
741 void wxPGProperty::DoGenerateComposedValue( wxString
& text
,
743 const wxVariantList
* valueOverrides
,
744 wxPGHashMapS2S
* childResults
) const
747 int iMax
= m_children
.size();
753 if ( iMax
> PWC_CHILD_SUMMARY_LIMIT
&&
754 !(argFlags
& wxPG_FULL_VALUE
) )
755 iMax
= PWC_CHILD_SUMMARY_LIMIT
;
757 int iMaxMinusOne
= iMax
-1;
759 if ( !IsTextEditable() )
760 argFlags
|= wxPG_UNEDITABLE_COMPOSITE_FRAGMENT
;
762 wxPGProperty
* curChild
= m_children
[0];
764 bool overridesLeft
= false;
765 wxVariant overrideValue
;
766 wxVariantList::const_iterator node
;
768 if ( valueOverrides
)
770 node
= valueOverrides
->begin();
771 if ( node
!= valueOverrides
->end() )
773 overrideValue
= *node
;
774 overridesLeft
= true;
778 for ( i
= 0; i
< iMax
; i
++ )
780 wxVariant childValue
;
782 wxString childLabel
= curChild
->GetLabel();
784 // Check for value override
785 if ( overridesLeft
&& overrideValue
.GetName() == childLabel
)
787 if ( !overrideValue
.IsNull() )
788 childValue
= overrideValue
;
790 childValue
= curChild
->GetValue();
792 if ( node
!= valueOverrides
->end() )
793 overrideValue
= *node
;
795 overridesLeft
= false;
799 childValue
= curChild
->GetValue();
803 if ( !childValue
.IsNull() )
805 if ( overridesLeft
&&
806 curChild
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) &&
807 childValue
.GetType() == wxPG_VARIANT_TYPE_LIST
)
809 wxVariantList
& childList
= childValue
.GetList();
810 DoGenerateComposedValue(s
, argFlags
|wxPG_COMPOSITE_FRAGMENT
,
811 &childList
, childResults
);
815 s
= curChild
->ValueToString(childValue
,
816 argFlags
|wxPG_COMPOSITE_FRAGMENT
);
820 if ( childResults
&& curChild
->GetChildCount() )
821 (*childResults
)[curChild
->GetName()] = s
;
824 if ( (argFlags
& wxPG_UNEDITABLE_COMPOSITE_FRAGMENT
) && !s
.length() )
827 if ( !curChild
->GetChildCount() || skip
)
830 text
+= wxS("[") + s
+ wxS("]");
832 if ( i
< iMaxMinusOne
)
834 if ( text
.length() > PWC_CHILD_SUMMARY_CHAR_LIMIT
&&
835 !(argFlags
& wxPG_EDITABLE_VALUE
) &&
836 !(argFlags
& wxPG_FULL_VALUE
) )
841 if ( !curChild
->GetChildCount() )
847 curChild
= m_children
[i
+1];
851 if ( (unsigned int)i
< m_children
.size() )
853 if ( !text
.EndsWith(wxS("; ")) )
854 text
+= wxS("; ...");
860 wxString
wxPGProperty::ValueToString( wxVariant
& WXUNUSED(value
),
863 wxCHECK_MSG( GetChildCount() > 0,
865 "If user property does not have any children, it must "
866 "override GetValueAsString" );
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." );
874 DoGenerateComposedValue(text
, argFlags
);
878 wxString
wxPGProperty::GetValueAsString( int argFlags
) const
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 )
886 // Do not override! (for backwards compliancy)
887 return g_invalidStringContent
;
891 if ( IsValueUnspecified() )
892 return wxEmptyString
;
894 if ( m_commonValue
== -1 )
896 wxVariant
value(GetValue());
897 return ValueToString(value
, argFlags
|wxPG_VALUE_IS_CURRENT
);
901 // Return common value's string representation
902 wxPropertyGrid
* pg
= GetGrid();
903 const wxPGCommonValue
* cv
= pg
->GetCommonValue(m_commonValue
);
905 if ( argFlags
& wxPG_FULL_VALUE
)
907 return cv
->GetLabel();
909 else if ( argFlags
& wxPG_EDITABLE_VALUE
)
911 return cv
->GetEditableText();
915 return cv
->GetLabel();
919 wxString
wxPGProperty::GetValueString( int argFlags
) const
921 return GetValueAsString(argFlags
);
924 bool wxPGProperty::IntToValue( wxVariant
& variant
, int number
, int WXUNUSED(argFlags
) ) const
926 variant
= (long)number
;
930 // Convert semicolon delimited tokens into child values.
931 bool wxPGProperty::StringToValue( wxVariant
& variant
, const wxString
& text
, int argFlags
) const
933 if ( !GetChildCount() )
936 unsigned int curChild
= 0;
938 unsigned int iMax
= m_children
.size();
940 if ( iMax
> PWC_CHILD_SUMMARY_LIMIT
&&
941 !(argFlags
& wxPG_FULL_VALUE
) )
942 iMax
= PWC_CHILD_SUMMARY_LIMIT
;
944 bool changed
= false;
949 // Its best only to add non-empty group items
950 bool addOnlyIfNotEmpty
= false;
951 const wxChar delimeter
= wxS(';');
953 size_t tokenStart
= 0xFFFFFF;
955 wxVariantList temp_list
;
956 wxVariant
list(temp_list
);
958 int propagatedFlags
= argFlags
& (wxPG_REPORT_ERROR
|wxPG_PROGRAMMATIC_VALUE
);
961 bool debug_print
= false;
966 wxLogDebug(wxT(">> %s.StringToValue('%s')"),GetLabel().c_str(),text
.c_str());
969 wxString::const_iterator it
= text
.begin();
972 if ( it
!= text
.end() )
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;
984 if ( tokenStart
!= 0xFFFFFF )
987 if ( a
== delimeter
|| a
== 0 )
989 token
= text
.substr(tokenStart
,pos
-tokenStart
);
991 size_t len
= token
.length();
993 if ( !addOnlyIfNotEmpty
|| len
> 0 )
995 const wxPGProperty
* child
= Item(curChild
);
996 wxVariant
variant(child
->GetValue());
997 wxString childName
= child
->GetBaseName();
1001 wxLogDebug(wxT("token = '%s', child = %s"),
1002 token
.c_str(), childName
.c_str());
1005 // Add only if editable or setting programmatically
1006 if ( (argFlags
& wxPG_PROGRAMMATIC_VALUE
) ||
1007 !child
->HasFlag(wxPG_PROP_DISABLED
|wxPG_PROP_READONLY
) )
1011 if ( child
->StringToValue(variant
, token
,
1012 propagatedFlags
|wxPG_COMPOSITE_FRAGMENT
) )
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
);
1023 list
.Append(variant
);
1030 // Empty, becomes unspecified
1032 variant
.SetName(childName
);
1033 list
.Append(variant
);
1039 if ( curChild
>= iMax
)
1043 tokenStart
= 0xFFFFFF;
1048 // Token is not running
1049 if ( a
!= wxS(' ') )
1052 addOnlyIfNotEmpty
= false;
1054 // Is this a group of tokens?
1055 if ( a
== wxS('[') )
1059 if ( it
!= text
.end() ) ++it
;
1061 size_t startPos
= pos
;
1063 // Group item - find end
1064 while ( it
!= text
.end() && depth
> 0 )
1070 if ( a
== wxS(']') )
1072 else if ( a
== wxS('[') )
1076 token
= text
.substr(startPos
,pos
-startPos
-1);
1078 if ( !token
.length() )
1081 const wxPGProperty
* child
= Item(curChild
);
1083 wxVariant oldChildValue
= child
->GetValue();
1084 wxVariant
variant(oldChildValue
);
1086 if ( (argFlags
& wxPG_PROGRAMMATIC_VALUE
) ||
1087 !child
->HasFlag(wxPG_PROP_DISABLED
|wxPG_PROP_READONLY
) )
1089 wxString childName
= child
->GetBaseName();
1091 bool stvRes
= child
->StringToValue( variant
, token
,
1093 if ( stvRes
|| (variant
!= oldChildValue
) )
1095 variant
.SetName(childName
);
1096 list
.Append(variant
);
1107 if ( curChild
>= iMax
)
1110 addOnlyIfNotEmpty
= true;
1112 tokenStart
= 0xFFFFFF;
1118 if ( a
== delimeter
)
1119 strPosIncrement
-= 1;
1127 it
+= strPosIncrement
;
1129 if ( it
!= text
.end() )
1138 pos
+= strPosIncrement
;
1147 bool wxPGProperty::SetValueFromString( const wxString
& text
, int argFlags
)
1149 wxVariant
variant(m_value
);
1150 bool res
= StringToValue(variant
, text
, argFlags
);
1156 bool wxPGProperty::SetValueFromInt( long number
, int argFlags
)
1158 wxVariant
variant(m_value
);
1159 bool res
= IntToValue(variant
, number
, argFlags
);
1165 wxSize
wxPGProperty::OnMeasureImage( int WXUNUSED(item
) ) const
1167 if ( m_valueBitmap
)
1168 return wxSize(m_valueBitmap
->GetWidth(),-1);
1173 wxPGCellRenderer
* wxPGProperty::GetCellRenderer( int WXUNUSED(column
) ) const
1175 return wxPGGlobalVars
->m_defaultRenderer
;
1178 void wxPGProperty::OnCustomPaint( wxDC
& dc
,
1182 wxBitmap
* bmp
= m_valueBitmap
;
1184 wxCHECK_RET( bmp
&& bmp
->Ok(), wxT("invalid bitmap") );
1186 wxCHECK_RET( rect
.x
>= 0, wxT("unexpected measure call") );
1188 dc
.DrawBitmap(*bmp
,rect
.x
,rect
.y
);
1191 const wxPGEditor
* wxPGProperty::DoGetEditorClass() const
1193 return wxPGEditor_TextCtrl
;
1196 // Default extra property event handling - that is, none at all.
1197 bool wxPGProperty::OnEvent( wxPropertyGrid
*, wxWindow
*, wxEvent
& )
1203 void wxPGProperty::SetValue( wxVariant value
, wxVariant
* pList
, int flags
)
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() )
1210 value
= GetDefaultValue();
1213 if ( !value
.IsNull() )
1215 wxVariant tempListVariant
;
1218 // List variants are reserved a special purpose
1219 // as intermediate containers for child values
1220 // of properties with children.
1221 if ( value
.GetType() == wxPG_VARIANT_TYPE_LIST
)
1224 // However, situation is different for composed string properties
1225 if ( HasFlag(wxPG_PROP_COMPOSED_VALUE
) )
1227 tempListVariant
= value
;
1228 pList
= &tempListVariant
;
1232 AdaptListToValue(value
, &newValue
);
1234 //wxLogDebug(wxT(">> %s.SetValue() adapted list value to type '%s'"),GetName().c_str(),value.GetType().c_str());
1237 if ( HasFlag( wxPG_PROP_AGGREGATE
) )
1238 flags
|= wxPG_SETVAL_AGGREGATED
;
1240 if ( pList
&& !pList
->IsNull() )
1242 wxASSERT( pList
->GetType() == wxPG_VARIANT_TYPE_LIST
);
1243 wxASSERT( GetChildCount() );
1244 wxASSERT( !IsCategory() );
1246 wxVariantList
& list
= pList
->GetList();
1247 wxVariantList::iterator node
;
1250 //wxLogDebug(wxT(">> %s.SetValue() pList parsing"),GetName().c_str());
1252 // Children in list can be in any order, but we will give hint to
1253 // GetPropertyByNameWH(). This optimizes for full list parsing.
1254 for ( node
= list
.begin(); node
!= list
.end(); ++node
)
1256 wxVariant
& childValue
= *((wxVariant
*)*node
);
1257 wxPGProperty
* child
= GetPropertyByNameWH(childValue
.GetName(), i
);
1260 //wxLogDebug(wxT("%i: child = %s, childValue.GetType()=%s"),i,child->GetBaseName().c_str(),childValue.GetType().c_str());
1261 if ( childValue
.GetType() == wxPG_VARIANT_TYPE_LIST
)
1263 if ( child
->HasFlag(wxPG_PROP_AGGREGATE
) && !(flags
& wxPG_SETVAL_AGGREGATED
) )
1265 wxVariant listRefCopy
= childValue
;
1266 child
->SetValue(childValue
, &listRefCopy
, flags
|wxPG_SETVAL_FROM_PARENT
);
1270 wxVariant oldVal
= child
->GetValue();
1271 child
->SetValue(oldVal
, &childValue
, flags
|wxPG_SETVAL_FROM_PARENT
);
1274 else if ( child
->GetValue() != childValue
)
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
);
1280 if ( flags
& wxPG_SETVAL_BY_USER
)
1281 child
->SetFlag(wxPG_PROP_MODIFIED
);
1288 if ( !value
.IsNull() )
1294 if ( flags
& wxPG_SETVAL_BY_USER
)
1295 SetFlag(wxPG_PROP_MODIFIED
);
1297 if ( HasFlag(wxPG_PROP_AGGREGATE
) )
1302 if ( m_commonValue
!= -1 )
1304 wxPropertyGrid
* pg
= GetGrid();
1305 if ( !pg
|| m_commonValue
!= pg
->GetUnspecifiedCommonValue() )
1311 // Set children to unspecified, but only if aggregate or
1312 // value is <composed>
1313 if ( AreChildrenComponents() )
1316 for ( i
=0; i
<GetChildCount(); i
++ )
1317 Item(i
)->SetValue(value
, NULL
, flags
|wxPG_SETVAL_FROM_PARENT
);
1321 if ( !(flags
& wxPG_SETVAL_FROM_PARENT
) )
1322 UpdateParentValues();
1325 // Update editor control
1328 // We need to check for these, otherwise GetGrid() may fail.
1329 if ( flags
& wxPG_SETVAL_REFRESH_EDITOR
)
1334 void wxPGProperty::SetValueInEvent( wxVariant value
) const
1336 GetGrid()->ValueChangeInEvent(value
);
1339 void wxPGProperty::SetFlagRecursively( FlagType flag
, bool set
)
1347 for ( i
= 0; i
< GetChildCount(); i
++ )
1348 Item(i
)->SetFlagRecursively(flag
, set
);
1351 void wxPGProperty::RefreshEditor()
1356 wxPropertyGrid
* pg
= GetGrid();
1357 if ( pg
&& pg
->GetSelectedProperty() == this )
1358 pg
->RefreshEditor();
1361 wxVariant
wxPGProperty::GetDefaultValue() const
1363 wxVariant defVal
= GetAttribute(wxS("DefaultValue"));
1364 if ( !defVal
.IsNull() )
1367 wxVariant value
= GetValue();
1369 if ( !value
.IsNull() )
1371 wxString
valueType(value
.GetType());
1373 if ( valueType
== wxPG_VARIANT_TYPE_LONG
)
1374 return wxPGVariant_Zero
;
1375 if ( valueType
== wxPG_VARIANT_TYPE_STRING
)
1376 return wxPGVariant_EmptyString
;
1377 if ( valueType
== wxPG_VARIANT_TYPE_BOOL
)
1378 return wxPGVariant_False
;
1379 if ( valueType
== wxPG_VARIANT_TYPE_DOUBLE
)
1380 return wxVariant(0.0);
1381 if ( valueType
== wxPG_VARIANT_TYPE_ARRSTRING
)
1382 return wxVariant(wxArrayString());
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
);
1390 if ( valueType
== wxPG_VARIANT_TYPE_DATETIME
)
1391 return wxVariant(wxDateTime::Now());
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));
1404 void wxPGProperty::EnsureCells( unsigned int column
)
1406 if ( column
>= m_cells
.size() )
1408 // Fill empty slots with default cells
1409 wxPropertyGrid
* pg
= GetGrid();
1410 wxPGCell defaultCell
;
1412 if ( !HasFlag(wxPG_PROP_CATEGORY
) )
1413 defaultCell
= pg
->GetPropertyDefaultCell();
1415 defaultCell
= pg
->GetCategoryDefaultCell();
1417 // TODO: Replace with resize() call
1418 unsigned int cellCountMax
= column
+1;
1420 for ( unsigned int i
=m_cells
.size(); i
<cellCountMax
; i
++ )
1421 m_cells
.push_back(defaultCell
);
1425 void wxPGProperty::SetCell( int column
,
1426 const wxPGCell
& cell
)
1428 EnsureCells(column
);
1430 m_cells
[column
] = cell
;
1433 void wxPGProperty::AdaptiveSetCell( unsigned int firstCol
,
1434 unsigned int lastCol
,
1435 const wxPGCell
& cell
,
1436 const wxPGCell
& srcData
,
1437 wxPGCellData
* unmodCellData
,
1438 FlagType ignoreWithFlags
,
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.
1448 if ( !(m_flags
& ignoreWithFlags
) && !IsRoot() )
1450 EnsureCells(lastCol
);
1452 for ( unsigned int col
=firstCol
; col
<=lastCol
; col
++ )
1454 if ( m_cells
[col
].GetData() == unmodCellData
)
1456 // Data matches... use cell directly
1457 m_cells
[col
] = cell
;
1461 // Data did not match... merge valid information
1462 m_cells
[col
].MergeFrom(srcData
);
1469 for ( unsigned int i
=0; i
<GetChildCount(); i
++ )
1470 Item(i
)->AdaptiveSetCell( firstCol
,
1480 const wxPGCell
& wxPGProperty::GetCell( unsigned int column
) const
1482 if ( m_cells
.size() > column
)
1483 return m_cells
[column
];
1485 wxPropertyGrid
* pg
= GetGrid();
1488 return pg
->GetCategoryDefaultCell();
1490 return pg
->GetPropertyDefaultCell();
1493 wxPGCell
& wxPGProperty::GetCell( unsigned int column
)
1495 EnsureCells(column
);
1496 return m_cells
[column
];
1499 void wxPGProperty::SetBackgroundColour( const wxColour
& colour
,
1502 wxPGProperty
* firstProp
= this;
1505 // If category is tried to set recursively, skip it and only
1506 // affect the children.
1509 while ( firstProp
->IsCategory() )
1511 if ( !firstProp
->GetChildCount() )
1513 firstProp
= firstProp
->Item(0);
1517 wxPGCell
& firstCell
= firstProp
->GetCell(0);
1518 wxPGCellData
* firstCellData
= firstCell
.GetData();
1520 wxPGCell
newCell(firstCell
);
1521 newCell
.SetBgCol(colour
);
1523 srcCell
.SetBgCol(colour
);
1526 GetParentState()->GetColumnCount()-1,
1530 recursively
? wxPG_PROP_CATEGORY
: 0,
1534 void wxPGProperty::SetTextColour( const wxColour
& colour
,
1537 wxPGProperty
* firstProp
= this;
1540 // If category is tried to set recursively, skip it and only
1541 // affect the children.
1544 while ( firstProp
->IsCategory() )
1546 if ( !firstProp
->GetChildCount() )
1548 firstProp
= firstProp
->Item(0);
1552 wxPGCell
& firstCell
= firstProp
->GetCell(0);
1553 wxPGCellData
* firstCellData
= firstCell
.GetData();
1555 wxPGCell
newCell(firstCell
);
1556 newCell
.SetFgCol(colour
);
1558 srcCell
.SetFgCol(colour
);
1561 GetParentState()->GetColumnCount()-1,
1565 recursively
? wxPG_PROP_CATEGORY
: 0,
1569 wxPGEditorDialogAdapter
* wxPGProperty::GetEditorDialog() const
1574 bool wxPGProperty::DoSetAttribute( const wxString
& WXUNUSED(name
), wxVariant
& WXUNUSED(value
) )
1579 void wxPGProperty::SetAttribute( const wxString
& name
, wxVariant value
)
1581 if ( DoSetAttribute( name
, value
) )
1583 // Support working without grid, when possible
1584 if ( wxPGGlobalVars
->HasExtraStyle( wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES
) )
1588 m_attributes
.Set( name
, value
);
1591 void wxPGProperty::SetAttributes( const wxPGAttributeStorage
& attributes
)
1593 wxPGAttributeStorage::const_iterator it
= attributes
.StartIteration();
1596 while ( attributes
.GetNext(it
, variant
) )
1597 SetAttribute( variant
.GetName(), variant
);
1600 wxVariant
wxPGProperty::DoGetAttribute( const wxString
& WXUNUSED(name
) ) const
1606 wxVariant
wxPGProperty::GetAttribute( const wxString
& name
) const
1608 return m_attributes
.FindValue(name
);
1611 wxString
wxPGProperty::GetAttribute( const wxString
& name
, const wxString
& defVal
) const
1613 wxVariant variant
= m_attributes
.FindValue(name
);
1615 if ( !variant
.IsNull() )
1616 return variant
.GetString();
1621 long wxPGProperty::GetAttributeAsLong( const wxString
& name
, long defVal
) const
1623 wxVariant variant
= m_attributes
.FindValue(name
);
1625 return wxPGVariantToInt(variant
, defVal
);
1628 double wxPGProperty::GetAttributeAsDouble( const wxString
& name
, double defVal
) const
1631 wxVariant variant
= m_attributes
.FindValue(name
);
1633 if ( wxPGVariantToDouble(variant
, &retVal
) )
1639 wxVariant
wxPGProperty::GetAttributesAsList() const
1641 wxVariantList tempList
;
1642 wxVariant
v( tempList
, wxString::Format(wxS("@%s@attr"),m_name
.c_str()) );
1644 wxPGAttributeStorage::const_iterator it
= m_attributes
.StartIteration();
1647 while ( m_attributes
.GetNext(it
, variant
) )
1653 // Slots of utility flags are NULL
1654 const unsigned int gs_propFlagToStringSize
= 14;
1656 static const wxChar
* gs_propFlagToString
[gs_propFlagToStringSize
] = {
1673 wxString
wxPGProperty::GetFlagsAsString( FlagType flagsMask
) const
1676 int relevantFlags
= m_flags
& flagsMask
& wxPG_STRING_STORED_FLAGS
;
1680 for ( i
=0; i
<gs_propFlagToStringSize
; i
++ )
1682 if ( relevantFlags
& a
)
1684 const wxChar
* fs
= gs_propFlagToString
[i
];
1696 void wxPGProperty::SetFlagsFromString( const wxString
& str
)
1700 WX_PG_TOKENIZER1_BEGIN(str
, wxS('|'))
1702 for ( i
=0; i
<gs_propFlagToStringSize
; i
++ )
1704 const wxChar
* fs
= gs_propFlagToString
[i
];
1705 if ( fs
&& str
== fs
)
1711 WX_PG_TOKENIZER1_END()
1713 m_flags
= (m_flags
& ~wxPG_STRING_STORED_FLAGS
) | flags
;
1716 wxValidator
* wxPGProperty::DoGetValidator() const
1721 int wxPGProperty::InsertChoice( const wxString
& label
, int index
, int value
)
1723 wxPropertyGrid
* pg
= GetGrid();
1724 int sel
= GetChoiceSelection();
1728 if ( index
== wxNOT_FOUND
)
1729 index
= m_choices
.GetCount();
1734 m_choices
.Insert(label
, index
, value
);
1736 if ( sel
!= newSel
)
1737 SetChoiceSelection(newSel
);
1739 if ( this == pg
->GetSelection() )
1740 GetEditorClass()->InsertItem(pg
->GetEditorControl(),label
,index
);
1746 void wxPGProperty::DeleteChoice( int index
)
1748 wxPropertyGrid
* pg
= GetGrid();
1750 int sel
= GetChoiceSelection();
1753 // Adjust current value
1756 SetValueToUnspecified();
1759 else if ( index
< sel
)
1764 m_choices
.RemoveAt(index
);
1766 if ( sel
!= newSel
)
1767 SetChoiceSelection(newSel
);
1769 if ( this == pg
->GetSelection() )
1770 GetEditorClass()->DeleteItem(pg
->GetEditorControl(), index
);
1773 int wxPGProperty::GetChoiceSelection() const
1775 wxVariant value
= GetValue();
1776 wxString valueType
= value
.GetType();
1777 int index
= wxNOT_FOUND
;
1779 if ( IsValueUnspecified() || !m_choices
.GetCount() )
1782 if ( valueType
== wxPG_VARIANT_TYPE_LONG
)
1784 index
= value
.GetLong();
1786 else if ( valueType
== wxPG_VARIANT_TYPE_STRING
)
1788 index
= m_choices
.Index(value
.GetString());
1790 else if ( valueType
== wxPG_VARIANT_TYPE_BOOL
)
1792 index
= value
.GetBool()? 1 : 0;
1798 void wxPGProperty::SetChoiceSelection( int newValue
)
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();
1804 wxCHECK_RET( m_choices
.IsOk(), wxT("invalid choiceinfo") );
1806 if ( valueType
== wxPG_VARIANT_TYPE_STRING
)
1808 SetValue( m_choices
.GetLabel(newValue
) );
1810 else // if ( valueType == wxPG_VARIANT_TYPE_LONG )
1812 SetValue( (long) newValue
);
1816 bool wxPGProperty::SetChoices( wxPGChoices
& choices
)
1818 m_choices
.Assign(choices
);
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() )
1834 const wxPGEditor
* wxPGProperty::GetEditorClass() const
1836 const wxPGEditor
* editor
;
1838 if ( !m_customEditor
)
1840 editor
= DoGetEditorClass();
1843 editor
= m_customEditor
;
1846 // Maybe override editor if common value specified
1847 if ( GetDisplayedCommonValueCount() )
1849 // TextCtrlAndButton -> ComboBoxAndButton
1850 if ( editor
->IsKindOf(CLASSINFO(wxPGTextCtrlAndButtonEditor
)) )
1851 editor
= wxPGEditor_ChoiceAndButton
;
1853 // TextCtrl -> ComboBox
1854 else if ( editor
->IsKindOf(CLASSINFO(wxPGTextCtrlEditor
)) )
1855 editor
= wxPGEditor_ComboBox
;
1861 bool wxPGProperty::HasVisibleChildren() const
1865 for ( i
=0; i
<GetChildCount(); i
++ )
1867 wxPGProperty
* child
= Item(i
);
1869 if ( !child
->HasFlag(wxPG_PROP_HIDDEN
) )
1876 bool wxPGProperty::RecreateEditor()
1878 wxPropertyGrid
* pg
= GetGrid();
1881 wxPGProperty
* selected
= pg
->GetSelection();
1882 if ( this == selected
)
1884 pg
->DoSelectProperty(this, wxPG_SEL_FORCE
);
1891 void wxPGProperty::SetValueImage( wxBitmap
& bmp
)
1893 delete m_valueBitmap
;
1895 if ( &bmp
&& bmp
.Ok() )
1898 wxSize maxSz
= GetGrid()->GetImageSize();
1899 wxSize
imSz(bmp
.GetWidth(),bmp
.GetHeight());
1901 if ( imSz
.x
!= maxSz
.x
|| imSz
.y
!= maxSz
.y
)
1903 // Create a memory DC
1904 wxBitmap
* bmpNew
= new wxBitmap(maxSz
.x
,maxSz
.y
,bmp
.GetDepth());
1907 dc
.SelectObject(*bmpNew
);
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
;
1914 dc
.SetUserScale(scaleX
,scaleY
);
1916 dc
.DrawBitmap( bmp
, 0, 0 );
1918 m_valueBitmap
= bmpNew
;
1922 m_valueBitmap
= new wxBitmap(bmp
);
1925 m_flags
|= wxPG_PROP_CUSTOMIMAGE
;
1929 m_valueBitmap
= NULL
;
1930 m_flags
&= ~(wxPG_PROP_CUSTOMIMAGE
);
1935 wxPGProperty
* wxPGProperty::GetMainParent() const
1937 const wxPGProperty
* curChild
= this;
1938 const wxPGProperty
* curParent
= m_parent
;
1940 while ( curParent
&& !curParent
->IsCategory() )
1942 curChild
= curParent
;
1943 curParent
= curParent
->m_parent
;
1946 return (wxPGProperty
*) curChild
;
1950 const wxPGProperty
* wxPGProperty::GetLastVisibleSubItem() const
1953 // Returns last visible sub-item, recursively.
1954 if ( !IsExpanded() || !GetChildCount() )
1957 return Last()->GetLastVisibleSubItem();
1961 bool wxPGProperty::IsVisible() const
1963 const wxPGProperty
* parent
;
1965 if ( HasFlag(wxPG_PROP_HIDDEN
) )
1968 for ( parent
= GetParent(); parent
!= NULL
; parent
= parent
->GetParent() )
1970 if ( !parent
->IsExpanded() || parent
->HasFlag(wxPG_PROP_HIDDEN
) )
1977 wxPropertyGrid
* wxPGProperty::GetGridIfDisplayed() const
1979 wxPropertyGridPageState
* state
= GetParentState();
1980 wxPropertyGrid
* propGrid
= state
->GetGrid();
1981 if ( state
== propGrid
->GetState() )
1987 int wxPGProperty::GetY2( int lh
) const
1989 const wxPGProperty
* parent
;
1990 const wxPGProperty
* child
= this;
1994 for ( parent
= GetParent(); parent
!= NULL
; parent
= child
->GetParent() )
1996 if ( !parent
->IsExpanded() )
1998 y
+= parent
->GetChildrenHeight(lh
, child
->GetIndexInParent());
2003 y
-= lh
; // need to reduce one level
2009 int wxPGProperty::GetY() const
2011 return GetY2(GetGrid()->GetRowHeight());
2014 // This is used by Insert etc.
2015 void wxPGProperty::AddChild2( wxPGProperty
* prop
, int index
, bool correct_mode
)
2017 if ( index
< 0 || (size_t)index
>= m_children
.size() )
2019 if ( correct_mode
) prop
->m_arrIndex
= m_children
.size();
2020 m_children
.push_back( prop
);
2024 m_children
.insert( m_children
.begin()+index
, prop
);
2025 if ( correct_mode
) FixIndicesOfChildren( index
);
2028 prop
->m_parent
= this;
2031 // This is used by properties that have fixed sub-properties
2032 void wxPGProperty::AddChild( wxPGProperty
* prop
)
2034 wxASSERT_MSG( prop
->GetBaseName().length(),
2035 "Property's children must have unique, non-empty names within their scope" );
2037 prop
->m_arrIndex
= m_children
.size();
2038 m_children
.push_back( prop
);
2040 int custImgHeight
= prop
->OnMeasureImage().y
;
2041 if ( custImgHeight
< 0 /*|| custImgHeight > 1*/ )
2042 prop
->m_flags
|= wxPG_PROP_CUSTOMIMAGE
;
2044 prop
->m_parent
= this;
2047 void wxPGProperty::RemoveChild( wxPGProperty
* p
)
2049 wxArrayPGProperty::iterator it
;
2050 wxArrayPGProperty
& children
= m_children
;
2052 for ( it
=children
.begin(); it
!= children
.end(); it
++ )
2056 m_children
.erase(it
);
2062 void wxPGProperty::AdaptListToValue( wxVariant
& list
, wxVariant
* value
) const
2064 wxASSERT( GetChildCount() );
2065 wxASSERT( !IsCategory() );
2067 *value
= GetValue();
2069 if ( !list
.GetCount() )
2072 wxASSERT( GetChildCount() >= (unsigned int)list
.GetCount() );
2074 bool allChildrenSpecified
;
2076 // Don't fully update aggregate properties unless all children have
2078 if ( HasFlag(wxPG_PROP_AGGREGATE
) )
2079 allChildrenSpecified
= AreAllChildrenSpecified(&list
);
2081 allChildrenSpecified
= true;
2083 wxVariant childValue
= list
[0];
2087 //wxLogDebug(wxT(">> %s.AdaptListToValue()"),GetBaseName().c_str());
2089 for ( i
=0; i
<GetChildCount(); i
++ )
2091 const wxPGProperty
* child
= Item(i
);
2093 if ( childValue
.GetName() == child
->GetBaseName() )
2095 //wxLogDebug(wxT(" %s(n=%i), %s"),childValue.GetName().c_str(),n,childValue.GetType().c_str());
2097 if ( childValue
.GetType() == wxPG_VARIANT_TYPE_LIST
)
2099 wxVariant
cv2(child
->GetValue());
2100 child
->AdaptListToValue(childValue
, &cv2
);
2104 if ( allChildrenSpecified
)
2105 ChildChanged(*value
, i
, childValue
);
2107 if ( n
== (unsigned int)list
.GetCount() )
2109 childValue
= list
[n
];
2115 void wxPGProperty::FixIndicesOfChildren( unsigned int starthere
)
2118 for ( i
=starthere
;i
<GetChildCount();i
++)
2119 Item(i
)->m_arrIndex
= i
;
2123 // Returns (direct) child property with given name (or NULL if not found)
2124 wxPGProperty
* wxPGProperty::GetPropertyByName( const wxString
& name
) const
2128 for ( i
=0; i
<GetChildCount(); i
++ )
2130 wxPGProperty
* p
= Item(i
);
2131 if ( p
->m_name
== name
)
2135 // Does it have point, then?
2136 int pos
= name
.Find(wxS('.'));
2140 wxPGProperty
* p
= GetPropertyByName(name
. substr(0,pos
));
2142 if ( !p
|| !p
->GetChildCount() )
2145 return p
->GetPropertyByName(name
.substr(pos
+1,name
.length()-pos
-1));
2148 wxPGProperty
* wxPGProperty::GetPropertyByNameWH( const wxString
& name
, unsigned int hintIndex
) const
2150 unsigned int i
= hintIndex
;
2152 if ( i
>= GetChildCount() )
2155 unsigned int lastIndex
= i
- 1;
2157 if ( lastIndex
>= GetChildCount() )
2158 lastIndex
= GetChildCount() - 1;
2162 wxPGProperty
* p
= Item(i
);
2163 if ( p
->m_name
== name
)
2166 if ( i
== lastIndex
)
2170 if ( i
== GetChildCount() )
2177 int wxPGProperty::GetChildrenHeight( int lh
, int iMax_
) const
2179 // Returns height of children, recursively, and
2180 // by taking expanded/collapsed status into account.
2182 // iMax is used when finding property y-positions.
2188 iMax_
= GetChildCount();
2190 unsigned int iMax
= iMax_
;
2192 wxASSERT( iMax
<= GetChildCount() );
2194 if ( !IsExpanded() && GetParent() )
2199 wxPGProperty
* pwc
= (wxPGProperty
*) Item(i
);
2201 if ( !pwc
->HasFlag(wxPG_PROP_HIDDEN
) )
2203 if ( !pwc
->IsExpanded() ||
2204 pwc
->GetChildCount() == 0 )
2207 h
+= pwc
->GetChildrenHeight(lh
) + lh
;
2216 wxPGProperty
* wxPGProperty::GetItemAtY( unsigned int y
, unsigned int lh
, unsigned int* nextItemY
) const
2218 wxASSERT( nextItemY
);
2220 // Linear search at the moment
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
;
2227 unsigned int iMax
= GetChildCount();
2231 wxPGProperty
* pwc
= Item(i
);
2233 if ( !pwc
->HasFlag(wxPG_PROP_HIDDEN
) )
2244 if ( pwc
->IsExpanded() &&
2245 pwc
->GetChildCount() > 0 )
2247 result
= (wxPGProperty
*) pwc
->GetItemAtY( y
, lh
, &iy
);
2259 if ( !result
&& y
< iy
)
2266 wxLogDebug(wxT("%s::GetItemAtY(%i) -> %s"),this->GetLabel().c_str(),y,current->GetLabel().c_str());
2268 wxLogDebug(wxT("%s::GetItemAtY(%i) -> NULL"),this->GetLabel().c_str(),y);
2271 return (wxPGProperty
*) result
;
2274 void wxPGProperty::Empty()
2277 if ( !HasFlag(wxPG_PROP_CHILDREN_ARE_COPIES
) )
2279 for ( i
=0; i
<GetChildCount(); i
++ )
2281 delete m_children
[i
];
2288 void wxPGProperty::DeleteChildren()
2290 wxPropertyGridPageState
* state
= m_parentState
;
2292 while ( GetChildCount() )
2294 wxPGProperty
* child
= Item(GetChildCount()-1);
2295 state
->DoDelete(child
, true);
2299 void wxPGProperty::ChildChanged( wxVariant
& WXUNUSED(thisValue
),
2300 int WXUNUSED(childIndex
),
2301 wxVariant
& WXUNUSED(childValue
) ) const
2305 bool wxPGProperty::AreAllChildrenSpecified( wxVariant
* pendingList
) const
2309 const wxVariantList
* pList
= NULL
;
2310 wxVariantList::const_iterator node
;
2314 pList
= &pendingList
->GetList();
2315 node
= pList
->begin();
2318 for ( i
=0; i
<GetChildCount(); i
++ )
2320 wxPGProperty
* child
= Item(i
);
2321 const wxVariant
* listValue
= NULL
;
2326 const wxString
& childName
= child
->GetBaseName();
2328 for ( ; node
!= pList
->end(); ++node
)
2330 const wxVariant
& item
= *((const wxVariant
*)*node
);
2331 if ( item
.GetName() == childName
)
2341 value
= child
->GetValue();
2343 if ( value
.IsNull() )
2346 // Check recursively
2347 if ( child
->GetChildCount() )
2349 const wxVariant
* childList
= NULL
;
2351 if ( listValue
&& listValue
->GetType() == wxPG_VARIANT_TYPE_LIST
)
2352 childList
= listValue
;
2354 if ( !child
->AreAllChildrenSpecified((wxVariant
*)childList
) )
2362 wxPGProperty
* wxPGProperty::UpdateParentValues()
2364 wxPGProperty
* parent
= m_parent
;
2365 if ( parent
&& parent
->HasFlag(wxPG_PROP_COMPOSED_VALUE
) &&
2366 !parent
->IsCategory() && !parent
->IsRoot() )
2369 parent
->DoGenerateComposedValue(s
);
2370 parent
->m_value
= s
;
2371 return parent
->UpdateParentValues();
2376 bool wxPGProperty::IsTextEditable() const
2378 if ( HasFlag(wxPG_PROP_READONLY
) )
2381 if ( HasFlag(wxPG_PROP_NOEDITOR
) &&
2383 wxString(GetEditorClass()->GetClassInfo()->GetClassName()).EndsWith(wxS("Button")))
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.
2394 void wxPGProperty::SubPropsChanged( int oldSelInd
)
2396 wxPropertyGridPageState
* state
= GetParentState();
2397 wxPropertyGrid
* grid
= state
->GetGrid();
2400 // Re-repare children (recursively)
2401 for ( unsigned int i
=0; i
<GetChildCount(); i
++ )
2403 wxPGProperty
* child
= Item(i
);
2404 child
->InitAfterAdded(state
, grid
);
2407 wxPGProperty
* sel
= NULL
;
2408 if ( oldSelInd
>= (int)m_children
.size() )
2409 oldSelInd
= (int)m_children
.size() - 1;
2411 if ( oldSelInd
>= 0 )
2412 sel
= m_children
[oldSelInd
];
2413 else if ( oldSelInd
== -2 )
2417 state
->DoSelectProperty(sel
);
2419 if ( state
== grid
->GetState() )
2421 grid
->GetPanel()->Refresh();
2425 // -----------------------------------------------------------------------
2427 // -----------------------------------------------------------------------
2429 WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(wxPGRootProperty
,none
,TextCtrl
)
2430 IMPLEMENT_DYNAMIC_CLASS(wxPGRootProperty
, wxPGProperty
)
2433 wxPGRootProperty::wxPGRootProperty( const wxString
& name
)
2447 wxPGRootProperty::~wxPGRootProperty()
2452 // -----------------------------------------------------------------------
2453 // wxPropertyCategory
2454 // -----------------------------------------------------------------------
2456 WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(wxPropertyCategory
,none
,TextCtrl
)
2457 IMPLEMENT_DYNAMIC_CLASS(wxPropertyCategory
, wxPGProperty
)
2459 void wxPropertyCategory::Init()
2461 // don't set colour - prepareadditem method should do this
2462 SetParentalType(wxPG_PROP_CATEGORY
);
2463 m_capFgColIndex
= 1;
2467 wxPropertyCategory::wxPropertyCategory()
2474 wxPropertyCategory::wxPropertyCategory( const wxString
&label
, const wxString
& name
)
2475 : wxPGProperty(label
,name
)
2481 wxPropertyCategory::~wxPropertyCategory()
2486 wxString
wxPropertyCategory::ValueToString( wxVariant
& WXUNUSED(value
),
2487 int WXUNUSED(argFlags
) ) const
2489 return wxEmptyString
;
2492 int wxPropertyCategory::GetTextExtent( const wxWindow
* wnd
, const wxFont
& font
) const
2494 if ( m_textExtent
> 0 )
2495 return m_textExtent
;
2497 ((wxWindow
*)wnd
)->GetTextExtent( m_label
, &x
, &y
, 0, 0, &font
);
2501 void wxPropertyCategory::CalculateTextExtent( wxWindow
* wnd
, const wxFont
& font
)
2504 wnd
->GetTextExtent( m_label
, &x
, &y
, 0, 0, &font
);
2508 // -----------------------------------------------------------------------
2510 // -----------------------------------------------------------------------
2512 wxPGChoiceEntry
& wxPGChoices::Add( const wxString
& label
, int value
)
2516 wxPGChoiceEntry
entry(label
, value
);
2517 return m_data
->Insert( -1, entry
);
2520 // -----------------------------------------------------------------------
2522 wxPGChoiceEntry
& wxPGChoices::Add( const wxString
& label
, const wxBitmap
& bitmap
, int value
)
2526 wxPGChoiceEntry
entry(label
, value
);
2527 entry
.SetBitmap(bitmap
);
2528 return m_data
->Insert( -1, entry
);
2531 // -----------------------------------------------------------------------
2533 wxPGChoiceEntry
& wxPGChoices::Insert( const wxPGChoiceEntry
& entry
, int index
)
2537 return m_data
->Insert( index
, entry
);
2540 // -----------------------------------------------------------------------
2542 wxPGChoiceEntry
& wxPGChoices::Insert( const wxString
& label
, int index
, int value
)
2546 wxPGChoiceEntry
entry(label
, value
);
2547 return m_data
->Insert( index
, entry
);
2550 // -----------------------------------------------------------------------
2552 wxPGChoiceEntry
& wxPGChoices::AddAsSorted( const wxString
& label
, int value
)
2558 while ( index
< GetCount() )
2560 int cmpRes
= GetLabel(index
).Cmp(label
);
2566 wxPGChoiceEntry
entry(label
, value
);
2567 return m_data
->Insert( index
, entry
);
2570 // -----------------------------------------------------------------------
2572 void wxPGChoices::Add( const wxChar
** labels
, const ValArrItem
* values
)
2576 unsigned int itemcount
= 0;
2577 const wxChar
** p
= &labels
[0];
2578 while ( *p
) { p
++; itemcount
++; }
2581 for ( i
= 0; i
< itemcount
; i
++ )
2586 wxPGChoiceEntry
entry(labels
[i
], value
);
2587 m_data
->Insert( i
, entry
);
2591 // -----------------------------------------------------------------------
2593 void wxPGChoices::Add( const wxArrayString
& arr
, const wxArrayInt
& arrint
)
2598 unsigned int itemcount
= arr
.size();
2600 for ( i
= 0; i
< itemcount
; i
++ )
2603 if ( &arrint
&& arrint
.size() )
2605 wxPGChoiceEntry
entry(arr
[i
], value
);
2606 m_data
->Insert( i
, entry
);
2610 // -----------------------------------------------------------------------
2612 void wxPGChoices::RemoveAt(size_t nIndex
, size_t count
)
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
);
2621 // -----------------------------------------------------------------------
2623 void wxPGChoices::Clear()
2625 if ( m_data
!= wxPGChoicesEmptyData
)
2632 // -----------------------------------------------------------------------
2634 int wxPGChoices::Index( const wxString
& str
) const
2639 for ( i
=0; i
< m_data
->GetCount(); i
++ )
2641 const wxPGChoiceEntry
& entry
= m_data
->Item(i
);
2642 if ( entry
.HasText() && entry
.GetText() == str
)
2649 // -----------------------------------------------------------------------
2651 int wxPGChoices::Index( int val
) const
2656 for ( i
=0; i
< m_data
->GetCount(); i
++ )
2658 const wxPGChoiceEntry
& entry
= m_data
->Item(i
);
2659 if ( entry
.GetValue() == val
)
2666 // -----------------------------------------------------------------------
2668 wxArrayString
wxPGChoices::GetLabels() const
2673 if ( this && IsOk() )
2674 for ( i
=0; i
<GetCount(); i
++ )
2675 arr
.push_back(GetLabel(i
));
2680 // -----------------------------------------------------------------------
2682 wxArrayInt
wxPGChoices::GetValuesForStrings( const wxArrayString
& strings
) const
2689 for ( i
=0; i
< strings
.size(); i
++ )
2691 int index
= Index(strings
[i
]);
2693 arr
.Add(GetValue(index
));
2695 arr
.Add(wxPG_INVALID_VALUE
);
2702 // -----------------------------------------------------------------------
2704 wxArrayInt
wxPGChoices::GetIndicesForStrings( const wxArrayString
& strings
,
2705 wxArrayString
* unmatched
) const
2712 for ( i
=0; i
< strings
.size(); i
++ )
2714 const wxString
& str
= strings
[i
];
2715 int index
= Index(str
);
2718 else if ( unmatched
)
2719 unmatched
->Add(str
);
2726 // -----------------------------------------------------------------------
2728 void wxPGChoices::AllocExclusive()
2732 if ( m_data
->m_refCount
!= 1 )
2734 wxPGChoicesData
* data
= new wxPGChoicesData();
2735 data
->CopyDataFrom(m_data
);
2741 // -----------------------------------------------------------------------
2743 void wxPGChoices::AssignData( wxPGChoicesData
* data
)
2747 if ( data
!= wxPGChoicesEmptyData
)
2754 // -----------------------------------------------------------------------
2756 void wxPGChoices::Init()
2758 m_data
= wxPGChoicesEmptyData
;
2761 // -----------------------------------------------------------------------
2763 void wxPGChoices::Free()
2765 if ( m_data
!= wxPGChoicesEmptyData
)
2768 m_data
= wxPGChoicesEmptyData
;
2772 // -----------------------------------------------------------------------
2773 // wxPGAttributeStorage
2774 // -----------------------------------------------------------------------
2776 wxPGAttributeStorage::wxPGAttributeStorage()
2780 wxPGAttributeStorage::~wxPGAttributeStorage()
2782 wxPGHashMapS2P::iterator it
;
2784 for ( it
= m_map
.begin(); it
!= m_map
.end(); ++it
)
2786 wxVariantData
* data
= (wxVariantData
*) it
->second
;
2791 void wxPGAttributeStorage::Set( const wxString
& name
, const wxVariant
& value
)
2793 wxVariantData
* data
= value
.GetData();
2796 wxPGHashMapS2P::iterator it
= m_map
.find(name
);
2797 if ( it
!= m_map
.end() )
2799 ((wxVariantData
*)it
->second
)->DecRef();
2803 // If Null variant, just remove from set
2817 #endif // wxUSE_PROPGRID