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_DATA_PROPGRID(const char) 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,
167 bool fromAutoCenter
= false );
169 /** Propagate to other pages.
171 void DoSetSplitterPositionThisPage( int pos
, int splitterColumn
= 0 )
173 wxPropertyGridPageState::DoSetSplitterPosition( pos
, splitterColumn
);
176 /** Page label (may be referred as name in some parts of documentation).
177 Can be set in constructor, or passed in
178 wxPropertyGridManager::AddPage(), but *not* in both.
184 //virtual bool ProcessEvent( wxEvent& event );
186 wxPropertyGridManager
* m_manager
;
188 int m_id
; // toolbar index
191 bool m_isDefault
; // is this base page object?
194 DECLARE_EVENT_TABLE()
198 // -----------------------------------------------------------------------
200 /** @class wxPropertyGridManager
202 wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid,
203 which can optionally have toolbar for mode and page selection, and help
205 Use window flags to select components to include.
207 @section propgridmanager_window_styles_ Window Styles
209 See @ref propgrid_window_styles.
211 @section propgridmanager_event_handling Event Handling
213 See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
214 for more information.
219 class WXDLLIMPEXP_PROPGRID
220 wxPropertyGridManager
: public wxPanel
, public wxPropertyGridInterface
223 DECLARE_CLASS(wxPropertyGridManager
)
225 friend class wxPropertyGridPage
;
229 %pythonAppend wxPropertyGridManager
{
230 self
._setOORInfo(self
)
231 self
.DoDefaultTypeMappings()
232 self
.edited_objects
= {}
233 self
.DoDefaultValueTypeMappings()
234 if not hasattr(self
.__class__
,'_vt2setter'):
235 self
.__class__
._vt2setter
= {}
237 %pythonAppend
wxPropertyGridManager() ""
239 wxPropertyGridManager( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
240 const wxPoint
& pos
= wxDefaultPosition
,
241 const wxSize
& size
= wxDefaultSize
,
242 long style
= wxPGMAN_DEFAULT_STYLE
,
244 wxPyPropertyGridManagerNameStr
);
245 %RenameCtor
(PrePropertyGridManager
, wxPropertyGridManager());
250 Two step constructor.
251 Call Create when this constructor is called to build up the
252 wxPropertyGridManager.
254 wxPropertyGridManager();
256 /** The default constructor. The styles to be used are styles valid for
258 @see @link wndflags Additional Window Styles@endlink
260 wxPropertyGridManager( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
261 const wxPoint
& pos
= wxDefaultPosition
,
262 const wxSize
& size
= wxDefaultSize
,
263 long style
= wxPGMAN_DEFAULT_STYLE
,
264 const wxString
& name
= wxPropertyGridManagerNameStr
);
267 virtual ~wxPropertyGridManager();
271 /** Creates new property page. Note that the first page is not created
274 A label for the page. This may be shown as a toolbar tooltip etc.
276 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
277 default image is used.
279 wxPropertyGridPage instance. Manager will take ownership of this object.
280 NULL indicates that a default page instance should be created.
283 Returns pointer to created page.
286 If toolbar is used, it is highly recommended that the pages are
287 added when the toolbar is not turned off using window style flag
290 wxPropertyGridPage
* AddPage( const wxString
& label
= wxEmptyString
,
291 const wxBitmap
& bmp
= wxPG_NULL_BITMAP
,
292 wxPropertyGridPage
* pageObj
= NULL
)
294 return InsertPage(-1, label
, bmp
, pageObj
);
297 /** Deletes all all properties and all pages.
299 virtual void Clear();
301 /** Deletes all properties on given page.
303 void ClearPage( int page
);
305 /** Forces updating the value of property from the editor control.
306 Returns true if DoPropertyChanged was actually called.
308 bool CommitChangesFromEditor( wxUint32 flags
= 0 )
310 return m_pPropGrid
->CommitChangesFromEditor(flags
);
315 Whenever the control is created without any parameters, use Create to
316 actually create it. Don't access the control's public methods before
318 @see @link wndflags Additional Window Styles@endlink
320 bool Create( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
321 const wxPoint
& pos
= wxDefaultPosition
,
322 const wxSize
& size
= wxDefaultSize
,
323 long style
= wxPGMAN_DEFAULT_STYLE
,
324 const wxString
& name
= wxPropertyGridManagerNameStr
);
327 Enables or disables (shows/hides) categories according to parameter
330 WARNING: Not tested properly, use at your own risk.
332 bool EnableCategories( bool enable
)
334 long fl
= m_windowStyle
| wxPG_HIDE_CATEGORIES
;
335 if ( enable
) fl
= m_windowStyle
& ~(wxPG_HIDE_CATEGORIES
);
336 SetWindowStyleFlag(fl
);
340 /** Selects page, scrolls and/or expands items to ensure that the
341 given item is visible. Returns true if something was actually done.
343 bool EnsureVisible( wxPGPropArg id
);
345 /** Returns number of columns on given page. By the default,
346 returns number of columns on current page. */
347 int GetColumnCount( int page
= -1 ) const;
349 /** Returns height of the description text box. */
350 int GetDescBoxHeight() const;
352 /** Returns pointer to the contained wxPropertyGrid. This does not change
353 after wxPropertyGridManager has been created, so you can safely obtain
354 pointer once and use it for the entire lifetime of the instance.
356 wxPropertyGrid
* GetGrid()
358 wxASSERT(m_pPropGrid
);
362 const wxPropertyGrid
* GetGrid() const
364 wxASSERT(m_pPropGrid
);
365 return (const wxPropertyGrid
*)m_pPropGrid
;
368 /** Returns iterator class instance.
370 Calling this method in wxPropertyGridManager causes run-time assertion
371 failure. Please only iterate through individual pages or use
374 wxPropertyGridIterator
GetIterator( int flags
= wxPG_ITERATE_DEFAULT
,
375 wxPGProperty
* firstProp
= NULL
)
377 wxFAIL_MSG( "Please only iterate through individual pages "
378 "or use CreateVIterator()" );
379 return wxPropertyGridInterface::GetIterator( flags
, firstProp
);
382 wxPropertyGridConstIterator
383 GetIterator(int flags
= wxPG_ITERATE_DEFAULT
,
384 wxPGProperty
* firstProp
= NULL
) const
386 wxFAIL_MSG( "Please only iterate through individual pages "
387 " or use CreateVIterator()" );
388 return wxPropertyGridInterface::GetIterator( flags
, firstProp
);
391 /** Returns iterator class instance.
393 Calling this method in wxPropertyGridManager causes run-time assertion
394 failure. Please only iterate through individual pages or use
397 wxPropertyGridIterator
GetIterator( int flags
, int startPos
)
399 wxFAIL_MSG( "Please only iterate through individual pages "
400 "or use CreateVIterator()" );
402 return wxPropertyGridInterface::GetIterator( flags
, startPos
);
405 wxPropertyGridConstIterator
GetIterator( int flags
, int startPos
) const
407 wxFAIL_MSG( "Please only iterate through individual pages "
408 "or use CreateVIterator()" );
409 return wxPropertyGridInterface::GetIterator( flags
, startPos
);
412 /** Similar to GetIterator, but instead returns wxPGVIterator instance,
413 which can be useful for forward-iterating through arbitrary property
416 virtual wxPGVIterator
GetVIterator( int flags
) const;
418 /** Returns currently selected page.
420 wxPropertyGridPage
* GetCurrentPage() const
422 return GetPage(m_selPage
);
425 /** Returns page object for given page index.
427 wxPropertyGridPage
* GetPage( unsigned int ind
) const
429 return m_arrPages
[ind
];
432 /** Returns page object for given page name.
434 wxPropertyGridPage
* GetPage( const wxString
& name
) const
436 return GetPage(GetPageByName(name
));
440 Returns index for a page name.
442 If no match is found, wxNOT_FOUND is returned.
444 int GetPageByName( const wxString
& name
) const;
446 /** Returns index for a relevant propertygrid state.
448 If no match is found, wxNOT_FOUND is returned.
450 int GetPageByState( const wxPropertyGridPageState
* pstate
) const;
452 /** Returns wxPropertyGridPageState of given page, current page's for -1.
454 virtual wxPropertyGridPageState
* GetPageState( int page
) const;
456 /** Returns number of managed pages. */
457 size_t GetPageCount() const;
459 /** Returns name of given page. */
460 const wxString
& GetPageName( int index
) const;
462 /** Returns "root property" of the given page. It does not have name, etc.
463 and it is not visible. It is only useful for accessing its children.
465 wxPGProperty
* GetPageRoot( int index
) const;
467 /** Returns index to currently selected page. */
468 int GetSelectedPage() const { return m_selPage
; }
470 /** Alias for GetSelection(). */
471 wxPGProperty
* GetSelectedProperty() const
473 return GetSelection();
476 /** Shortcut for GetGrid()->GetSelection(). */
477 wxPGProperty
* GetSelection() const
479 return m_pPropGrid
->GetSelection();
482 /** Returns a pointer to the toolbar currently associated with the
483 wxPropertyGridManager (if any). */
484 wxToolBar
* GetToolBar() const { return m_pToolbar
; }
486 /** Creates new property page. Note that the first page is not created
489 Add to this position. -1 will add as the last item.
491 A label for the page. This may be shown as a toolbar tooltip etc.
493 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
494 default image is used.
496 wxPropertyGridPage instance. Manager will take ownership of this object.
497 If NULL, default page object is constructed.
500 Returns pointer to created page.
502 virtual wxPropertyGridPage
* InsertPage( int index
,
503 const wxString
& label
,
504 const wxBitmap
& bmp
= wxNullBitmap
,
505 wxPropertyGridPage
* pageObj
= NULL
);
508 Returns true if any property on any page has been modified by the user.
510 bool IsAnyModified() const;
513 Returns true if updating is frozen (ie Freeze() called but not yet
516 bool IsFrozen() const { return m_pPropGrid
->m_frozen
> 0; }
519 Returns true if any property on given page has been modified by the
522 bool IsPageModified( size_t index
) const;
524 virtual void Refresh( bool eraseBackground
= true,
525 const wxRect
* rect
= (const wxRect
*) NULL
);
529 Returns false if it was not possible to remove page in question.
531 virtual bool RemovePage( int page
);
533 /** Select and displays a given page.
536 Index of page being seleced. Can be -1 to select nothing.
538 void SelectPage( int index
);
540 /** Select and displays a given page (by label). */
541 void SelectPage( const wxString
& label
)
543 int index
= GetPageByName(label
);
544 wxCHECK_RET( index
>= 0, wxT("No page with such name") );
548 /** Select and displays a given page. */
549 void SelectPage( wxPropertyGridPage
* ptr
)
551 SelectPage( GetPageByState(ptr
) );
554 /** Select a property. */
555 bool SelectProperty( wxPGPropArg id
, bool focus
= false )
557 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
558 return p
->GetParentState()->DoSelectProperty(p
, focus
);
561 /** Sets number of columns on given page (default is current page).
563 void SetColumnCount( int colCount
, int page
= -1 );
565 /** Sets label and text in description box.
567 void SetDescription( const wxString
& label
, const wxString
& content
);
569 /** Sets y coordinate of the description box splitter. */
570 void SetDescBoxHeight( int ht
, bool refresh
= true );
572 /** Moves splitter as left as possible, while still allowing all
573 labels to be shown in full.
575 If false, will still allow sub-properties (ie. properties which
576 parent is not root or category) to be cropped.
578 If true, takes labels on all pages into account.
580 void SetSplitterLeft( bool subProps
= false, bool allPages
= true );
582 /** Sets splitter position on individual page. */
583 void SetPageSplitterPosition( int page
, int pos
, int column
= 0 )
585 GetPage(page
)->DoSetSplitterPosition( pos
, column
);
588 /** Sets splitter position for all pages.
590 Splitter position cannot exceed grid size, and therefore setting it
591 during form creation may fail as initial grid size is often smaller
592 than desired splitter position, especially when sizers are being used.
594 void SetSplitterPosition( int pos
, int column
= 0 );
598 def
GetValuesFromPage(self
,
602 inc_attributes
=False
):
603 "Same as GetValues, but returns values from specific page only."
604 "For argument descriptions, see GetValues."
605 return page
.GetPropertyValues(dict_
, as_strings
, inc_attributes
)
612 // Subclassing helpers
615 /** Creates property grid for the manager. Override to use subclassed
618 virtual wxPropertyGrid
* CreatePropertyGrid() const;
620 virtual void RefreshProperty( wxPGProperty
* p
);
625 // Overridden functions - no documentation required.
628 virtual wxSize
DoGetBestSize() const;
629 void SetId( wxWindowID winid
);
631 virtual void Freeze();
633 virtual void SetExtraStyle ( long exStyle
);
634 virtual bool SetFont ( const wxFont
& font
);
635 virtual void SetWindowStyleFlag ( long style
);
646 void OnMouseMove( wxMouseEvent
&event
);
647 void OnMouseClick( wxMouseEvent
&event
);
648 void OnMouseUp( wxMouseEvent
&event
);
649 void OnMouseEntry( wxMouseEvent
&event
);
651 void OnPaint( wxPaintEvent
&event
);
653 void OnToolbarClick( wxCommandEvent
&event
);
654 void OnResize( wxSizeEvent
& event
);
655 void OnPropertyGridSelect( wxPropertyGridEvent
& event
);
659 wxPropertyGrid
* m_pPropGrid
;
661 wxVector
<wxPropertyGridPage
*> m_arrPages
;
664 wxToolBar
* m_pToolbar
;
666 wxStaticText
* m_pTxtHelpCaption
;
667 wxStaticText
* m_pTxtHelpContent
;
669 wxPropertyGridPage
* m_emptyPage
;
673 // Selected page index.
684 int m_splitterHeight
;
690 wxCursor m_cursorSizeNS
;
692 int m_nextDescBoxSize
;
696 unsigned char m_dragStatus
;
698 unsigned char m_onSplitter
;
700 virtual wxPGProperty
* DoGetPropertyByName( const wxString
& name
) const;
702 /** Select and displays a given page. */
703 virtual bool DoSelectPage( int index
);
705 // Sets some members to defaults.
708 // Initializes some members.
709 void Init2( int style
);
712 virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle) const;
715 /** Recalculates new positions for components, according to the
718 void RecalculatePositions( int width
, int height
);
720 /** (Re)creates/destroys controls, according to the window style bits. */
721 void RecreateControls();
723 void RefreshHelpBox( int new_splittery
, int new_width
, int new_height
);
725 void RepaintSplitter( wxDC
& dc
,
731 void SetDescribedProperty( wxPGProperty
* p
);
733 // Reimplement these to handle "descboxheight" state item
734 virtual bool SetEditableStateItem( const wxString
& name
, wxVariant value
);
735 virtual wxVariant
GetEditableStateItem( const wxString
& name
) const;
737 virtual bool ProcessEvent( wxEvent
& event
);
740 DECLARE_EVENT_TABLE()
741 #endif // #ifndef SWIG
744 // -----------------------------------------------------------------------
746 inline int wxPropertyGridPage::GetIndex() const
750 return m_manager
->GetPageByState(this);
753 // -----------------------------------------------------------------------
755 #endif // wxUSE_PROPGRID
757 #endif // _WX_PROPGRID_MANAGER_H_