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"
26 #include "wx/headerctrl.h"
28 // -----------------------------------------------------------------------
31 extern WXDLLIMPEXP_DATA_PROPGRID(const char) wxPropertyGridManagerNameStr
[];
34 /** @class wxPropertyGridPage
36 Holder of property grid page information. You can subclass this and
37 give instance in wxPropertyGridManager::AddPage. It inherits from
38 wxEvtHandler and can be used to process events specific to this
39 page (id of events will still be same as manager's). If you don't
40 want to use it to process all events of the page, you need to
41 return false in the derived wxPropertyGridPage::IsHandlingAllEvents.
43 Please note that wxPropertyGridPage lacks many non-const property
44 manipulation functions found in wxPropertyGridManager. Please use
45 parent manager (m_manager member variable) when needed.
47 Please note that most member functions are inherited and as such not
48 documented on this page. This means you will probably also want to read
49 wxPropertyGridInterface class reference.
51 @section propgridpage_event_handling Event Handling
53 wxPropertyGridPage receives events emitted by its wxPropertyGridManager, but
54 only those events that are specific to that page. If
55 wxPropertyGridPage::IsHandlingAllEvents returns false, then unhandled
56 events are sent to the manager's parent, as usual.
58 See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
64 class WXDLLIMPEXP_PROPGRID wxPropertyGridPage
: public wxEvtHandler
,
65 public wxPropertyGridInterface
,
66 public wxPropertyGridPageState
68 friend class wxPropertyGridManager
;
69 DECLARE_CLASS(wxPropertyGridPage
)
73 virtual ~wxPropertyGridPage();
75 /** Deletes all properties on page.
80 Reduces column sizes to minimum possible that contents are still
81 visibly (naturally some margin space will be applied as well).
84 Minimum size for the page to still display everything.
87 This function only works properly if size of containing grid was
90 Note that you can also get calculated column widths by calling
91 GetColumnWidth() immediately after this function returns.
95 /** Returns page index in manager;
97 inline int GetIndex() const;
99 /** Returns x-coordinate position of splitter on a page.
101 int GetSplitterPosition( int col
= 0 ) const
102 { return GetStatePtr()->DoGetSplitterPosition(col
); }
104 /** Returns "root property". It does not have name, etc. and it is not
105 visible. It is only useful for accessing its children.
107 wxPGProperty
* GetRoot() const { return GetStatePtr()->DoGetRoot(); }
109 /** Return pointer to contained property grid state.
111 wxPropertyGridPageState
* GetStatePtr()
116 /** Return pointer to contained property grid state.
118 const wxPropertyGridPageState
* GetStatePtr() const
124 Returns id of the tool bar item that represents this page on
125 wxPropertyGridManager's wxToolBar.
127 int GetToolId() const
132 /** Do any member initialization in this method.
134 - Called every time the page is added into a manager.
135 - You can add properties to the page here.
137 virtual void Init() {}
139 /** Return false here to indicate unhandled events should be
140 propagated to manager's parent, as normal.
142 virtual bool IsHandlingAllEvents() const { return true; }
144 /** Called every time page is about to be shown.
145 Useful, for instance, creating properties just-in-time.
147 virtual void OnShow();
149 virtual void RefreshProperty( wxPGProperty
* p
);
151 /** Sets splitter position on page.
153 Splitter position cannot exceed grid size, and therefore setting it
154 during form creation may fail as initial grid size is often smaller
155 than desired splitter position, especially when sizers are being used.
157 void SetSplitterPosition( int splitterPos
, int col
= 0 );
161 /** Propagate to other pages.
163 virtual void DoSetSplitterPosition( int pos
,
164 int splitterColumn
= 0,
165 int flags
= wxPG_SPLITTER_REFRESH
);
167 /** Page label (may be referred as name in some parts of documentation).
168 Can be set in constructor, or passed in
169 wxPropertyGridManager::AddPage(), but *not* in both.
173 //virtual bool ProcessEvent( wxEvent& event );
175 wxPropertyGridManager
* m_manager
;
177 int m_id
; // toolbar index
180 bool m_isDefault
; // is this base page object?
182 DECLARE_EVENT_TABLE()
185 // -----------------------------------------------------------------------
188 class wxPGHeaderCtrl
;
192 /** @class wxPropertyGridManager
194 wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid,
195 which can optionally have toolbar for mode and page selection, and help
197 Use window flags to select components to include.
199 @section propgridmanager_window_styles_ Window Styles
201 See @ref propgrid_window_styles.
203 @section propgridmanager_event_handling Event Handling
205 See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
206 for more information.
211 class WXDLLIMPEXP_PROPGRID
212 wxPropertyGridManager
: public wxPanel
, public wxPropertyGridInterface
214 DECLARE_CLASS(wxPropertyGridManager
)
215 friend class wxPropertyGridPage
;
220 Two step constructor.
221 Call Create when this constructor is called to build up the
222 wxPropertyGridManager.
224 wxPropertyGridManager();
227 /** The default constructor. The styles to be used are styles valid for
229 @see @link wndflags Additional Window Styles@endlink
231 wxPropertyGridManager( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
232 const wxPoint
& pos
= wxDefaultPosition
,
233 const wxSize
& size
= wxDefaultSize
,
234 long style
= wxPGMAN_DEFAULT_STYLE
,
235 const wxString
& name
= wxPropertyGridManagerNameStr
);
238 virtual ~wxPropertyGridManager();
240 /** Creates new property page. Note that the first page is not created
243 A label for the page. This may be shown as a toolbar tooltip etc.
245 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
246 default image is used.
248 wxPropertyGridPage instance. Manager will take ownership of this object.
249 NULL indicates that a default page instance should be created.
252 Returns pointer to created page.
255 If toolbar is used, it is highly recommended that the pages are
256 added when the toolbar is not turned off using window style flag
259 wxPropertyGridPage
* AddPage( const wxString
& label
= wxEmptyString
,
260 const wxBitmap
& bmp
= wxPG_NULL_BITMAP
,
261 wxPropertyGridPage
* pageObj
= NULL
)
263 return InsertPage(-1, label
, bmp
, pageObj
);
266 /** Deletes all all properties and all pages.
268 virtual void Clear();
270 /** Deletes all properties on given page.
272 void ClearPage( int page
);
274 /** Forces updating the value of property from the editor control.
275 Returns true if DoPropertyChanged was actually called.
277 bool CommitChangesFromEditor( wxUint32 flags
= 0 )
279 return m_pPropGrid
->CommitChangesFromEditor(flags
);
284 Whenever the control is created without any parameters, use Create to
285 actually create it. Don't access the control's public methods before
287 @see @link wndflags Additional Window Styles@endlink
289 bool Create( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
290 const wxPoint
& pos
= wxDefaultPosition
,
291 const wxSize
& size
= wxDefaultSize
,
292 long style
= wxPGMAN_DEFAULT_STYLE
,
293 const wxString
& name
= wxPropertyGridManagerNameStr
);
296 Enables or disables (shows/hides) categories according to parameter
299 WARNING: Not tested properly, use at your own risk.
301 bool EnableCategories( bool enable
)
303 long fl
= m_windowStyle
| wxPG_HIDE_CATEGORIES
;
304 if ( enable
) fl
= m_windowStyle
& ~(wxPG_HIDE_CATEGORIES
);
305 SetWindowStyleFlag(fl
);
309 /** Selects page, scrolls and/or expands items to ensure that the
310 given item is visible. Returns true if something was actually done.
312 bool EnsureVisible( wxPGPropArg id
);
314 /** Returns number of columns on given page. By the default,
315 returns number of columns on current page. */
316 int GetColumnCount( int page
= -1 ) const;
318 /** Returns height of the description text box. */
319 int GetDescBoxHeight() const;
321 /** Returns pointer to the contained wxPropertyGrid. This does not change
322 after wxPropertyGridManager has been created, so you can safely obtain
323 pointer once and use it for the entire lifetime of the instance.
325 wxPropertyGrid
* GetGrid()
327 wxASSERT(m_pPropGrid
);
331 const wxPropertyGrid
* GetGrid() const
333 wxASSERT(m_pPropGrid
);
334 return (const wxPropertyGrid
*)m_pPropGrid
;
337 /** Returns iterator class instance.
339 Calling this method in wxPropertyGridManager causes run-time assertion
340 failure. Please only iterate through individual pages or use
343 wxPropertyGridIterator
GetIterator( int flags
= wxPG_ITERATE_DEFAULT
,
344 wxPGProperty
* firstProp
= NULL
)
346 wxFAIL_MSG( "Please only iterate through individual pages "
347 "or use CreateVIterator()" );
348 return wxPropertyGridInterface::GetIterator( flags
, firstProp
);
351 wxPropertyGridConstIterator
352 GetIterator(int flags
= wxPG_ITERATE_DEFAULT
,
353 wxPGProperty
* firstProp
= NULL
) const
355 wxFAIL_MSG( "Please only iterate through individual pages "
356 " or use CreateVIterator()" );
357 return wxPropertyGridInterface::GetIterator( flags
, firstProp
);
360 /** Returns iterator class instance.
362 Calling this method in wxPropertyGridManager causes run-time assertion
363 failure. Please only iterate through individual pages or use
366 wxPropertyGridIterator
GetIterator( int flags
, int startPos
)
368 wxFAIL_MSG( "Please only iterate through individual pages "
369 "or use CreateVIterator()" );
371 return wxPropertyGridInterface::GetIterator( flags
, startPos
);
374 wxPropertyGridConstIterator
GetIterator( int flags
, int startPos
) const
376 wxFAIL_MSG( "Please only iterate through individual pages "
377 "or use CreateVIterator()" );
378 return wxPropertyGridInterface::GetIterator( flags
, startPos
);
381 /** Similar to GetIterator, but instead returns wxPGVIterator instance,
382 which can be useful for forward-iterating through arbitrary property
385 virtual wxPGVIterator
GetVIterator( int flags
) const;
387 /** Returns currently selected page.
389 wxPropertyGridPage
* GetCurrentPage() const
391 return GetPage(m_selPage
);
394 /** Returns page object for given page index.
396 wxPropertyGridPage
* GetPage( unsigned int ind
) const
398 return m_arrPages
[ind
];
401 /** Returns page object for given page name.
403 wxPropertyGridPage
* GetPage( const wxString
& name
) const
405 return GetPage(GetPageByName(name
));
409 Returns index for a page name.
411 If no match is found, wxNOT_FOUND is returned.
413 int GetPageByName( const wxString
& name
) const;
415 /** Returns index for a relevant propertygrid state.
417 If no match is found, wxNOT_FOUND is returned.
419 int GetPageByState( const wxPropertyGridPageState
* pstate
) const;
422 /** Returns wxPropertyGridPageState of given page, current page's for -1.
424 virtual wxPropertyGridPageState
* GetPageState( int page
) const;
427 /** Returns number of managed pages. */
428 size_t GetPageCount() const;
430 /** Returns name of given page. */
431 const wxString
& GetPageName( int index
) const;
433 /** Returns "root property" of the given page. It does not have name, etc.
434 and it is not visible. It is only useful for accessing its children.
436 wxPGProperty
* GetPageRoot( int index
) const;
438 /** Returns index to currently selected page. */
439 int GetSelectedPage() const { return m_selPage
; }
441 /** Alias for GetSelection(). */
442 wxPGProperty
* GetSelectedProperty() const
444 return GetSelection();
447 /** Shortcut for GetGrid()->GetSelection(). */
448 wxPGProperty
* GetSelection() const
450 return m_pPropGrid
->GetSelection();
453 /** Returns a pointer to the toolbar currently associated with the
454 wxPropertyGridManager (if any). */
455 wxToolBar
* GetToolBar() const { return m_pToolbar
; }
457 /** Creates new property page. Note that the first page is not created
460 Add to this position. -1 will add as the last item.
462 A label for the page. This may be shown as a toolbar tooltip etc.
464 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
465 default image is used.
467 wxPropertyGridPage instance. Manager will take ownership of this object.
468 If NULL, default page object is constructed.
471 Returns pointer to created page.
473 virtual wxPropertyGridPage
* InsertPage( int index
,
474 const wxString
& label
,
475 const wxBitmap
& bmp
= wxNullBitmap
,
476 wxPropertyGridPage
* pageObj
= NULL
);
479 Returns true if any property on any page has been modified by the user.
481 bool IsAnyModified() const;
484 Returns true if updating is frozen (ie Freeze() called but not yet
487 bool IsFrozen() const { return m_pPropGrid
->m_frozen
> 0; }
490 Returns true if any property on given page has been modified by the
493 bool IsPageModified( size_t index
) const;
496 Returns true if property is selected. Since selection is page
497 based, this function checks every page in the manager.
499 virtual bool IsPropertySelected( wxPGPropArg id
) const;
501 virtual void Refresh( bool eraseBackground
= true,
502 const wxRect
* rect
= (const wxRect
*) NULL
);
506 Returns false if it was not possible to remove page in question.
508 virtual bool RemovePage( int page
);
510 /** Select and displays a given page.
513 Index of page being seleced. Can be -1 to select nothing.
515 void SelectPage( int index
);
517 /** Select and displays a given page (by label). */
518 void SelectPage( const wxString
& label
)
520 int index
= GetPageByName(label
);
521 wxCHECK_RET( index
>= 0, wxT("No page with such name") );
525 /** Select and displays a given page. */
526 void SelectPage( wxPropertyGridPage
* ptr
)
528 SelectPage( GetPageByState(ptr
) );
531 /** Select a property. */
532 bool SelectProperty( wxPGPropArg id
, bool focus
= false )
534 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
535 return p
->GetParentState()->DoSelectProperty(p
, focus
);
539 Sets a column title. Default title for column 0 is "Property",
540 and "Value" for column 1.
542 @remarks If header is not shown yet, then calling this
543 member function will make it visible.
545 void SetColumnTitle( int idx
, const wxString
& title
);
548 Sets number of columns on given page (default is current page).
550 @remarks If you use header, then you should always use this
551 member function to set the column count, instead of
552 ones present in wxPropertyGrid or wxPropertyGridPage.
554 void SetColumnCount( int colCount
, int page
= -1 );
556 /** Sets label and text in description box.
558 void SetDescription( const wxString
& label
, const wxString
& content
);
560 /** Sets y coordinate of the description box splitter. */
561 void SetDescBoxHeight( int ht
, bool refresh
= true );
563 /** Moves splitter as left as possible, while still allowing all
564 labels to be shown in full.
566 If false, will still allow sub-properties (ie. properties which
567 parent is not root or category) to be cropped.
569 If true, takes labels on all pages into account.
571 void SetSplitterLeft( bool subProps
= false, bool allPages
= true );
574 Sets splitter position on individual page.
576 @remarks If you use header, then you should always use this
577 member function to set the splitter position, instead of
578 ones present in wxPropertyGrid or wxPropertyGridPage.
580 void SetPageSplitterPosition( int page
, int pos
, int column
= 0 );
583 Sets splitter position for all pages.
585 @remarks Splitter position cannot exceed grid size, and therefore
586 setting it during form creation may fail as initial grid
587 size is often smaller than desired splitter position,
588 especially when sizers are being used.
590 If you use header, then you should always use this
591 member function to set the splitter position, instead of
592 ones present in wxPropertyGrid or wxPropertyGridPage.
594 void SetSplitterPosition( int pos
, int column
= 0 );
598 Show or hide the property grid header control. It is hidden
601 @remarks Grid may look better if you use wxPG_NO_INTERNAL_BORDER
602 window style when showing a header.
604 void ShowHeader(bool show
= true);
610 // Subclassing helpers
614 Creates property grid for the manager. Reimplement in derived class to
615 use subclassed wxPropertyGrid. However, if you you do this then you
616 must also use the two-step construction (ie. default constructor and
617 Create() instead of constructor with arguments) when creating the
620 virtual wxPropertyGrid
* CreatePropertyGrid() const;
623 virtual void RefreshProperty( wxPGProperty
* p
);
626 // Overridden functions - no documentation required.
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
);
636 virtual bool Reparent( wxWindowBase
*newParent
);
639 virtual wxSize
DoGetBestSize() const;
644 void OnMouseMove( wxMouseEvent
&event
);
645 void OnMouseClick( wxMouseEvent
&event
);
646 void OnMouseUp( wxMouseEvent
&event
);
647 void OnMouseEntry( wxMouseEvent
&event
);
649 void OnPaint( wxPaintEvent
&event
);
651 void OnToolbarClick( wxCommandEvent
&event
);
652 void OnResize( wxSizeEvent
& event
);
653 void OnPropertyGridSelect( wxPropertyGridEvent
& event
);
654 void OnPGColDrag( wxPropertyGridEvent
& event
);
657 wxPropertyGrid
* m_pPropGrid
;
659 wxVector
<wxPropertyGridPage
*> m_arrPages
;
662 wxToolBar
* m_pToolbar
;
665 wxPGHeaderCtrl
* m_pHeaderCtrl
;
667 wxStaticText
* m_pTxtHelpCaption
;
668 wxStaticText
* m_pTxtHelpContent
;
670 wxPropertyGridPage
* m_emptyPage
;
672 wxArrayString m_columnLabels
;
676 // Selected page index.
687 int m_splitterHeight
;
693 wxCursor m_cursorSizeNS
;
695 int m_nextDescBoxSize
;
699 unsigned char m_dragStatus
;
701 unsigned char m_onSplitter
;
705 virtual wxPGProperty
* DoGetPropertyByName( const wxString
& name
) const;
707 /** Select and displays a given page. */
708 virtual bool DoSelectPage( int index
);
710 // Sets some members to defaults.
713 // Initializes some members.
714 void Init2( int style
);
717 virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle) const;
720 virtual bool ProcessEvent( wxEvent
& event
);
722 /** Recalculates new positions for components, according to the
725 void RecalculatePositions( int width
, int height
);
727 /** (Re)creates/destroys controls, according to the window style bits. */
728 void RecreateControls();
730 void UpdateDescriptionBox( int new_splittery
, int new_width
, int new_height
);
732 void RepaintDescBoxDecorations( wxDC
& dc
,
737 void SetDescribedProperty( wxPGProperty
* p
);
739 // Reimplement these to handle "descboxheight" state item
740 virtual bool SetEditableStateItem( const wxString
& name
, wxVariant value
);
741 virtual wxVariant
GetEditableStateItem( const wxString
& name
) const;
744 DECLARE_EVENT_TABLE()
747 // -----------------------------------------------------------------------
749 inline int wxPropertyGridPage::GetIndex() const
753 return m_manager
->GetPageByState(this);
756 // -----------------------------------------------------------------------
758 #endif // wxUSE_PROPGRID
760 #endif // _WX_PROPGRID_MANAGER_H_