1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/propgrid/propgridpagestate.cpp
3 // Purpose: wxPropertyGridPageState class
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"
35 #include "wx/stopwatch.h"
38 // This define is necessary to prevent macro clearing
39 #define __wxPG_SOURCE_FILE__
41 #include "wx/propgrid/propgridpagestate.h"
42 #include "wx/propgrid/propgrid.h"
43 #include "wx/propgrid/editors.h"
45 #define wxPG_DEFAULT_SPLITTERX 110
48 // -----------------------------------------------------------------------
49 // wxPropertyGridIterator
50 // -----------------------------------------------------------------------
52 void wxPropertyGridIteratorBase::Init( wxPropertyGridPageState
* state
, int flags
, wxPGProperty
* property
, int dir
)
54 wxASSERT( dir
== 1 || dir
== -1 );
57 m_baseParent
= state
->DoGetRoot();
58 if ( !property
&& m_baseParent
->GetChildCount() )
59 property
= m_baseParent
->Item(0);
61 m_property
= property
;
63 wxPG_ITERATOR_CREATE_MASKS(flags
, m_itemExMask
, m_parentExMask
)
65 // Need to skip first?
66 if ( property
&& (property
->GetFlags() & m_itemExMask
) )
75 void wxPropertyGridIteratorBase::Init( wxPropertyGridPageState
* state
, int flags
, int startPos
, int dir
)
77 wxPGProperty
* property
= NULL
;
79 if ( startPos
== wxTOP
)
84 else if ( startPos
== wxBOTTOM
)
86 property
= state
->GetLastItem(flags
);
92 wxFAIL_MSG("Only supported starting positions are wxTOP and wxBOTTOM");
95 Init( state
, flags
, property
, dir
);
98 void wxPropertyGridIteratorBase::Assign( const wxPropertyGridIteratorBase
& it
)
100 m_property
= it
.m_property
;
101 m_state
= it
.m_state
;
102 m_baseParent
= it
.m_baseParent
;
103 m_itemExMask
= it
.m_itemExMask
;
104 m_parentExMask
= it
.m_parentExMask
;
107 void wxPropertyGridIteratorBase::Prev()
109 wxPGProperty
* property
= m_property
;
110 wxASSERT( property
);
112 wxPGProperty
* parent
= property
->GetParent();
114 unsigned int index
= property
->GetIndexInParent();
121 property
= parent
->Item(index
);
123 // Go to last children?
124 if ( property
->GetChildCount() &&
125 wxPG_ITERATOR_PARENTEXMASK_TEST(property
, m_parentExMask
) )
128 property
= property
->Last();
134 if ( parent
== m_baseParent
)
145 m_property
= property
;
147 // If property does not match our criteria, skip it
148 if ( property
->GetFlags() & m_itemExMask
)
152 void wxPropertyGridIteratorBase::Next( bool iterateChildren
)
154 wxPGProperty
* property
= m_property
;
155 wxASSERT( property
);
157 if ( property
->GetChildCount() &&
158 wxPG_ITERATOR_PARENTEXMASK_TEST(property
, m_parentExMask
) &&
162 property
= property
->Item(0);
166 wxPGProperty
* parent
= property
->GetParent();
168 unsigned int index
= property
->GetIndexInParent() + 1;
170 if ( index
< parent
->GetChildCount() )
173 property
= parent
->Item(index
);
177 // Next sibling of parent
178 if ( parent
== m_baseParent
)
191 m_property
= property
;
193 // If property does not match our criteria, skip it
194 if ( property
->GetFlags() & m_itemExMask
)
198 // -----------------------------------------------------------------------
199 // wxPropertyGridPageState
200 // -----------------------------------------------------------------------
202 wxPropertyGridPageState::wxPropertyGridPageState()
205 m_regularArray
.SetParentState(this);
206 m_properties
= &m_regularArray
;
208 m_currentCategory
= NULL
;
212 m_lastCaptionBottomnest
= 1;
216 m_colWidths
.push_back( wxPG_DEFAULT_SPLITTERX
);
217 m_colWidths
.push_back( wxPG_DEFAULT_SPLITTERX
);
218 m_fSplitterX
= wxPG_DEFAULT_SPLITTERX
;
221 // -----------------------------------------------------------------------
223 wxPropertyGridPageState::~wxPropertyGridPageState()
228 // -----------------------------------------------------------------------
230 void wxPropertyGridPageState::InitNonCatMode()
234 m_abcArray
= new wxPGRootProperty(wxS("<Root_NonCat>"));
235 m_abcArray
->SetParentState(this);
236 m_abcArray
->SetFlag(wxPG_PROP_CHILDREN_ARE_COPIES
);
239 // Must be called when state::m_properties still points to regularArray.
240 wxPGProperty
* oldProperties
= m_properties
;
242 // Must use temp value in state::m_properties for item iteration loop
243 // to run as expected.
244 m_properties
= &m_regularArray
;
246 if ( m_properties
->GetChildCount() )
249 // Prepare m_abcArray
250 wxPropertyGridIterator
it( this, wxPG_ITERATE_PROPERTIES
);
252 for ( ; !it
.AtEnd(); it
.Next() )
254 wxPGProperty
* p
= it
.GetProperty();
255 wxPGProperty
* parent
= p
->GetParent();
256 if ( parent
->IsCategory() || parent
->IsRoot() )
258 m_abcArray
->AddChild2(p
);
259 p
->m_parent
= &m_regularArray
;
264 m_properties
= oldProperties
;
267 // -----------------------------------------------------------------------
269 void wxPropertyGridPageState::DoClear()
271 m_regularArray
.Empty();
277 m_currentCategory
= NULL
;
278 m_lastCaptionBottomnest
= 1;
287 // -----------------------------------------------------------------------
289 void wxPropertyGridPageState::CalculateFontAndBitmapStuff( int WXUNUSED(vspacing
) )
291 wxPropertyGrid
* propGrid
= GetGrid();
293 VirtualHeightChanged();
295 // Recalculate caption text extents.
298 for ( i
=0;i
<m_regularArray
.GetChildCount();i
++ )
300 wxPGProperty
* p
=m_regularArray
.Item(i
);
302 if ( p
->IsCategory() )
303 ((wxPropertyCategory
*)p
)->CalculateTextExtent(propGrid
, propGrid
->GetCaptionFont());
307 // -----------------------------------------------------------------------
309 void wxPropertyGridPageState::SetVirtualWidth( int width
)
311 wxASSERT( width
>= 0 );
312 wxPropertyGrid
* pg
= GetGrid();
313 int gw
= pg
->GetClientSize().x
;
320 // -----------------------------------------------------------------------
322 void wxPropertyGridPageState::OnClientWidthChange( int newWidth
, int widthChange
, bool fromOnResize
)
324 wxPropertyGrid
* pg
= GetGrid();
326 if ( pg
->HasVirtualWidth() )
328 if ( m_width
< newWidth
)
329 SetVirtualWidth( newWidth
);
331 CheckColumnWidths(widthChange
);
335 SetVirtualWidth( newWidth
);
337 // This should be done before splitter auto centering
338 // NOTE: Splitter auto-centering is done in this function.
341 CheckColumnWidths(widthChange
);
343 if ( !(GetGrid()->GetInternalFlags() & wxPG_FL_SPLITTER_PRE_SET
) &&
344 (GetGrid()->GetInternalFlags() & wxPG_FL_DONT_CENTER_SPLITTER
) )
346 long timeSinceCreation
= (::wxGetLocalTimeMillis() - GetGrid()->m_timeCreated
).ToLong();
348 // If too long, don't set splitter
349 if ( timeSinceCreation
< 3000 )
351 if ( m_properties
->GetChildCount() || timeSinceCreation
> 750 )
353 SetSplitterLeft( false );
357 DoSetSplitterPosition( newWidth
/ 2 );
358 GetGrid()->ClearInternalFlag(wxPG_FL_SPLITTER_PRE_SET
);
365 // -----------------------------------------------------------------------
366 // wxPropertyGridPageState item iteration methods
367 // -----------------------------------------------------------------------
369 wxPGProperty
* wxPropertyGridPageState::GetLastItem( int flags
)
371 if ( !m_properties
->GetChildCount() )
374 wxPG_ITERATOR_CREATE_MASKS(flags
, int itemExMask
, int parentExMask
)
376 // First, get last child of last parent
377 wxPGProperty
* pwc
= (wxPGProperty
*)m_properties
->Last();
378 while ( pwc
->GetChildCount() &&
379 wxPG_ITERATOR_PARENTEXMASK_TEST(pwc
, parentExMask
) )
380 pwc
= (wxPGProperty
*) pwc
->Last();
382 // Then, if it doesn't fit our criteria, back up until we find something that does
383 if ( pwc
->GetFlags() & itemExMask
)
385 wxPropertyGridIterator
it( this, flags
, pwc
);
386 for ( ; !it
.AtEnd(); it
.Prev() )
388 pwc
= (wxPGProperty
*) it
.GetProperty();
394 wxPropertyCategory
* wxPropertyGridPageState::GetPropertyCategory( const wxPGProperty
* p
) const
396 const wxPGProperty
* parent
= (const wxPGProperty
*)p
;
397 const wxPGProperty
* grandparent
= (const wxPGProperty
*)parent
->GetParent();
400 parent
= grandparent
;
401 grandparent
= (wxPGProperty
*)parent
->GetParent();
402 if ( parent
->IsCategory() && grandparent
)
403 return (wxPropertyCategory
*)parent
;
404 } while ( grandparent
);
409 // -----------------------------------------------------------------------
410 // wxPropertyGridPageState GetPropertyXXX methods
411 // -----------------------------------------------------------------------
413 wxPGProperty
* wxPropertyGridPageState::GetPropertyByLabel( const wxString
& label
,
414 wxPGProperty
* parent
) const
419 if ( !parent
) parent
= (wxPGProperty
*) &m_regularArray
;
421 for ( i
=0; i
<parent
->GetChildCount(); i
++ )
423 wxPGProperty
* p
= parent
->Item(i
);
424 if ( p
->m_label
== label
)
426 // Check children recursively.
427 if ( p
->GetChildCount() )
429 p
= GetPropertyByLabel(label
,(wxPGProperty
*)p
);
438 // -----------------------------------------------------------------------
440 wxPGProperty
* wxPropertyGridPageState::BaseGetPropertyByName( const wxString
& name
) const
442 wxPGHashMapS2P::const_iterator it
;
443 it
= m_dictName
.find(name
);
444 if ( it
!= m_dictName
.end() )
445 return (wxPGProperty
*) it
->second
;
449 // -----------------------------------------------------------------------
451 void wxPropertyGridPageState::DoSetPropertyName( wxPGProperty
* p
,
452 const wxString
& newName
)
454 wxCHECK_RET( p
, wxT("invalid property id") );
456 wxPGProperty
* parent
= p
->GetParent();
458 if ( parent
->IsCategory() || parent
->IsRoot() )
460 if ( p
->GetBaseName().length() )
461 m_dictName
.erase( p
->GetBaseName() );
462 if ( newName
.length() )
463 m_dictName
[newName
] = (void*) p
;
466 p
->DoSetName(newName
);
469 // -----------------------------------------------------------------------
470 // wxPropertyGridPageState global operations
471 // -----------------------------------------------------------------------
473 // -----------------------------------------------------------------------
474 // Item iteration macros
475 // NB: Nowadays only needed for alphabetic/categoric mode switching.
476 // -----------------------------------------------------------------------
478 //#define II_INVALID_I 0x00FFFFFF
480 #define ITEM_ITERATION_VARIABLES \
481 wxPGProperty* parent; \
485 #define ITEM_ITERATION_INIT_FROM_THE_TOP \
486 parent = m_properties; \
490 #define ITEM_ITERATION_INIT(startparent, startindex, state) \
491 parent = startparent; \
492 i = (unsigned int)startindex; \
493 if ( parent == NULL ) \
495 parent = state->m_properties; \
500 #define ITEM_ITERATION_LOOP_BEGIN \
503 iMax = parent->GetChildCount(); \
506 wxPGProperty* p = parent->Item(i);
508 #define ITEM_ITERATION_LOOP_END \
509 if ( p->GetChildCount() ) \
512 parent = (wxPGProperty*)p; \
513 iMax = parent->GetChildCount(); \
518 i = parent->m_arrIndex + 1; \
519 parent = parent->m_parent; \
521 while ( parent != NULL );
523 bool wxPropertyGridPageState::EnableCategories( bool enable
)
526 // NB: We can't use wxPropertyGridIterator in this
527 // function, since it depends on m_arrIndexes,
528 // which, among other things, is being fixed here.
530 ITEM_ITERATION_VARIABLES
538 if ( !IsInNonCatMode() )
541 m_properties
= &m_regularArray
;
543 // fix parents, indexes, and depths
544 ITEM_ITERATION_INIT_FROM_THE_TOP
546 ITEM_ITERATION_LOOP_BEGIN
550 p
->m_parent
= parent
;
552 // If parent was category, and this is not,
553 // then the depth stays the same.
554 if ( parent
->IsCategory() &&
556 p
->m_depth
= parent
->m_depth
;
558 p
->m_depth
= parent
->m_depth
+ 1;
560 ITEM_ITERATION_LOOP_END
566 // Disable categories
569 if ( IsInNonCatMode() )
572 // Create array, if necessary.
576 m_properties
= m_abcArray
;
578 // fix parents, indexes, and depths
579 ITEM_ITERATION_INIT_FROM_THE_TOP
581 ITEM_ITERATION_LOOP_BEGIN
585 p
->m_parent
= parent
;
587 p
->m_depth
= parent
->m_depth
+ 1;
589 ITEM_ITERATION_LOOP_END
592 VirtualHeightChanged();
594 if ( m_pPropGrid
->GetState() == this )
595 m_pPropGrid
->RecalculateVirtualSize();
600 // -----------------------------------------------------------------------
605 static bool wxPG_SortFunc_ByFunction(wxPGProperty
*p1
, wxPGProperty
*p2
)
607 wxPropertyGrid
* pg
= p1
->GetGrid();
608 wxPGSortCallback sortFunction
= pg
->GetSortFunction();
609 return sortFunction(pg
, p1
, p2
) < 0;
612 static bool wxPG_SortFunc_ByLabel(wxPGProperty
*p1
, wxPGProperty
*p2
)
614 return p1
->GetLabel().CmpNoCase( p2
->GetLabel() ) < 0;
619 static int wxPG_SortFunc_ByFunction(wxPGProperty
**pp1
, wxPGProperty
**pp2
)
621 wxPGProperty
*p1
= *pp1
;
622 wxPGProperty
*p2
= *pp2
;
623 wxPropertyGrid
* pg
= p1
->GetGrid();
624 wxPGSortCallback sortFunction
= pg
->GetSortFunction();
625 return sortFunction(pg
, p1
, p2
);
628 static int wxPG_SortFunc_ByLabel(wxPGProperty
**pp1
, wxPGProperty
**pp2
)
630 wxPGProperty
*p1
= *pp1
;
631 wxPGProperty
*p2
= *pp2
;
632 return p1
->GetLabel().CmpNoCase( p2
->GetLabel() );
637 void wxPropertyGridPageState::DoSortChildren( wxPGProperty
* p
,
643 // Can only sort items with children
644 if ( !p
->GetChildCount() )
647 // Never sort children of aggregate properties
648 if ( p
->HasFlag(wxPG_PROP_AGGREGATE
) )
651 if ( (flags
& wxPG_SORT_TOP_LEVEL_ONLY
)
652 && !p
->IsCategory() && !p
->IsRoot() )
656 if ( GetGrid()->GetSortFunction() )
657 std::sort(p
->m_children
.begin(), p
->m_children
.end(),
658 wxPG_SortFunc_ByFunction
);
660 std::sort(p
->m_children
.begin(), p
->m_children
.end(),
661 wxPG_SortFunc_ByLabel
);
663 if ( GetGrid()->GetSortFunction() )
664 p
->m_children
.Sort( wxPG_SortFunc_ByFunction
);
666 p
->m_children
.Sort( wxPG_SortFunc_ByLabel
);
670 p
->FixIndicesOfChildren();
672 if ( flags
& wxPG_RECURSE
)
674 // Apply sort recursively
675 for ( unsigned int i
=0; i
<p
->GetChildCount(); i
++ )
676 DoSortChildren(p
->Item(i
), flags
);
680 // -----------------------------------------------------------------------
682 void wxPropertyGridPageState::DoSort( int flags
)
684 DoSortChildren( m_properties
, flags
| wxPG_RECURSE
);
686 // We used to sort categories as well here also if in non-categorized
687 // mode, but doing would naturally cause child indices to become
691 // -----------------------------------------------------------------------
693 bool wxPropertyGridPageState::PrepareAfterItemsAdded()
695 if ( !m_itemsAdded
) return false;
697 wxPropertyGrid
* pg
= GetGrid();
701 if ( pg
->HasFlag(wxPG_AUTO_SORT
) )
702 DoSort(wxPG_SORT_TOP_LEVEL_ONLY
);
707 // -----------------------------------------------------------------------
708 // wxPropertyGridPageState splitter, column and hittest functions
709 // -----------------------------------------------------------------------
711 wxPGProperty
* wxPropertyGridPageState::DoGetItemAtY( int y
) const
718 return m_properties
->GetItemAtY(y
, GetGrid()->m_lineHeight
, &a
);
721 // -----------------------------------------------------------------------
723 wxPropertyGridHitTestResult
wxPropertyGridPageState::HitTest( const wxPoint
&pt
) const
725 wxPropertyGridHitTestResult result
;
726 result
.column
= HitTestH( pt
.x
, &result
.splitter
, &result
.splitterHitOffset
);
727 result
.property
= DoGetItemAtY( pt
.y
);
731 // -----------------------------------------------------------------------
733 // Used by SetSplitterLeft() and DotFitColumns()
734 int wxPropertyGridPageState::GetColumnFitWidth(wxClientDC
& dc
,
739 wxPropertyGrid
* pg
= m_pPropGrid
;
744 for ( i
=0; i
<pwc
->GetChildCount(); i
++ )
746 wxPGProperty
* p
= pwc
->Item(i
);
747 if ( !p
->IsCategory() )
749 const wxPGCell
* cell
= NULL
;
751 p
->GetDisplayInfo(col
, -1, 0, &text
, &cell
);
752 dc
.GetTextExtent(text
, &w
, &h
);
754 w
+= ( ((int)p
->m_depth
-1) * pg
->m_subgroup_extramargin
);
757 // TODO: Add bitmap support.
759 w
+= (wxPG_XBEFORETEXT
*2);
765 if ( p
->GetChildCount() &&
766 ( subProps
|| p
->IsCategory() ) )
768 w
= GetColumnFitWidth( dc
, p
, col
, subProps
);
778 int wxPropertyGridPageState::DoGetSplitterPosition( int splitterColumn
) const
780 int n
= GetGrid()->m_marginWidth
;
782 for ( i
=0; i
<=splitterColumn
; i
++ )
787 int wxPropertyGridPageState::GetColumnMinWidth( int WXUNUSED(column
) ) const
789 return wxPG_DRAG_MARGIN
;
792 void wxPropertyGridPageState::PropagateColSizeDec( int column
, int decrease
, int dir
)
794 int origWidth
= m_colWidths
[column
];
795 m_colWidths
[column
] -= decrease
;
796 int min
= GetColumnMinWidth(column
);
798 if ( m_colWidths
[column
] < min
)
800 more
= decrease
- (origWidth
- min
);
801 m_colWidths
[column
] = min
;
805 // FIXME: Causes erratic splitter changing, so as a workaround
806 // disabled if two or less columns.
808 if ( m_colWidths
.size() <= 2 )
812 if ( more
&& column
< (int)m_colWidths
.size() && column
>= 0 )
813 PropagateColSizeDec( column
, more
, dir
);
816 void wxPropertyGridPageState::DoSetSplitterPosition( int newXPos
, int splitterColumn
, bool WXUNUSED(allPages
), bool fromAutoCenter
)
818 wxPropertyGrid
* pg
= GetGrid();
820 int adjust
= newXPos
- DoGetSplitterPosition(splitterColumn
);
822 if ( !pg
->HasVirtualWidth() )
828 otherColumn
= splitterColumn
+ 1;
829 if ( otherColumn
== (int)m_colWidths
.size() )
831 m_colWidths
[splitterColumn
] += adjust
;
832 PropagateColSizeDec( otherColumn
, adjust
, 1 );
836 otherColumn
= splitterColumn
+ 1;
837 if ( otherColumn
== (int)m_colWidths
.size() )
839 m_colWidths
[otherColumn
] -= adjust
;
840 PropagateColSizeDec( splitterColumn
, -adjust
, -1 );
845 m_colWidths
[splitterColumn
] += adjust
;
848 if ( splitterColumn
== 0 )
849 m_fSplitterX
= (double) newXPos
;
851 if ( !fromAutoCenter
)
853 // Don't allow initial splitter auto-positioning after this.
854 if ( pg
->GetState() == this )
855 pg
->SetInternalFlag(wxPG_FL_SPLITTER_PRE_SET
);
861 // Moves splitter so that all labels are visible, but just.
862 void wxPropertyGridPageState::SetSplitterLeft( bool subProps
)
864 wxPropertyGrid
* pg
= GetGrid();
866 dc
.SetFont(pg
->m_font
);
868 int maxW
= GetColumnFitWidth(dc
, m_properties
, 0, subProps
);
872 maxW
+= pg
->m_marginWidth
;
873 DoSetSplitterPosition( maxW
);
876 pg
->SetInternalFlag(wxPG_FL_DONT_CENTER_SPLITTER
);
879 wxSize
wxPropertyGridPageState::DoFitColumns( bool WXUNUSED(allowGridResize
) )
881 wxPropertyGrid
* pg
= GetGrid();
883 dc
.SetFont(pg
->m_font
);
885 int marginWidth
= pg
->m_marginWidth
;
886 int accWid
= marginWidth
;
887 int maxColWidth
= 500;
889 for ( unsigned int col
=0; col
< GetColumnCount(); col
++ )
891 int fitWid
= GetColumnFitWidth(dc
, m_properties
, col
, true);
892 int colMinWidth
= GetColumnMinWidth(col
);
893 if ( fitWid
< colMinWidth
)
894 fitWid
= colMinWidth
;
895 else if ( fitWid
> maxColWidth
)
896 fitWid
= maxColWidth
;
898 m_colWidths
[col
] = fitWid
;
903 // Expand last one to fill the width
904 int remaining
= m_width
- accWid
;
905 m_colWidths
[GetColumnCount()-1] += remaining
;
907 pg
->SetInternalFlag(wxPG_FL_DONT_CENTER_SPLITTER
);
909 int firstSplitterX
= marginWidth
+ m_colWidths
[0];
910 m_fSplitterX
= (double) firstSplitterX
;
912 // Don't allow initial splitter auto-positioning after this.
913 if ( pg
->GetState() == this )
915 pg
->SetSplitterPosition(firstSplitterX
, false);
920 pg
->GetVirtualSize(&x
, &y
);
922 return wxSize(accWid
, y
);
925 void wxPropertyGridPageState::CheckColumnWidths( int widthChange
)
930 wxPropertyGrid
* pg
= GetGrid();
933 const bool debug
= false;
937 unsigned int lastColumn
= m_colWidths
.size() - 1;
939 int clientWidth
= pg
->GetClientSize().x
;
942 // Column to reduce, if needed. Take last one that exceeds minimum width.
943 // Except if auto splitter centering is used, in which case use widest.
945 int highestColWidth
= 0;
949 wxLogDebug(wxT("ColumnWidthCheck (virtualWidth: %i, clientWidth: %i)"), width
, clientWidth
);
954 for ( i
=0; i
<m_colWidths
.size(); i
++ )
956 int min
= GetColumnMinWidth(i
);
957 if ( m_colWidths
[i
] <= min
)
959 m_colWidths
[i
] = min
;
963 if ( pg
->HasFlag(wxPG_SPLITTER_AUTO_CENTER
) )
965 if ( m_colWidths
[i
] >= highestColWidth
)
967 highestColWidth
= m_colWidths
[i
];
978 int colsWidth
= pg
->m_marginWidth
;
979 for ( i
=0; i
<m_colWidths
.size(); i
++ )
980 colsWidth
+= m_colWidths
[i
];
984 wxLogDebug(wxT(" HasVirtualWidth: %i colsWidth: %i"),(int)pg
->HasVirtualWidth(),colsWidth
);
987 // Then mode-based requirement
988 if ( !pg
->HasVirtualWidth() )
990 int widthHigher
= width
- colsWidth
;
992 // Adapt colsWidth to width
993 if ( colsWidth
< width
)
998 wxLogDebug(wxT(" Adjust last column to %i"), m_colWidths
[lastColumn
] + widthHigher
);
1000 m_colWidths
[lastColumn
] = m_colWidths
[lastColumn
] + widthHigher
;
1002 else if ( colsWidth
> width
)
1005 if ( reduceCol
!= -1 )
1009 wxLogDebug(wxT(" Reduce column %i (by %i)"), reduceCol
, -widthHigher
);
1011 // Reduce widest column, and recheck
1012 m_colWidths
[reduceCol
] = m_colWidths
[reduceCol
] + widthHigher
;
1013 CheckColumnWidths();
1019 // Only check colsWidth against clientWidth
1020 if ( colsWidth
< clientWidth
)
1022 m_colWidths
[lastColumn
] = m_colWidths
[lastColumn
] + (clientWidth
-colsWidth
);
1025 m_width
= colsWidth
;
1027 // If width changed, recalculate virtual size
1028 if ( pg
->GetState() == this )
1029 pg
->RecalculateVirtualSize();
1034 for ( i
=0; i
<m_colWidths
.size(); i
++ )
1035 wxLogDebug(wxT("col%i: %i"),i
,m_colWidths
[i
]);
1038 // Auto center splitter
1039 if ( !(pg
->GetInternalFlags() & wxPG_FL_DONT_CENTER_SPLITTER
) &&
1040 m_colWidths
.size() == 2 )
1042 float centerX
= (float)(pg
->m_width
/2);
1045 if ( m_fSplitterX
< 0.0 )
1047 splitterX
= centerX
;
1049 else if ( widthChange
)
1051 //float centerX = float(pg->GetSize().x) * 0.5;
1054 splitterX
= m_fSplitterX
+ (float(widthChange
) * 0.5);
1055 float deviation
= fabs(centerX
- splitterX
);
1057 // If deviating from center, adjust towards it
1058 if ( deviation
> 20.0 )
1060 if ( splitterX
> centerX
)
1068 // No width change, just keep sure we keep splitter position intact
1069 splitterX
= m_fSplitterX
;
1070 float deviation
= fabs(centerX
- splitterX
);
1071 if ( deviation
> 50.0 )
1073 splitterX
= centerX
;
1077 DoSetSplitterPosition((int)splitterX
, 0, false, true);
1079 m_fSplitterX
= splitterX
; // needed to retain accuracy
1083 void wxPropertyGridPageState::SetColumnCount( int colCount
)
1085 wxASSERT( colCount
>= 2 );
1086 m_colWidths
.SetCount( colCount
, wxPG_DRAG_MARGIN
);
1087 if ( m_colWidths
.size() > (unsigned int)colCount
)
1088 m_colWidths
.RemoveAt( m_colWidths
.size(), m_colWidths
.size() - colCount
);
1090 if ( m_pPropGrid
->GetState() == this )
1091 m_pPropGrid
->RecalculateVirtualSize();
1093 CheckColumnWidths();
1096 // Returns column index, -1 for margin
1097 int wxPropertyGridPageState::HitTestH( int x
, int* pSplitterHit
, int* pSplitterHitOffset
) const
1099 int cx
= GetGrid()->m_marginWidth
;
1101 int prevSplitter
= -1;
1106 if ( col
>= (int)m_colWidths
.size() )
1112 cx
+= m_colWidths
[col
];
1115 // Near prev. splitter
1118 int diff
= x
- prevSplitter
;
1119 if ( abs(diff
) < wxPG_SPLITTERX_DETECTMARGIN1
)
1121 *pSplitterHit
= col
- 1;
1122 *pSplitterHitOffset
= diff
;
1127 // Near next splitter
1128 int nextSplitter
= cx
;
1129 if ( col
< (int)(m_colWidths
.size()-1) )
1131 int diff
= x
- nextSplitter
;
1132 if ( abs(diff
) < wxPG_SPLITTERX_DETECTMARGIN1
)
1134 *pSplitterHit
= col
;
1135 *pSplitterHitOffset
= diff
;
1144 // -----------------------------------------------------------------------
1145 // wxPropertyGridPageState property value setting and getting
1146 // -----------------------------------------------------------------------
1148 bool wxPropertyGridPageState::DoSetPropertyValueString( wxPGProperty
* p
, const wxString
& value
)
1152 int flags
= wxPG_REPORT_ERROR
|wxPG_FULL_VALUE
|wxPG_PROGRAMMATIC_VALUE
;
1154 wxVariant variant
= p
->GetValueRef();
1157 if ( p
->GetMaxLength() <= 0 )
1158 res
= p
->StringToValue( variant
, value
, flags
);
1160 res
= p
->StringToValue( variant
, value
.Mid(0,p
->GetMaxLength()), flags
);
1164 p
->SetValue(variant
);
1165 if ( m_selected
==p
&& this==m_pPropGrid
->GetState() )
1166 m_pPropGrid
->RefreshEditor();
1174 // -----------------------------------------------------------------------
1176 bool wxPropertyGridPageState::DoSetPropertyValue( wxPGProperty
* p
, wxVariant
& value
)
1181 if ( m_selected
==p
&& this==m_pPropGrid
->GetState() )
1182 m_pPropGrid
->RefreshEditor();
1189 // -----------------------------------------------------------------------
1191 bool wxPropertyGridPageState::DoSetPropertyValueWxObjectPtr( wxPGProperty
* p
, wxObject
* value
)
1195 // wnd_primary has to be given so the control can be updated as well.
1197 DoSetPropertyValue(p
, v
);
1203 // -----------------------------------------------------------------------
1204 // wxPropertyGridPageState property operations
1205 // -----------------------------------------------------------------------
1207 bool wxPropertyGridPageState::DoCollapse( wxPGProperty
* p
)
1209 wxCHECK_MSG( p
, false, wxT("invalid property id") );
1211 if ( !p
->GetChildCount() ) return false;
1213 if ( !p
->IsExpanded() ) return false;
1215 p
->SetExpanded(false);
1217 VirtualHeightChanged();
1222 // -----------------------------------------------------------------------
1224 bool wxPropertyGridPageState::DoExpand( wxPGProperty
* p
)
1226 wxCHECK_MSG( p
, false, wxT("invalid property id") );
1228 if ( !p
->GetChildCount() ) return false;
1230 if ( p
->IsExpanded() ) return false;
1232 p
->SetExpanded(true);
1234 VirtualHeightChanged();
1239 // -----------------------------------------------------------------------
1241 bool wxPropertyGridPageState::DoSelectProperty( wxPGProperty
* p
, unsigned int flags
)
1243 if ( this == m_pPropGrid
->GetState() )
1244 return m_pPropGrid
->DoSelectProperty( p
, flags
);
1250 // -----------------------------------------------------------------------
1252 bool wxPropertyGridPageState::DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
)
1255 p
->ClearFlag( wxPG_PROP_HIDDEN
);
1257 p
->SetFlag( wxPG_PROP_HIDDEN
);
1259 if ( flags
& wxPG_RECURSE
)
1262 for ( i
= 0; i
< p
->GetChildCount(); i
++ )
1263 DoHideProperty(p
->Item(i
), hide
, flags
| wxPG_RECURSE_STARTS
);
1266 VirtualHeightChanged();
1271 // -----------------------------------------------------------------------
1273 bool wxPropertyGridPageState::DoEnableProperty( wxPGProperty
* p
, bool enable
)
1279 if ( !(p
->m_flags
& wxPG_PROP_DISABLED
) )
1284 p
->m_flags
&= ~(wxPG_PROP_DISABLED
);
1288 if ( p
->m_flags
& wxPG_PROP_DISABLED
)
1293 p
->m_flags
|= wxPG_PROP_DISABLED
;
1297 // Apply same to sub-properties as well
1299 for ( i
= 0; i
< p
->GetChildCount(); i
++ )
1300 DoEnableProperty( p
->Item(i
), enable
);
1307 // -----------------------------------------------------------------------
1308 // wxPropertyGridPageState wxVariant related routines
1309 // -----------------------------------------------------------------------
1311 // Returns list of wxVariant objects (non-categories and non-sub-properties only).
1312 // Never includes sub-properties (unless they are parented by wxParentProperty).
1313 wxVariant
wxPropertyGridPageState::DoGetPropertyValues( const wxString
& listname
,
1314 wxPGProperty
* baseparent
,
1317 wxPGProperty
* pwc
= (wxPGProperty
*) baseparent
;
1319 // Root is the default base-parent.
1323 wxVariantList tempList
;
1324 wxVariant
v( tempList
, listname
);
1326 if ( pwc
->GetChildCount() )
1328 if ( flags
& wxPG_KEEP_STRUCTURE
)
1330 wxASSERT( !pwc
->HasFlag(wxPG_PROP_AGGREGATE
) );
1333 for ( i
=0; i
<pwc
->GetChildCount(); i
++ )
1335 wxPGProperty
* p
= pwc
->Item(i
);
1336 if ( !p
->GetChildCount() || p
->HasFlag(wxPG_PROP_AGGREGATE
) )
1338 wxVariant variant
= p
->GetValue();
1339 variant
.SetName( p
->GetBaseName() );
1340 v
.Append( variant
);
1344 v
.Append( DoGetPropertyValues(p
->m_name
,p
,flags
|wxPG_KEEP_STRUCTURE
) );
1346 if ( (flags
& wxPG_INC_ATTRIBUTES
) && p
->m_attributes
.GetCount() )
1347 v
.Append( p
->GetAttributesAsList() );
1352 wxPropertyGridConstIterator
it( this, wxPG_ITERATE_DEFAULT
, pwc
->Item(0) );
1353 it
.SetBaseParent( pwc
);
1355 for ( ; !it
.AtEnd(); it
.Next() )
1357 const wxPGProperty
* p
= it
.GetProperty();
1359 // Use a trick to ignore wxParentProperty itself, but not its sub-properties.
1360 if ( !p
->GetChildCount() || p
->HasFlag(wxPG_PROP_AGGREGATE
) )
1362 wxVariant variant
= p
->GetValue();
1363 variant
.SetName( p
->GetName() );
1364 v
.Append( variant
);
1365 if ( (flags
& wxPG_INC_ATTRIBUTES
) && p
->m_attributes
.GetCount() )
1366 v
.Append( p
->GetAttributesAsList() );
1375 // -----------------------------------------------------------------------
1377 void wxPropertyGridPageState::DoSetPropertyValues( const wxVariantList
& list
, wxPGProperty
* defaultCategory
)
1379 unsigned char origFrozen
= 1;
1381 if ( m_pPropGrid
->GetState() == this )
1383 origFrozen
= m_pPropGrid
->m_frozen
;
1384 if ( !origFrozen
) m_pPropGrid
->Freeze();
1387 wxPropertyCategory
* use_category
= (wxPropertyCategory
*)defaultCategory
;
1389 if ( !use_category
)
1390 use_category
= (wxPropertyCategory
*)m_properties
;
1392 // Let's iterate over the list of variants.
1393 wxVariantList::const_iterator node
;
1394 int numSpecialEntries
= 0;
1397 // Second pass for special entries
1398 for ( node
= list
.begin(); node
!= list
.end(); ++node
)
1400 wxVariant
*current
= (wxVariant
*)*node
;
1402 // Make sure it is wxVariant.
1403 wxASSERT( current
);
1404 wxASSERT( wxStrcmp(current
->GetClassInfo()->GetClassName(),wxT("wxVariant")) == 0 );
1406 const wxString
& name
= current
->GetName();
1407 if ( name
.length() > 0 )
1410 // '@' signified a special entry
1411 if ( name
[0] == wxS('@') )
1413 numSpecialEntries
++;
1417 wxPGProperty
* foundProp
= BaseGetPropertyByName(name
);
1420 wxPGProperty
* p
= foundProp
;
1422 // If it was a list, we still have to go through it.
1423 if ( wxStrcmp(current
->GetType(), wxS("list")) == 0 )
1425 DoSetPropertyValues( current
->GetList(),
1426 p
->IsCategory()?p
:(NULL
)
1432 if ( wxStrcmp(current
->GetType(), p
->GetValue().GetType()) != 0)
1434 wxLogDebug(wxT("wxPropertyGridPageState::DoSetPropertyValues Warning: Setting value of property \"%s\" from variant"),
1435 p
->GetName().c_str());
1439 p
->SetValue(*current
);
1445 if ( current
->GetType() != wxS("list") )
1451 // Yes, it is; create a sub category and append contents there.
1452 wxPGProperty
* newCat
= DoInsert(use_category
,-1,new wxPropertyCategory(current
->GetName(),wxPG_LABEL
));
1453 DoSetPropertyValues( current
->GetList(), newCat
);
1460 if ( numSpecialEntries
)
1462 for ( node
= list
.begin(); node
!= list
.end(); ++node
)
1464 wxVariant
*current
= (wxVariant
*)*node
;
1466 const wxString
& name
= current
->GetName();
1467 if ( name
.length() > 0 )
1470 // '@' signified a special entry
1471 if ( name
[0] == wxS('@') )
1473 numSpecialEntries
--;
1475 size_t pos2
= name
.rfind(wxS('@'));
1476 if ( pos2
> 0 && pos2
< (name
.size()-1) )
1478 wxString propName
= name
.substr(1, pos2
-1);
1479 wxString entryType
= name
.substr(pos2
+1, wxString::npos
);
1481 if ( entryType
== wxS("attr") )
1484 // List of attributes
1485 wxPGProperty
* foundProp
= BaseGetPropertyByName(propName
);
1488 wxASSERT( current
->GetType() == wxPG_VARIANT_TYPE_LIST
);
1490 wxVariantList
& list2
= current
->GetList();
1491 wxVariantList::const_iterator node2
;
1493 for ( node2
= list2
.begin(); node2
!= list2
.end(); ++node2
)
1495 wxVariant
*attr
= (wxVariant
*)*node2
;
1496 foundProp
->SetAttribute( attr
->GetName(), *attr
);
1501 // ERROR: No such property: 'propName'
1507 // ERROR: Special entry requires name of format @<propname>@<entrytype>
1512 if ( !numSpecialEntries
)
1519 m_pPropGrid
->Thaw();
1521 if ( this == m_pPropGrid
->GetState() )
1522 m_pPropGrid
->RefreshEditor();
1527 // -----------------------------------------------------------------------
1528 // wxPropertyGridPageState property adding and removal
1529 // -----------------------------------------------------------------------
1531 bool wxPropertyGridPageState::PrepareToAddItem( wxPGProperty
* property
,
1532 wxPGProperty
* scheduledParent
)
1534 wxPropertyGrid
* propGrid
= m_pPropGrid
;
1536 // This will allow better behavior.
1537 if ( scheduledParent
== m_properties
)
1538 scheduledParent
= NULL
;
1540 if ( scheduledParent
&& !scheduledParent
->IsCategory() )
1542 wxASSERT_MSG( property
->GetBaseName().length(),
1543 "Property's children must have unique, non-empty names within their scope" );
1546 property
->m_parentState
= this;
1548 if ( property
->IsCategory() )
1551 // Parent of a category must be either root or another category
1552 // (otherwise Bad Things might happen).
1553 wxASSERT_MSG( scheduledParent
== NULL
||
1554 scheduledParent
== m_properties
||
1555 scheduledParent
->IsCategory(),
1556 wxT("Parent of a category must be either root or another category."));
1558 // If we already have category with same name, delete given property
1559 // and use it instead as most recent caption item.
1560 wxPGProperty
* found_id
= BaseGetPropertyByName( property
->GetBaseName() );
1563 wxPropertyCategory
* pwc
= (wxPropertyCategory
*) found_id
;
1564 if ( pwc
->IsCategory() ) // Must be a category.
1567 m_currentCategory
= pwc
;
1574 // Warn for identical names in debug mode.
1575 if ( BaseGetPropertyByName(property
->GetName()) &&
1576 (!scheduledParent
|| scheduledParent
->IsCategory()) )
1578 wxLogError(wxT("wxPropertyGrid: Warning - item with name \"%s\" already exists."),
1579 property
->GetName().c_str());
1580 wxPGGlobalVars
->m_warnings
++;
1584 // Make sure nothing is selected.
1586 propGrid
->ClearSelection(false);
1588 // NULL parent == root parent
1589 if ( !scheduledParent
)
1590 scheduledParent
= DoGetRoot();
1592 property
->m_parent
= scheduledParent
;
1594 property
->InitAfterAdded(this, propGrid
);
1596 if ( property
->IsCategory() )
1598 wxPropertyCategory
* pc
= wxStaticCast(property
, wxPropertyCategory
);
1600 m_currentCategory
= pc
;
1602 // Calculate text extent for category caption
1604 pc
->CalculateTextExtent(propGrid
, propGrid
->GetCaptionFont());
1610 // -----------------------------------------------------------------------
1612 wxPGProperty
* wxPropertyGridPageState::DoAppend( wxPGProperty
* property
)
1614 wxPropertyCategory
* cur_cat
= m_currentCategory
;
1615 if ( property
->IsCategory() )
1618 return DoInsert( cur_cat
, -1, property
);
1621 // -----------------------------------------------------------------------
1623 wxPGProperty
* wxPropertyGridPageState::DoInsert( wxPGProperty
* parent
, int index
, wxPGProperty
* property
)
1626 parent
= m_properties
;
1628 wxCHECK_MSG( !parent
->HasFlag(wxPG_PROP_AGGREGATE
),
1630 wxT("when adding properties to fixed parents, use BeginAddChildren and EndAddChildren.") );
1632 bool res
= PrepareToAddItem( property
, (wxPropertyCategory
*)parent
);
1634 // PrepareToAddItem() may just decide to use use current category
1635 // instead of adding new one.
1637 return m_currentCategory
;
1639 bool parentIsRoot
= parent
->IsRoot();
1640 bool parentIsCategory
= parent
->IsCategory();
1642 // Note that item must be added into current mode later.
1644 // If parent is wxParentProperty, just stick it in...
1645 // If parent is root (m_properties), then...
1646 // In categoric mode: Add as last item in m_abcArray (if not category).
1647 // Add to given index in m_regularArray.
1648 // In non-cat mode: Add as last item in m_regularArray.
1649 // Add to given index in m_abcArray.
1650 // If parent is category, then...
1651 // 1) Add to given category in given index.
1652 // 2) Add as last item in m_abcArray.
1654 if ( m_properties
== &m_regularArray
)
1656 // We are currently in Categorized mode
1658 // Only add non-categories to m_abcArray.
1659 if ( m_abcArray
&& !property
->IsCategory() &&
1660 (parentIsCategory
|| parentIsRoot
) )
1662 m_abcArray
->AddChild2( property
, -1, false );
1665 // Add to current mode.
1666 parent
->AddChild2( property
, index
, true );
1670 // We are currently in Non-categorized/Alphabetic mode
1672 if ( parentIsCategory
)
1673 // Parent is category.
1674 parent
->AddChild2( property
, index
, false );
1675 else if ( parentIsRoot
)
1677 m_regularArray
.AddChild2( property
, -1, false );
1679 // Add to current mode
1680 if ( !property
->IsCategory() )
1681 m_abcArray
->AddChild2( property
, index
, true );
1685 if ( property
->IsCategory() )
1687 // This is a category caption item.
1689 // Last caption is not the bottom one (this info required by append)
1690 m_lastCaptionBottomnest
= 0;
1693 // Only add name to hashmap if parent is root or category
1694 if ( property
->m_name
.length() &&
1695 (parentIsCategory
|| parentIsRoot
) )
1696 m_dictName
[property
->m_name
] = (void*) property
;
1698 VirtualHeightChanged();
1700 property
->UpdateParentValues();
1707 // -----------------------------------------------------------------------
1709 void wxPropertyGridPageState::DoDelete( wxPGProperty
* item
, bool doDelete
)
1711 wxCHECK_RET( item
->GetParent(),
1712 wxT("this property was already deleted") );
1714 wxCHECK_RET( item
!= &m_regularArray
&& item
!= m_abcArray
,
1715 wxT("wxPropertyGrid: Do not attempt to remove the root item.") );
1717 unsigned int indinparent
= item
->GetIndexInParent();
1719 wxPGProperty
* pwc
= (wxPGProperty
*)item
;
1720 wxPGProperty
* parent
= item
->GetParent();
1722 wxCHECK_RET( !parent
->HasFlag(wxPG_PROP_AGGREGATE
),
1723 wxT("wxPropertyGrid: Do not attempt to remove sub-properties.") );
1726 if ( item
->GetChildCount() && !item
->HasFlag(wxPG_PROP_AGGREGATE
) )
1728 // deleting a category
1729 if ( item
->IsCategory() )
1731 if ( pwc
== m_currentCategory
)
1732 m_currentCategory
= NULL
;
1735 item
->DeleteChildren();
1738 if ( !IsInNonCatMode() )
1740 // categorized mode - non-categorized array
1742 // Remove from non-cat array
1743 if ( !item
->IsCategory() &&
1744 (parent
->IsCategory() || parent
->IsRoot()) )
1747 m_abcArray
->RemoveChild(item
);
1750 // categorized mode - categorized array
1751 wxArrayPGProperty
& parentsChildren
= parent
->m_children
;
1752 parentsChildren
.erase( parentsChildren
.begin() + indinparent
);
1753 item
->m_parent
->FixIndicesOfChildren();
1757 // non-categorized mode - categorized array
1759 // We need to find location of item.
1760 wxPGProperty
* cat_parent
= &m_regularArray
;
1761 int cat_index
= m_regularArray
.GetChildCount();
1763 for ( i
= 0; i
< m_regularArray
.GetChildCount(); i
++ )
1765 wxPGProperty
* p
= m_regularArray
.Item(i
);
1766 if ( p
== item
) { cat_index
= i
; break; }
1767 if ( p
->IsCategory() )
1769 int subind
= ((wxPGProperty
*)p
)->Index(item
);
1770 if ( subind
!= wxNOT_FOUND
)
1772 cat_parent
= ((wxPGProperty
*)p
);
1778 cat_parent
->m_children
.erase(cat_parent
->m_children
.begin()+cat_index
);
1780 // non-categorized mode - non-categorized array
1781 if ( !item
->IsCategory() )
1783 wxASSERT( item
->m_parent
== m_abcArray
);
1784 wxArrayPGProperty
& parentsChildren
= item
->m_parent
->m_children
;
1785 parentsChildren
.erase(parentsChildren
.begin() + indinparent
);
1786 item
->m_parent
->FixIndicesOfChildren(indinparent
);
1790 if ( item
->GetBaseName().length() &&
1791 (parent
->IsCategory() || parent
->IsRoot()) )
1792 m_dictName
.erase(item
->GetBaseName());
1794 // We can actually delete it now
1798 m_itemsAdded
= 1; // Not a logical assignment (but required nonetheless).
1800 VirtualHeightChanged();
1803 // -----------------------------------------------------------------------
1805 #endif // wxUSE_PROPGRID