1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/propgrid/manager.h
3 // Purpose: wxPropertyGridManager
4 // Author: Jaakko Salli
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_PROPGRID_MANAGER_H_
13 #define _WX_PROPGRID_MANAGER_H_
17 #include "wx/propgrid/propgrid.h"
19 #include "wx/dcclient.h"
20 #include "wx/scrolwin.h"
21 #include "wx/toolbar.h"
22 #include "wx/stattext.h"
23 #include "wx/button.h"
24 #include "wx/textctrl.h"
25 #include "wx/dialog.h"
27 // -----------------------------------------------------------------------
30 extern WXDLLIMPEXP_PROPGRID
const wxChar
*wxPropertyGridManagerNameStr
;
33 /** @class wxPropertyGridPage
35 Holder of property grid page information. You can subclass this and
36 give instance in wxPropertyGridManager::AddPage. It inherits from
37 wxEvtHandler and can be used to process events specific to this
38 page (id of events will still be same as manager's). If you don't
39 want to use it to process all events of the page, you need to
40 return false in the derived wxPropertyGridPage::IsHandlingAllEvents.
42 Please note that wxPropertyGridPage lacks many non-const property
43 manipulation functions found in wxPropertyGridManager. Please use
44 parent manager (m_manager member variable) when needed.
46 Please note that most member functions are inherited and as such not
47 documented on this page. This means you will probably also want to read
48 wxPropertyGridInterface class reference.
50 @section propgridpage_event_handling Event Handling
52 wxPropertyGridPage receives events emitted by its wxPropertyGridManager, but
53 only those events that are specific to that page. If
54 wxPropertyGridPage::IsHandlingAllEvents returns false, then unhandled
55 events are sent to the manager's parent, as usual.
57 See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
63 class WXDLLIMPEXP_PROPGRID wxPropertyGridPage
: public wxEvtHandler
,
64 public wxPropertyGridInterface
,
65 public wxPropertyGridPageState
67 friend class wxPropertyGridManager
;
69 DECLARE_CLASS(wxPropertyGridPage
)
74 virtual ~wxPropertyGridPage();
76 /** Deletes all properties on page.
81 Reduces column sizes to minimum possible that contents are still
82 visibly (naturally some margin space will be applied as well).
85 Minimum size for the page to still display everything.
88 This function only works properly if size of containing grid was
91 Note that you can also get calculated column widths by calling
92 GetColumnWidth() immediately after this function returns.
96 /** Returns page index in manager;
98 inline int GetIndex() const;
100 /** Returns x-coordinate position of splitter on a page.
102 int GetSplitterPosition( int col
= 0 ) const
103 { return GetStatePtr()->DoGetSplitterPosition(col
); }
105 /** Returns "root property". It does not have name, etc. and it is not
106 visible. It is only useful for accessing its children.
108 wxPGProperty
* GetRoot() const { return GetStatePtr()->DoGetRoot(); }
110 /** Return pointer to contained property grid state.
112 wxPropertyGridPageState
* GetStatePtr()
117 /** Return pointer to contained property grid state.
119 const wxPropertyGridPageState
* GetStatePtr() const
125 Returns id of the tool bar item that represents this page on
126 wxPropertyGridManager's wxToolBar.
128 int GetToolId() const
133 /** Do any member initialization in this method.
135 - Called every time the page is added into a manager.
136 - You can add properties to the page here.
138 virtual void Init() {}
140 /** Return false here to indicate unhandled events should be
141 propagated to manager's parent, as normal.
143 virtual bool IsHandlingAllEvents() const { return true; }
145 /** Called every time page is about to be shown.
146 Useful, for instance, creating properties just-in-time.
148 virtual void OnShow();
150 virtual void RefreshProperty( wxPGProperty
* p
);
152 /** Sets splitter position on page.
154 Splitter position cannot exceed grid size, and therefore setting it
155 during form creation may fail as initial grid size is often smaller
156 than desired splitter position, especially when sizers are being used.
158 void SetSplitterPosition( int splitterPos
, int col
= 0 );
162 /** Propagate to other pages.
164 virtual void DoSetSplitterPosition( int pos
,
165 int splitterColumn
= 0,
166 bool allPages
= false );
168 /** Propagate to other pages.
170 void DoSetSplitterPositionThisPage( int pos
, int splitterColumn
= 0 )
172 wxPropertyGridPageState::DoSetSplitterPosition( pos
, splitterColumn
);
175 /** Page label (may be referred as name in some parts of documentation).
176 Can be set in constructor, or passed in
177 wxPropertyGridManager::AddPage(), but *not* in both.
183 //virtual bool ProcessEvent( wxEvent& event );
185 wxPropertyGridManager
* m_manager
;
187 int m_id
; // toolbar index
190 bool m_isDefault
; // is this base page object?
193 DECLARE_EVENT_TABLE()
197 // -----------------------------------------------------------------------
199 /** @class wxPropertyGridManager
201 wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid,
202 which can optionally have toolbar for mode and page selection, and help
204 Use window flags to select components to include.
206 @section propgridmanager_window_styles_ Window Styles
208 See @ref propgrid_window_styles.
210 @section propgridmanager_event_handling Event Handling
212 See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
213 for more information.
218 class WXDLLIMPEXP_PROPGRID
219 wxPropertyGridManager
: public wxPanel
, public wxPropertyGridInterface
222 DECLARE_CLASS(wxPropertyGridManager
)
224 friend class wxPropertyGridPage
;
228 %pythonAppend wxPropertyGridManager
{
229 self
._setOORInfo(self
)
230 self
.DoDefaultTypeMappings()
231 self
.edited_objects
= {}
232 self
.DoDefaultValueTypeMappings()
233 if not hasattr(self
.__class__
,'_vt2setter'):
234 self
.__class__
._vt2setter
= {}
236 %pythonAppend
wxPropertyGridManager() ""
238 wxPropertyGridManager( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
239 const wxPoint
& pos
= wxDefaultPosition
,
240 const wxSize
& size
= wxDefaultSize
,
241 long style
= wxPGMAN_DEFAULT_STYLE
,
243 wxPyPropertyGridManagerNameStr
);
244 %RenameCtor
(PrePropertyGridManager
, wxPropertyGridManager());
249 Two step constructor.
250 Call Create when this constructor is called to build up the
251 wxPropertyGridManager.
253 wxPropertyGridManager();
255 /** The default constructor. The styles to be used are styles valid for
257 @see @link wndflags Additional Window Styles@endlink
259 wxPropertyGridManager( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
260 const wxPoint
& pos
= wxDefaultPosition
,
261 const wxSize
& size
= wxDefaultSize
,
262 long style
= wxPGMAN_DEFAULT_STYLE
,
263 const wxChar
* name
= wxPropertyGridManagerNameStr
);
266 virtual ~wxPropertyGridManager();
270 /** Creates new property page. Note that the first page is not created
273 A label for the page. This may be shown as a toolbar tooltip etc.
275 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
276 default image is used.
278 wxPropertyGridPage instance. Manager will take ownership of this object.
279 NULL indicates that a default page instance should be created.
282 Returns pointer to created page.
285 If toolbar is used, it is highly recommended that the pages are
286 added when the toolbar is not turned off using window style flag
289 wxPropertyGridPage
* AddPage( const wxString
& label
= wxEmptyString
,
290 const wxBitmap
& bmp
= wxPG_NULL_BITMAP
,
291 wxPropertyGridPage
* pageObj
= NULL
)
293 return InsertPage(-1, label
, bmp
, pageObj
);
296 /** Deletes all all properties and all pages.
298 virtual void Clear();
300 /** Deletes all properties on given page.
302 void ClearPage( int page
);
304 /** Forces updating the value of property from the editor control.
305 Returns true if DoPropertyChanged was actually called.
307 bool CommitChangesFromEditor( wxUint32 flags
= 0 )
309 return m_pPropGrid
->CommitChangesFromEditor(flags
);
314 Whenever the control is created without any parameters, use Create to
315 actually create it. Don't access the control's public methods before
317 @see @link wndflags Additional Window Styles@endlink
319 bool Create( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
320 const wxPoint
& pos
= wxDefaultPosition
,
321 const wxSize
& size
= wxDefaultSize
,
322 long style
= wxPGMAN_DEFAULT_STYLE
,
323 const wxChar
* name
= wxPropertyGridManagerNameStr
);
326 Enables or disables (shows/hides) categories according to parameter
329 WARNING: Not tested properly, use at your own risk.
331 bool EnableCategories( bool enable
)
333 long fl
= m_windowStyle
| wxPG_HIDE_CATEGORIES
;
334 if ( enable
) fl
= m_windowStyle
& ~(wxPG_HIDE_CATEGORIES
);
335 SetWindowStyleFlag(fl
);
339 /** Selects page, scrolls and/or expands items to ensure that the
340 given item is visible. Returns true if something was actually done.
342 bool EnsureVisible( wxPGPropArg id
);
344 /** Returns number of columns on given page. By the default,
345 returns number of columns on current page. */
346 int GetColumnCount( int page
= -1 ) const;
348 /** Returns height of the description text box. */
349 int GetDescBoxHeight() const;
351 /** Returns pointer to the contained wxPropertyGrid. This does not change
352 after wxPropertyGridManager has been created, so you can safely obtain
353 pointer once and use it for the entire lifetime of the instance.
355 wxPropertyGrid
* GetGrid()
357 wxASSERT(m_pPropGrid
);
361 const wxPropertyGrid
* GetGrid() const
363 wxASSERT(m_pPropGrid
);
364 return (const wxPropertyGrid
*)m_pPropGrid
;
367 /** Returns iterator class instance.
369 Calling this method in wxPropertyGridManager causes run-time assertion
370 failure. Please only iterate through individual pages or use
373 wxPropertyGridIterator
GetIterator( int flags
= wxPG_ITERATE_DEFAULT
,
374 wxPGProperty
* firstProp
= NULL
)
376 wxFAIL_MSG( "Please only iterate through individual pages "
377 "or use CreateVIterator()" );
378 return wxPropertyGridInterface::GetIterator( flags
, firstProp
);
381 wxPropertyGridConstIterator
382 GetIterator(int flags
= wxPG_ITERATE_DEFAULT
,
383 wxPGProperty
* firstProp
= NULL
) const
385 wxFAIL_MSG( "Please only iterate through individual pages "
386 " or use CreateVIterator()" );
387 return wxPropertyGridInterface::GetIterator( flags
, firstProp
);
390 /** Returns iterator class instance.
392 Calling this method in wxPropertyGridManager causes run-time assertion
393 failure. Please only iterate through individual pages or use
396 wxPropertyGridIterator
GetIterator( int flags
, int startPos
)
398 wxFAIL_MSG( "Please only iterate through individual pages "
399 "or use CreateVIterator()" );
401 return wxPropertyGridInterface::GetIterator( flags
, startPos
);
404 wxPropertyGridConstIterator
GetIterator( int flags
, int startPos
) const
406 wxFAIL_MSG( "Please only iterate through individual pages "
407 "or use CreateVIterator()" );
408 return wxPropertyGridInterface::GetIterator( flags
, startPos
);
411 /** Similar to GetIterator, but instead returns wxPGVIterator instance,
412 which can be useful for forward-iterating through arbitrary property
415 virtual wxPGVIterator
GetVIterator( int flags
) const;
417 /** Returns currently selected page.
419 wxPropertyGridPage
* GetCurrentPage() const
421 return GetPage(m_selPage
);
424 /** Returns page object for given page index.
426 wxPropertyGridPage
* GetPage( unsigned int ind
) const
428 return m_arrPages
[ind
];
431 /** Returns page object for given page name.
433 wxPropertyGridPage
* GetPage( const wxString
& name
) const
435 return GetPage(GetPageByName(name
));
439 Returns index for a page name.
441 If no match is found, wxNOT_FOUND is returned.
443 int GetPageByName( const wxString
& name
) const;
445 /** Returns index for a relevant propertygrid state.
447 If no match is found, wxNOT_FOUND is returned.
449 int GetPageByState( const wxPropertyGridPageState
* pstate
) const;
451 /** Returns wxPropertyGridPageState of given page, current page's for -1.
453 virtual wxPropertyGridPageState
* GetPageState( int page
) const;
455 /** Returns number of managed pages. */
456 size_t GetPageCount() const;
458 /** Returns name of given page. */
459 const wxString
& GetPageName( int index
) const;
461 /** Returns "root property" of the given page. It does not have name, etc.
462 and it is not visible. It is only useful for accessing its children.
464 wxPGProperty
* GetPageRoot( int index
) const;
466 /** Returns index to currently selected page. */
467 int GetSelectedPage() const { return m_selPage
; }
469 /** Alias for GetSelection(). */
470 wxPGProperty
* GetSelectedProperty() const
472 return GetSelection();
475 /** Shortcut for GetGrid()->GetSelection(). */
476 wxPGProperty
* GetSelection() const
478 return m_pPropGrid
->GetSelection();
481 /** Returns a pointer to the toolbar currently associated with the
482 wxPropertyGridManager (if any). */
483 wxToolBar
* GetToolBar() const { return m_pToolbar
; }
485 /** Creates new property page. Note that the first page is not created
488 Add to this position. -1 will add as the last item.
490 A label for the page. This may be shown as a toolbar tooltip etc.
492 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
493 default image is used.
495 wxPropertyGridPage instance. Manager will take ownership of this object.
496 If NULL, default page object is constructed.
499 Returns pointer to created page.
501 virtual wxPropertyGridPage
* InsertPage( int index
,
502 const wxString
& label
,
503 const wxBitmap
& bmp
= wxNullBitmap
,
504 wxPropertyGridPage
* pageObj
= NULL
);
507 Returns true if any property on any page has been modified by the user.
509 bool IsAnyModified() const;
512 Returns true if updating is frozen (ie Freeze() called but not yet
515 bool IsFrozen() const { return m_pPropGrid
->m_frozen
> 0; }
518 Returns true if any property on given page has been modified by the
521 bool IsPageModified( size_t index
) const;
523 virtual void Refresh( bool eraseBackground
= true,
524 const wxRect
* rect
= (const wxRect
*) NULL
);
528 Returns false if it was not possible to remove page in question.
530 virtual bool RemovePage( int page
);
532 /** Select and displays a given page.
535 Index of page being seleced. Can be -1 to select nothing.
537 void SelectPage( int index
);
539 /** Select and displays a given page (by label). */
540 void SelectPage( const wxString
& label
)
542 int index
= GetPageByName(label
);
543 wxCHECK_RET( index
>= 0, wxT("No page with such name") );
547 /** Select and displays a given page. */
548 void SelectPage( wxPropertyGridPage
* ptr
)
550 SelectPage( GetPageByState(ptr
) );
553 /** Select a property. */
554 bool SelectProperty( wxPGPropArg id
, bool focus
= false )
556 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
557 return p
->GetParentState()->DoSelectProperty(p
, focus
);
560 /** Sets number of columns on given page (default is current page).
562 void SetColumnCount( int colCount
, int page
= -1 );
564 /** Sets label and text in description box.
566 void SetDescription( const wxString
& label
, const wxString
& content
);
568 /** Sets y coordinate of the description box splitter. */
569 void SetDescBoxHeight( int ht
, bool refresh
= true );
571 /** Moves splitter as left as possible, while still allowing all
572 labels to be shown in full.
574 If false, will still allow sub-properties (ie. properties which
575 parent is not root or category) to be cropped.
577 If true, takes labels on all pages into account.
579 void SetSplitterLeft( bool subProps
= false, bool allPages
= true );
581 /** Sets splitter position on individual page. */
582 void SetPageSplitterPosition( int page
, int pos
, int column
= 0 )
584 GetPage(page
)->DoSetSplitterPosition( pos
, column
);
587 /** Sets splitter position for all pages.
589 Splitter position cannot exceed grid size, and therefore setting it
590 during form creation may fail as initial grid size is often smaller
591 than desired splitter position, especially when sizers are being used.
593 void SetSplitterPosition( int pos
, int column
= 0 );
597 def
GetValuesFromPage(self
,
601 inc_attributes
=False
):
602 "Same as GetValues, but returns values from specific page only."
603 "For argument descriptions, see GetValues."
604 return page
.GetPropertyValues(dict_
, as_strings
, inc_attributes
)
611 // Subclassing helpers
614 /** Creates property grid for the manager. Override to use subclassed
617 virtual wxPropertyGrid
* CreatePropertyGrid() const;
619 virtual void RefreshProperty( wxPGProperty
* p
);
624 // Overridden functions - no documentation required.
627 virtual wxSize
DoGetBestSize() const;
628 void SetId( wxWindowID winid
);
630 virtual void Freeze();
632 virtual void SetExtraStyle ( long exStyle
);
633 virtual bool SetFont ( const wxFont
& font
);
634 virtual void SetWindowStyleFlag ( long style
);
645 void OnMouseMove( wxMouseEvent
&event
);
646 void OnMouseClick( wxMouseEvent
&event
);
647 void OnMouseUp( wxMouseEvent
&event
);
648 void OnMouseEntry( wxMouseEvent
&event
);
650 void OnPaint( wxPaintEvent
&event
);
652 void OnToolbarClick( wxCommandEvent
&event
);
653 void OnResize( wxSizeEvent
& event
);
654 void OnPropertyGridSelect( wxPropertyGridEvent
& event
);
658 wxPropertyGrid
* m_pPropGrid
;
660 wxVector
<wxPropertyGridPage
*> m_arrPages
;
663 wxToolBar
* m_pToolbar
;
665 wxStaticText
* m_pTxtHelpCaption
;
666 wxStaticText
* m_pTxtHelpContent
;
668 wxPropertyGridPage
* m_emptyPage
;
672 // Selected page index.
683 int m_splitterHeight
;
689 wxCursor m_cursorSizeNS
;
691 int m_nextDescBoxSize
;
695 unsigned char m_dragStatus
;
697 unsigned char m_onSplitter
;
699 virtual wxPGProperty
* DoGetPropertyByName( const wxString
& name
) const;
701 /** Select and displays a given page. */
702 virtual bool DoSelectPage( int index
);
704 // Sets some members to defaults.
707 // Initializes some members.
708 void Init2( int style
);
711 virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle) const;
714 /** Recalculates new positions for components, according to the
717 void RecalculatePositions( int width
, int height
);
719 /** (Re)creates/destroys controls, according to the window style bits. */
720 void RecreateControls();
722 void RefreshHelpBox( int new_splittery
, int new_width
, int new_height
);
724 void RepaintSplitter( wxDC
& dc
,
730 void SetDescribedProperty( wxPGProperty
* p
);
732 // Reimplement these to handle "descboxheight" state item
733 virtual bool SetEditableStateItem( const wxString
& name
, wxVariant value
);
734 virtual wxVariant
GetEditableStateItem( const wxString
& name
) const;
736 virtual bool ProcessEvent( wxEvent
& event
);
739 DECLARE_EVENT_TABLE()
740 #endif // #ifndef SWIG
743 // -----------------------------------------------------------------------
745 inline int wxPropertyGridPage::GetIndex() const
749 return m_manager
->GetPageByState(this);
752 // -----------------------------------------------------------------------
754 #endif // wxUSE_PROPGRID
756 #endif // _WX_PROPGRID_MANAGER_H_