1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/propgrid/propgridpagestate.h
3 // Purpose: wxPropertyGridPageState class
4 // Author: Jaakko Salli
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_PROPGRID_PROPGRIDPAGESTATE_H_
13 #define _WX_PROPGRID_PROPGRIDPAGESTATE_H_
17 #include "wx/propgrid/property.h"
19 // -----------------------------------------------------------------------
21 /** @section propgrid_hittestresult wxPropertyGridHitTestResult
23 A return value from wxPropertyGrid::HitTest(),
24 contains all you need to know about an arbitrary location on the grid.
26 struct WXDLLIMPEXP_PROPGRID wxPropertyGridHitTestResult
28 friend class wxPropertyGridPageState
;
31 wxPGProperty
* GetProperty() const { return property
; }
33 /** Column. -1 for margin. */
36 /** Index of splitter hit, -1 for none. */
39 /** If splitter hit, offset to that */
40 int splitterHitOffset
;
43 /** Property. NULL if empty space below properties was hit */
44 wxPGProperty
* property
;
47 // -----------------------------------------------------------------------
49 #define wxPG_IT_CHILDREN(A) ((A)<<16)
51 /** @section propgrid_iterator_flags wxPropertyGridIterator Flags
54 NOTES: At lower 16-bits, there are flags to check if item will be included.
55 At higher 16-bits, there are same flags, but to instead check if children
59 enum wxPG_ITERATOR_FLAGS
63 Iterate through 'normal' property items (does not include children of
64 aggregate or hidden items by default).
66 wxPG_ITERATE_PROPERTIES
= wxPG_PROP_PROPERTY
|
67 wxPG_PROP_MISC_PARENT
|
70 wxPG_IT_CHILDREN(wxPG_PROP_MISC_PARENT
) |
71 wxPG_IT_CHILDREN(wxPG_PROP_CATEGORY
),
73 /** Iterate children of collapsed parents, and individual items that are hidden.
75 wxPG_ITERATE_HIDDEN
= wxPG_PROP_HIDDEN
|
76 wxPG_IT_CHILDREN(wxPG_PROP_COLLAPSED
),
79 Iterate children of parent that is an aggregate property (ie has fixed
82 wxPG_ITERATE_FIXED_CHILDREN
= wxPG_IT_CHILDREN(wxPG_PROP_AGGREGATE
) |
83 wxPG_ITERATE_PROPERTIES
,
85 /** Iterate categories.
86 Note that even without this flag, children of categories are still iterated
89 wxPG_ITERATE_CATEGORIES
= wxPG_PROP_CATEGORY
|
90 wxPG_IT_CHILDREN(wxPG_PROP_CATEGORY
) |
93 wxPG_ITERATE_ALL_PARENTS
= wxPG_PROP_MISC_PARENT
|
97 wxPG_ITERATE_ALL_PARENTS_RECURSIVELY
= wxPG_ITERATE_ALL_PARENTS
|
99 wxPG_ITERATE_ALL_PARENTS
),
101 wxPG_ITERATOR_FLAGS_ALL
= wxPG_PROP_PROPERTY
|
102 wxPG_PROP_MISC_PARENT
|
103 wxPG_PROP_AGGREGATE
|
108 wxPG_ITERATOR_MASK_OP_ITEM
= wxPG_ITERATOR_FLAGS_ALL
,
110 // (wxPG_PROP_MISC_PARENT|wxPG_PROP_AGGREGATE|wxPG_PROP_CATEGORY)
111 wxPG_ITERATOR_MASK_OP_PARENT
= wxPG_ITERATOR_FLAGS_ALL
,
113 /** Combines all flags needed to iterate through visible properties
114 (ie hidden properties and children of collapsed parents are skipped).
116 wxPG_ITERATE_VISIBLE
= wxPG_ITERATE_PROPERTIES
|
118 wxPG_IT_CHILDREN(wxPG_PROP_AGGREGATE
),
120 /** Iterate all items.
122 wxPG_ITERATE_ALL
= wxPG_ITERATE_VISIBLE
|
125 /** Iterate through individual properties (ie categories and children of
126 aggregate properties are skipped).
128 wxPG_ITERATE_NORMAL
= wxPG_ITERATE_PROPERTIES
|
131 /** Default iterator flags.
133 wxPG_ITERATE_DEFAULT
= wxPG_ITERATE_NORMAL
141 #define wxPG_ITERATOR_CREATE_MASKS(FLAGS, A, B) \
142 A = (FLAGS ^ wxPG_ITERATOR_MASK_OP_ITEM) & \
143 wxPG_ITERATOR_MASK_OP_ITEM & 0xFFFF; \
144 B = ((FLAGS>>16) ^ wxPG_ITERATOR_MASK_OP_PARENT) & \
145 wxPG_ITERATOR_MASK_OP_PARENT & 0xFFFF;
148 // Macro to test if children of PWC should be iterated through
149 #define wxPG_ITERATOR_PARENTEXMASK_TEST(PWC, PARENTMASK) \
151 !(PWC->GetFlags() & PARENTMASK) && \
152 PWC->GetChildCount() \
156 // Base for wxPropertyGridIterator classes.
157 class WXDLLIMPEXP_PROPGRID wxPropertyGridIteratorBase
160 wxPropertyGridIteratorBase()
164 void Assign( const wxPropertyGridIteratorBase
& it
);
166 bool AtEnd() const { return m_property
== NULL
; }
168 /** Get current property.
170 wxPGProperty
* GetProperty() const { return m_property
; }
172 void Init( wxPropertyGridPageState
* state
,
174 wxPGProperty
* property
,
177 void Init( wxPropertyGridPageState
* state
,
179 int startPos
= wxTOP
,
182 /** Iterate to the next property.
184 void Next( bool iterateChildren
= true );
186 /** Iterate to the previous property.
191 Set base parent, ie a property when, in which iteration returns, it
194 Default base parent is the root of the used wxPropertyGridPageState.
196 void SetBaseParent( wxPGProperty
* baseParent
)
197 { m_baseParent
= baseParent
; }
201 wxPGProperty
* m_property
;
204 wxPropertyGridPageState
* m_state
;
205 wxPGProperty
* m_baseParent
;
207 // Masks are used to quickly exclude items
213 #define wxPG_IMPLEMENT_ITERATOR(CLASS, PROPERTY, STATE) \
214 CLASS( STATE* state, int flags = wxPG_ITERATE_DEFAULT, \
215 PROPERTY* property = NULL, int dir = 1 ) \
216 : wxPropertyGridIteratorBase() \
217 { Init( (wxPropertyGridPageState*)state, flags, \
218 (wxPGProperty*)property, dir ); } \
219 CLASS( STATE* state, int flags, int startPos, int dir = 0 ) \
220 : wxPropertyGridIteratorBase() \
221 { Init( (wxPropertyGridPageState*)state, flags, startPos, dir ); } \
223 : wxPropertyGridIteratorBase() \
227 CLASS( const CLASS& it ) \
228 : wxPropertyGridIteratorBase( ) \
235 const CLASS& operator=( const CLASS& it ) \
240 CLASS& operator++() { Next(); return *this; } \
241 CLASS operator++(int) { CLASS it=*this;Next();return it; } \
242 CLASS& operator--() { Prev(); return *this; } \
243 CLASS operator--(int) { CLASS it=*this;Prev();return it; } \
244 PROPERTY* operator *() const { return (PROPERTY*)m_property; } \
245 static PROPERTY* OneStep( STATE* state, \
246 int flags = wxPG_ITERATE_DEFAULT, \
247 PROPERTY* property = NULL, \
250 CLASS it( state, flags, property, dir ); \
253 if ( dir == 1 ) it.Next(); \
260 /** @class wxPropertyGridIterator
262 Preferable way to iterate through contents of wxPropertyGrid,
263 wxPropertyGridManager, and wxPropertyGridPage.
265 See wxPropertyGridInterface::GetIterator() for more information about usage.
270 class WXDLLIMPEXP_PROPGRID
271 wxPropertyGridIterator
: public wxPropertyGridIteratorBase
275 wxPG_IMPLEMENT_ITERATOR(wxPropertyGridIterator
,
277 wxPropertyGridPageState
)
283 // Const version of wxPropertyGridIterator.
284 class WXDLLIMPEXP_PROPGRID
285 wxPropertyGridConstIterator
: public wxPropertyGridIteratorBase
288 wxPG_IMPLEMENT_ITERATOR(wxPropertyGridConstIterator
,
290 const wxPropertyGridPageState
)
293 Additional copy constructor.
295 wxPropertyGridConstIterator( const wxPropertyGridIterator
& other
)
303 // -----------------------------------------------------------------------
305 /** Base class to derive new viterators.
307 class WXDLLIMPEXP_PROPGRID wxPGVIteratorBase
309 friend class wxPGVIterator
;
311 wxPGVIteratorBase() { m_refCount
= 1; }
312 virtual void Next() = 0;
320 if ( m_refCount
<= 0 )
324 virtual ~wxPGVIteratorBase() { }
326 wxPropertyGridIterator m_it
;
331 /** @class wxPGVIterator
333 Abstract implementation of a simple iterator. Can only be used
334 to iterate in forward order, and only through the entire container.
335 Used to have functions dealing with all properties work with both
336 wxPropertyGrid and wxPropertyGridManager.
338 class WXDLLIMPEXP_PROPGRID wxPGVIterator
341 wxPGVIterator() { m_pIt
= NULL
; }
342 wxPGVIterator( wxPGVIteratorBase
* obj
) { m_pIt
= obj
; }
343 ~wxPGVIterator() { UnRef(); }
344 void UnRef() { if (m_pIt
) m_pIt
->DecRef(); }
345 wxPGVIterator( const wxPGVIterator
& it
)
351 const wxPGVIterator
& operator=( const wxPGVIterator
& it
)
359 void Next() { m_pIt
->Next(); }
360 bool AtEnd() const { return m_pIt
->m_it
.AtEnd(); }
361 wxPGProperty
* GetProperty() const { return m_pIt
->m_it
.GetProperty(); }
363 wxPGVIteratorBase
* m_pIt
;
366 // -----------------------------------------------------------------------
369 // We won't need this class from wxPython
371 /** @class wxPropertyGridPageState
373 Contains low-level property page information (properties, column widths,
374 etc) of a single wxPropertyGrid or single wxPropertyGridPage. Generally you
375 should not use this class directly, but instead member functions in
376 wxPropertyGridInterface, wxPropertyGrid, wxPropertyGridPage, and
377 wxPropertyGridManager.
380 - In separate wxPropertyGrid component this class was known as
382 - Currently this class is not implemented in wxPython.
387 class WXDLLIMPEXP_PROPGRID wxPropertyGridPageState
389 friend class wxPGProperty
;
390 friend class wxPropertyGrid
;
391 friend class wxPGCanvas
;
392 friend class wxPropertyGridInterface
;
393 friend class wxPropertyGridPage
;
394 friend class wxPropertyGridManager
;
397 /** Default constructor. */
398 wxPropertyGridPageState();
401 virtual ~wxPropertyGridPageState();
403 /** Makes sure all columns have minimum width.
405 void CheckColumnWidths( int widthChange
= 0 );
408 Override this member function to add custom behavior on property
411 virtual void DoDelete( wxPGProperty
* item
);
413 wxSize
DoFitColumns( bool allowGridResize
= false );
415 wxPGProperty
* DoGetItemAtY( int y
) const;
418 Override this member function to add custom behavior on property
421 virtual wxPGProperty
* DoInsert( wxPGProperty
* parent
,
423 wxPGProperty
* property
);
426 This needs to be overridden in grid used the manager so that splitter
427 changes can be propagated to other pages.
429 virtual void DoSetSplitterPosition( int pos
,
430 int splitterColumn
= 0,
431 bool allPages
= false,
432 bool fromAutoCenter
= false );
434 bool EnableCategories( bool enable
);
436 /** Make sure virtual height is up-to-date.
438 void EnsureVirtualHeight()
440 if ( m_vhCalcPending
)
442 RecalculateVirtualHeight();
447 /** Enables or disables given property and its subproperties. */
448 bool DoEnableProperty( wxPGProperty
* p
, bool enable
);
450 /** Returns (precalculated) height of contained visible properties.
452 unsigned int GetVirtualHeight() const
454 wxASSERT( !m_vhCalcPending
);
455 return m_virtualHeight
;
458 /** Returns (precalculated) height of contained visible properties.
460 unsigned int GetVirtualHeight()
462 EnsureVirtualHeight();
463 return m_virtualHeight
;
466 /** Returns actual height of contained visible properties.
468 Mostly used for internal diagnostic purposes.
470 inline unsigned int GetActualVirtualHeight() const;
472 unsigned int GetColumnCount() const
474 return (unsigned int) m_colWidths
.size();
477 wxPGProperty
* GetSelection() const
482 int GetColumnMinWidth( int column
) const;
484 int GetColumnWidth( unsigned int column
) const
486 return m_colWidths
[column
];
489 wxPropertyGrid
* GetGrid() const { return m_pPropGrid
; }
491 /** Returns last item which could be iterated using given flags.
493 @link iteratorflags List of iterator flags@endlink
495 wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
);
497 const wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
) const
499 return ((wxPropertyGridPageState
*)this)->GetLastItem(flags
);
502 wxPropertyCategory
* GetPropertyCategory( const wxPGProperty
* p
) const;
504 wxPGProperty
* GetPropertyByLabel( const wxString
& name
,
505 wxPGProperty
* parent
= NULL
) const;
507 wxVariant
DoGetPropertyValues( const wxString
& listname
,
508 wxPGProperty
* baseparent
,
511 wxPGProperty
* DoGetRoot() const { return m_properties
; }
513 void DoSetPropertyName( wxPGProperty
* p
, const wxString
& newName
);
515 // Returns combined width of margin and all the columns
516 int GetVirtualWidth() const
522 Returns minimal width for given column so that all images and texts
525 Used by SetSplitterLeft() and DoFitColumns().
527 int GetColumnFitWidth(wxClientDC
& dc
,
530 bool subProps
) const;
532 /** Returns information about arbitrary position in the grid.
534 wxPropertyGridHitTestResult definition:
536 struct wxPropertyGridHitTestResult
538 wxPGProperty* GetProperty() const;
540 // column. -1 for margin
543 // Index of splitter hit, -1 for none.
546 // If splitter hit, then offset to that.
547 int splitterHitOffset;
551 wxPropertyGridHitTestResult
HitTest( const wxPoint
& pt
) const;
553 /** Returns true if page is visibly displayed.
555 inline bool IsDisplayed() const;
557 bool IsInNonCatMode() const { return (bool)(m_properties
== m_abcArray
); }
559 /** Only inits arrays, doesn't migrate things or such. */
560 void InitNonCatMode ();
562 void DoLimitPropertyEditing( wxPGProperty
* p
, bool limit
= true )
564 p
->SetFlagRecursively(wxPG_PROP_NOEDITOR
, limit
);
567 bool DoSelectProperty( wxPGProperty
* p
, unsigned int flags
= 0 );
569 /** widthChange is non-client.
571 void OnClientWidthChange( int newWidth
,
573 bool fromOnResize
= false );
575 /** Recalculates m_virtualHeight.
577 void RecalculateVirtualHeight()
579 m_virtualHeight
= GetActualVirtualHeight();
582 void SetColumnCount( int colCount
);
584 void PropagateColSizeDec( int column
, int decrease
, int dir
);
586 bool DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
= wxPG_RECURSE
);
588 bool DoSetPropertyValueString( wxPGProperty
* p
, const wxString
& value
);
590 bool DoSetPropertyValue( wxPGProperty
* p
, wxVariant
& value
);
592 bool DoSetPropertyValueWxObjectPtr( wxPGProperty
* p
, wxObject
* value
);
593 void DoSetPropertyValues( const wxVariantList
& list
,
594 wxPGProperty
* default_category
);
596 void DoSetPropertyValueUnspecified( wxPGProperty
* p
);
598 void SetSplitterLeft( bool subProps
= false );
600 /** Set virtual width for this particular page. */
601 void SetVirtualWidth( int width
);
603 void SortChildren( wxPGProperty
* p
);
606 void SetSelection( wxPGProperty
* p
) { m_selected
= p
; }
608 /** Called after virtual height needs to be recalculated.
610 void VirtualHeightChanged()
616 wxPGProperty
* DoAppend( wxPGProperty
* property
);
618 /** Returns property by its name. */
619 wxPGProperty
* BaseGetPropertyByName( const wxString
& name
) const;
621 void DoClearSelection()
626 /** Called in, for example, wxPropertyGrid::Clear. */
629 bool DoCollapse( wxPGProperty
* p
);
631 bool DoExpand( wxPGProperty
* p
);
633 void CalculateFontAndBitmapStuff( int vspacing
);
637 int DoGetSplitterPosition( int splitterIndex
= 0 ) const;
639 /** Returns column at x coordinate (in GetGrid()->GetPanel()).
641 Give pointer to int that receives index to splitter that is at x.
642 @param pSplitterHitOffset
643 Distance from said splitter.
645 int HitTestH( int x
, int* pSplitterHit
, int* pSplitterHitOffset
) const;
647 bool PrepareToAddItem( wxPGProperty
* property
,
648 wxPGProperty
* scheduledParent
);
650 /** If visible, then this is pointer to wxPropertyGrid.
651 This shall *never* be NULL to indicate that this state is not visible.
653 wxPropertyGrid
* m_pPropGrid
;
655 /** Pointer to currently used array. */
656 wxPGProperty
* m_properties
;
658 /** Array for categoric mode. */
659 wxPGRootProperty m_regularArray
;
661 /** Array for root of non-categoric mode. */
662 wxPGRootProperty
* m_abcArray
;
664 /** Dictionary for name-based access. */
665 wxPGHashMapS2P m_dictName
;
667 /** List of column widths (first column does not include margin). */
668 wxArrayInt m_colWidths
;
672 /** Most recently added category. */
673 wxPropertyCategory
* m_currentCategory
;
675 /** Pointer to selected property. */
676 wxPGProperty
* m_selected
;
678 /** Virtual width. */
681 /** Indicates total virtual height of visible properties. */
682 unsigned int m_virtualHeight
;
684 /** 1 if m_lastCaption is also the bottommost caption. */
685 unsigned char m_lastCaptionBottomnest
;
687 /** 1 items appended/inserted, so stuff needs to be done before drawing;
688 If m_virtualHeight == 0, then calcylatey's must be done.
691 unsigned char m_itemsAdded
;
693 /** 1 if any value is modified. */
694 unsigned char m_anyModified
;
696 unsigned char m_vhCalcPending
;
699 #endif // #ifndef SWIG
701 // -----------------------------------------------------------------------
703 #endif // wxUSE_PROPGRID
705 #endif // _WX_PROPGRID_PROPGRIDPAGESTATE_H_