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
)
295 // -----------------------------------------------------------------------
297 /** Base class to derive new viterators.
299 class WXDLLIMPEXP_PROPGRID wxPGVIteratorBase
301 friend class wxPGVIterator
;
303 wxPGVIteratorBase() { m_refCount
= 1; }
304 virtual void Next() = 0;
312 if ( m_refCount
<= 0 )
316 virtual ~wxPGVIteratorBase() { }
318 wxPropertyGridIterator m_it
;
323 /** @class wxPGVIterator
325 Abstract implementation of a simple iterator. Can only be used
326 to iterate in forward order, and only through the entire container.
327 Used to have functions dealing with all properties work with both
328 wxPropertyGrid and wxPropertyGridManager.
330 class WXDLLIMPEXP_PROPGRID wxPGVIterator
333 wxPGVIterator() { m_pIt
= NULL
; }
334 wxPGVIterator( wxPGVIteratorBase
* obj
) { m_pIt
= obj
; }
335 ~wxPGVIterator() { UnRef(); }
336 void UnRef() { if (m_pIt
) m_pIt
->DecRef(); }
337 wxPGVIterator( const wxPGVIterator
& it
)
343 const wxPGVIterator
& operator=( const wxPGVIterator
& it
)
351 void Next() { m_pIt
->Next(); }
352 bool AtEnd() const { return m_pIt
->m_it
.AtEnd(); }
353 wxPGProperty
* GetProperty() const { return m_pIt
->m_it
.GetProperty(); }
355 wxPGVIteratorBase
* m_pIt
;
358 // -----------------------------------------------------------------------
361 // We won't need this class from wxPython
363 /** @class wxPropertyGridPageState
365 Contains low-level property page information (properties, column widths,
366 etc) of a single wxPropertyGrid or single wxPropertyGridPage. Generally you
367 should not use this class directly, but instead member functions in
368 wxPropertyGridInterface, wxPropertyGrid, wxPropertyGridPage, and
369 wxPropertyGridManager.
372 - In separate wxPropertyGrid component this class was known as
374 - Currently this class is not implemented in wxPython.
379 class WXDLLIMPEXP_PROPGRID wxPropertyGridPageState
381 friend class wxPGProperty
;
382 friend class wxPropertyGrid
;
383 friend class wxPGCanvas
;
384 friend class wxPropertyGridInterface
;
385 friend class wxPropertyGridPage
;
386 friend class wxPropertyGridManager
;
389 /** Default constructor. */
390 wxPropertyGridPageState();
393 virtual ~wxPropertyGridPageState();
395 /** Makes sure all columns have minimum width.
397 void CheckColumnWidths( int widthChange
= 0 );
400 Override this member function to add custom behavior on property
403 virtual void DoDelete( wxPGProperty
* item
);
405 wxSize
DoFitColumns( bool allowGridResize
= false );
407 wxPGProperty
* DoGetItemAtY( int y
) const;
410 Override this member function to add custom behavior on property
413 virtual wxPGProperty
* DoInsert( wxPGProperty
* parent
,
415 wxPGProperty
* property
);
418 This needs to be overridden in grid used the manager so that splitter
419 changes can be propagated to other pages.
421 virtual void DoSetSplitterPosition( int pos
,
422 int splitterColumn
= 0,
423 bool allPages
= false,
424 bool fromAutoCenter
= false );
426 bool EnableCategories( bool enable
);
428 /** Make sure virtual height is up-to-date.
430 void EnsureVirtualHeight()
432 if ( m_vhCalcPending
)
434 RecalculateVirtualHeight();
439 /** Enables or disables given property and its subproperties. */
440 bool DoEnableProperty( wxPGProperty
* p
, bool enable
);
442 /** Returns (precalculated) height of contained visible properties.
444 unsigned int GetVirtualHeight() const
446 wxASSERT( !m_vhCalcPending
);
447 return m_virtualHeight
;
450 /** Returns (precalculated) height of contained visible properties.
452 unsigned int GetVirtualHeight()
454 EnsureVirtualHeight();
455 return m_virtualHeight
;
458 /** Returns actual height of contained visible properties.
460 Mostly used for internal diagnostic purposes.
462 inline unsigned int GetActualVirtualHeight() const;
464 unsigned int GetColumnCount() const
466 return (unsigned int) m_colWidths
.size();
469 wxPGProperty
* GetSelection() const
474 int GetColumnMinWidth( int column
) const;
476 int GetColumnWidth( unsigned int column
) const
478 return m_colWidths
[column
];
481 wxPropertyGrid
* GetGrid() const { return m_pPropGrid
; }
483 /** Returns last item which could be iterated using given flags.
485 @link iteratorflags List of iterator flags@endlink
487 wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
);
489 const wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
) const
491 return ((wxPropertyGridPageState
*)this)->GetLastItem(flags
);
494 wxPropertyCategory
* GetPropertyCategory( const wxPGProperty
* p
) const;
496 wxPGProperty
* GetPropertyByLabel( const wxString
& name
,
497 wxPGProperty
* parent
= NULL
) const;
499 wxVariant
DoGetPropertyValues( const wxString
& listname
,
500 wxPGProperty
* baseparent
,
503 wxPGProperty
* DoGetRoot() const { return m_properties
; }
505 void DoSetPropertyName( wxPGProperty
* p
, const wxString
& newName
);
507 // Returns combined width of margin and all the columns
508 int GetVirtualWidth() const
514 Returns minimal width for given column so that all images and texts
517 Used by SetSplitterLeft() and DoFitColumns().
519 int GetColumnFitWidth(wxClientDC
& dc
,
522 bool subProps
) const;
524 /** Returns information about arbitrary position in the grid.
526 wxPropertyGridHitTestResult definition:
528 struct wxPropertyGridHitTestResult
530 wxPGProperty* GetProperty() const;
532 // column. -1 for margin
535 // Index of splitter hit, -1 for none.
538 // If splitter hit, then offset to that.
539 int splitterHitOffset;
543 wxPropertyGridHitTestResult
HitTest( const wxPoint
& pt
) const;
545 /** Returns true if page is visibly displayed.
547 inline bool IsDisplayed() const;
549 bool IsInNonCatMode() const { return (bool)(m_properties
== m_abcArray
); }
551 /** Only inits arrays, doesn't migrate things or such. */
552 void InitNonCatMode ();
554 void DoLimitPropertyEditing( wxPGProperty
* p
, bool limit
= true )
556 p
->SetFlagRecursively(wxPG_PROP_NOEDITOR
, limit
);
559 bool DoSelectProperty( wxPGProperty
* p
, unsigned int flags
= 0 );
561 /** widthChange is non-client.
563 void OnClientWidthChange( int newWidth
,
565 bool fromOnResize
= false );
567 /** Recalculates m_virtualHeight.
569 void RecalculateVirtualHeight()
571 m_virtualHeight
= GetActualVirtualHeight();
574 void SetColumnCount( int colCount
);
576 void PropagateColSizeDec( int column
, int decrease
, int dir
);
578 bool DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
= wxPG_RECURSE
);
580 bool DoSetPropertyValueString( wxPGProperty
* p
, const wxString
& value
);
582 bool DoSetPropertyValue( wxPGProperty
* p
, wxVariant
& value
);
584 bool DoSetPropertyValueWxObjectPtr( wxPGProperty
* p
, wxObject
* value
);
585 void DoSetPropertyValues( const wxVariantList
& list
,
586 wxPGProperty
* default_category
);
588 void DoSetPropertyValueUnspecified( wxPGProperty
* p
);
590 void SetSplitterLeft( bool subProps
= false );
592 /** Set virtual width for this particular page. */
593 void SetVirtualWidth( int width
);
595 void SortChildren( wxPGProperty
* p
);
598 void SetSelection( wxPGProperty
* p
) { m_selected
= p
; }
600 /** Called after virtual height needs to be recalculated.
602 void VirtualHeightChanged()
608 wxPGProperty
* DoAppend( wxPGProperty
* property
);
610 /** Returns property by its name. */
611 wxPGProperty
* BaseGetPropertyByName( const wxString
& name
) const;
613 void DoClearSelection()
618 /** Called in, for example, wxPropertyGrid::Clear. */
621 bool DoCollapse( wxPGProperty
* p
);
623 bool DoExpand( wxPGProperty
* p
);
625 void CalculateFontAndBitmapStuff( int vspacing
);
629 int DoGetSplitterPosition( int splitterIndex
= 0 ) const;
631 /** Returns column at x coordinate (in GetGrid()->GetPanel()).
633 Give pointer to int that receives index to splitter that is at x.
634 @param pSplitterHitOffset
635 Distance from said splitter.
637 int HitTestH( int x
, int* pSplitterHit
, int* pSplitterHitOffset
) const;
639 bool PrepareToAddItem( wxPGProperty
* property
,
640 wxPGProperty
* scheduledParent
);
642 /** If visible, then this is pointer to wxPropertyGrid.
643 This shall *never* be NULL to indicate that this state is not visible.
645 wxPropertyGrid
* m_pPropGrid
;
647 /** Pointer to currently used array. */
648 wxPGProperty
* m_properties
;
650 /** Array for categoric mode. */
651 wxPGRootProperty m_regularArray
;
653 /** Array for root of non-categoric mode. */
654 wxPGRootProperty
* m_abcArray
;
656 /** Dictionary for name-based access. */
657 wxPGHashMapS2P m_dictName
;
659 /** List of column widths (first column does not include margin). */
660 wxArrayInt m_colWidths
;
664 /** Most recently added category. */
665 wxPropertyCategory
* m_currentCategory
;
667 /** Pointer to selected property. */
668 wxPGProperty
* m_selected
;
670 /** Virtual width. */
673 /** Indicates total virtual height of visible properties. */
674 unsigned int m_virtualHeight
;
676 /** 1 if m_lastCaption is also the bottommost caption. */
677 unsigned char m_lastCaptionBottomnest
;
679 /** 1 items appended/inserted, so stuff needs to be done before drawing;
680 If m_virtualHeight == 0, then calcylatey's must be done.
683 unsigned char m_itemsAdded
;
685 /** 1 if any value is modified. */
686 unsigned char m_anyModified
;
688 unsigned char m_vhCalcPending
;
691 #endif // #ifndef SWIG
693 // -----------------------------------------------------------------------
695 #endif // wxUSE_PROPGRID
697 #endif // _WX_PROPGRID_PROPGRIDPAGESTATE_H_