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 /** Shortcut for GetGrid()->GetSelection(). */
470 wxPGProperty
* GetSelection() const
472 return m_pPropGrid
->GetSelection();
475 /** Returns a pointer to the toolbar currently associated with the
476 wxPropertyGridManager (if any). */
477 wxToolBar
* GetToolBar() const { return m_pToolbar
; }
479 /** Creates new property page. Note that the first page is not created
482 Add to this position. -1 will add as the last item.
484 A label for the page. This may be shown as a toolbar tooltip etc.
486 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
487 default image is used.
489 wxPropertyGridPage instance. Manager will take ownership of this object.
490 If NULL, default page object is constructed.
493 Returns pointer to created page.
495 virtual wxPropertyGridPage
* InsertPage( int index
,
496 const wxString
& label
,
497 const wxBitmap
& bmp
= wxNullBitmap
,
498 wxPropertyGridPage
* pageObj
= NULL
);
501 Returns true if any property on any page has been modified by the user.
503 bool IsAnyModified() const;
506 Returns true if updating is frozen (ie Freeze() called but not yet
509 bool IsFrozen() const { return m_pPropGrid
->m_frozen
> 0; }
512 Returns true if any property on given page has been modified by the
515 bool IsPageModified( size_t index
) const;
517 virtual void Refresh( bool eraseBackground
= true,
518 const wxRect
* rect
= (const wxRect
*) NULL
);
522 Returns false if it was not possible to remove page in question.
524 virtual bool RemovePage( int page
);
526 /** Select and displays a given page.
529 Index of page being seleced. Can be -1 to select nothing.
531 void SelectPage( int index
);
533 /** Select and displays a given page (by label). */
534 void SelectPage( const wxString
& label
)
536 int index
= GetPageByName(label
);
537 wxCHECK_RET( index
>= 0, wxT("No page with such name") );
541 /** Select and displays a given page. */
542 void SelectPage( wxPropertyGridPage
* ptr
)
544 SelectPage( GetPageByState(ptr
) );
547 /** Select a property. */
548 bool SelectProperty( wxPGPropArg id
, bool focus
= false )
550 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
551 return p
->GetParentState()->DoSelectProperty(p
, focus
);
554 /** Sets number of columns on given page (default is current page).
556 void SetColumnCount( int colCount
, int page
= -1 );
558 /** Sets label and text in description box.
560 void SetDescription( const wxString
& label
, const wxString
& content
);
562 /** Sets y coordinate of the description box splitter. */
563 void SetDescBoxHeight( int ht
, bool refresh
= true );
565 /** Moves splitter as left as possible, while still allowing all
566 labels to be shown in full.
568 If false, will still allow sub-properties (ie. properties which
569 parent is not root or category) to be cropped.
571 If true, takes labels on all pages into account.
573 void SetSplitterLeft( bool subProps
= false, bool allPages
= true );
575 /** Sets splitter position on individual page. */
576 void SetPageSplitterPosition( int page
, int pos
, int column
= 0 )
578 GetPage(page
)->DoSetSplitterPosition( pos
, column
);
581 /** Sets splitter position for all pages.
583 Splitter position cannot exceed grid size, and therefore setting it
584 during form creation may fail as initial grid size is often smaller
585 than desired splitter position, especially when sizers are being used.
587 void SetSplitterPosition( int pos
, int column
= 0 );
591 def
GetValuesFromPage(self
,
595 inc_attributes
=False
):
596 "Same as GetValues, but returns values from specific page only."
597 "For argument descriptions, see GetValues."
598 return page
.GetPropertyValues(dict_
, as_strings
, inc_attributes
)
605 // Subclassing helpers
608 /** Creates property grid for the manager. Override to use subclassed
611 virtual wxPropertyGrid
* CreatePropertyGrid() const;
613 virtual void RefreshProperty( wxPGProperty
* p
);
620 // Overridden functions - no documentation required.
623 virtual wxSize
DoGetBestSize() const;
624 void SetId( wxWindowID winid
);
626 virtual void Freeze();
628 virtual void SetExtraStyle ( long exStyle
);
629 virtual bool SetFont ( const wxFont
& font
);
630 virtual void SetWindowStyleFlag ( long style
);
641 void OnMouseMove( wxMouseEvent
&event
);
642 void OnMouseClick( wxMouseEvent
&event
);
643 void OnMouseUp( wxMouseEvent
&event
);
644 void OnMouseEntry( wxMouseEvent
&event
);
646 void OnPaint( wxPaintEvent
&event
);
648 void OnToolbarClick( wxCommandEvent
&event
);
649 void OnResize( wxSizeEvent
& event
);
650 void OnPropertyGridSelect( wxPropertyGridEvent
& event
);
654 wxPropertyGrid
* m_pPropGrid
;
656 wxVector
<wxPropertyGridPage
*> m_arrPages
;
659 wxToolBar
* m_pToolbar
;
661 wxStaticText
* m_pTxtHelpCaption
;
662 wxStaticText
* m_pTxtHelpContent
;
664 wxPropertyGridPage
* m_emptyPage
;
668 // Selected page index.
679 int m_splitterHeight
;
685 wxCursor m_cursorSizeNS
;
687 int m_nextDescBoxSize
;
691 unsigned char m_dragStatus
;
693 unsigned char m_onSplitter
;
695 virtual wxPGProperty
* DoGetPropertyByName( const wxString
& name
) const;
697 /** Select and displays a given page. */
698 virtual bool DoSelectPage( int index
);
700 // Sets some members to defaults.
703 // Initializes some members.
704 void Init2( int style
);
707 virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle) const;
710 /** Recalculates new positions for components, according to the
713 void RecalculatePositions( int width
, int height
);
715 /** (Re)creates/destroys controls, according to the window style bits. */
716 void RecreateControls();
718 void RefreshHelpBox( int new_splittery
, int new_width
, int new_height
);
720 void RepaintSplitter( wxDC
& dc
,
726 void SetDescribedProperty( wxPGProperty
* p
);
728 virtual bool ProcessEvent( wxEvent
& event
);
731 DECLARE_EVENT_TABLE()
732 #endif // #ifndef SWIG
733 #endif // #ifndef DOXYGEN
736 // -----------------------------------------------------------------------
738 inline int wxPropertyGridPage::GetIndex() const
742 return m_manager
->GetPageByState(this);
745 // -----------------------------------------------------------------------
747 #endif // wxUSE_PROPGRID
749 #endif // _WX_PROPGRID_MANAGER_H_