Converted various wxArrayPtrVoids to wxVectors
[wxWidgets.git] / include / wx / propgrid / manager.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/propgrid/manager.h
3 // Purpose: wxPropertyGridManager
4 // Author: Jaakko Salli
5 // Modified by:
6 // Created: 2005-01-14
7 // RCS-ID: $Id:
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_PROPGRID_MANAGER_H_
13 #define _WX_PROPGRID_MANAGER_H_
14
15 #if wxUSE_PROPGRID
16
17 #include "wx/propgrid/propgrid.h"
18
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
27 // -----------------------------------------------------------------------
28
29 #ifndef SWIG
30 extern WXDLLIMPEXP_PROPGRID const wxChar *wxPropertyGridManagerNameStr;
31 #endif
32
33 /** @class wxPropertyGridPage
34
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.
41
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.
45
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.
49
50 @section propgridpage_event_handling Event Handling
51
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.
56
57 See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
58 for more information.
59
60 @library{wxpropgrid}
61 @category{propgrid}
62 */
63 class WXDLLIMPEXP_PROPGRID wxPropertyGridPage : public wxEvtHandler,
64 public wxPropertyGridInterface,
65 public wxPropertyGridPageState
66 {
67 friend class wxPropertyGridManager;
68 #ifndef SWIG
69 DECLARE_CLASS(wxPropertyGridPage)
70 #endif
71 public:
72
73 wxPropertyGridPage();
74 virtual ~wxPropertyGridPage();
75
76 /** Deletes all properties on page.
77 */
78 virtual void Clear();
79
80 /**
81 Reduces column sizes to minimum possible that contents are still
82 visibly (naturally some margin space will be applied as well).
83
84 @return
85 Minimum size for the page to still display everything.
86
87 @remarks
88 This function only works properly if size of containing grid was
89 already fairly large.
90
91 Note that you can also get calculated column widths by calling
92 GetColumnWidth() immediately after this function returns.
93 */
94 wxSize FitColumns();
95
96 /** Returns page index in manager;
97 */
98 inline int GetIndex() const;
99
100 /** Returns x-coordinate position of splitter on a page.
101 */
102 int GetSplitterPosition( int col = 0 ) const
103 { return GetStatePtr()->DoGetSplitterPosition(col); }
104
105 /** Returns "root property". It does not have name, etc. and it is not
106 visible. It is only useful for accessing its children.
107 */
108 wxPGProperty* GetRoot() const { return GetStatePtr()->DoGetRoot(); }
109
110 /** Return pointer to contained property grid state.
111 */
112 wxPropertyGridPageState* GetStatePtr()
113 {
114 return this;
115 }
116
117 /** Return pointer to contained property grid state.
118 */
119 const wxPropertyGridPageState* GetStatePtr() const
120 {
121 return this;
122 }
123
124 /**
125 Returns id of the tool bar item that represents this page on
126 wxPropertyGridManager's wxToolBar.
127 */
128 int GetToolId() const
129 {
130 return m_id;
131 }
132
133 /** Do any member initialization in this method.
134 @remarks
135 - Called every time the page is added into a manager.
136 - You can add properties to the page here.
137 */
138 virtual void Init() {}
139
140 /** Return false here to indicate unhandled events should be
141 propagated to manager's parent, as normal.
142 */
143 virtual bool IsHandlingAllEvents() const { return true; }
144
145 /** Called every time page is about to be shown.
146 Useful, for instance, creating properties just-in-time.
147 */
148 virtual void OnShow();
149
150 virtual void RefreshProperty( wxPGProperty* p );
151
152 /** Sets splitter position on page.
153 @remarks
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.
157 */
158 void SetSplitterPosition( int splitterPos, int col = 0 );
159
160 protected:
161
162 /** Propagate to other pages.
163 */
164 virtual void DoSetSplitterPosition( int pos,
165 int splitterColumn = 0,
166 bool allPages = false );
167
168 /** Propagate to other pages.
169 */
170 void DoSetSplitterPositionThisPage( int pos, int splitterColumn = 0 )
171 {
172 wxPropertyGridPageState::DoSetSplitterPosition( pos, splitterColumn );
173 }
174
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.
178 */
179 wxString m_label;
180
181 #ifndef SWIG
182
183 //virtual bool ProcessEvent( wxEvent& event );
184
185 wxPropertyGridManager* m_manager;
186
187 int m_id; // toolbar index
188
189 private:
190 bool m_isDefault; // is this base page object?
191
192 private:
193 DECLARE_EVENT_TABLE()
194 #endif
195 };
196
197 // -----------------------------------------------------------------------
198
199 /** @class wxPropertyGridManager
200
201 wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid,
202 which can optionally have toolbar for mode and page selection, and help
203 text box.
204 Use window flags to select components to include.
205
206 @section propgridmanager_window_styles_ Window Styles
207
208 See @ref propgrid_window_styles.
209
210 @section propgridmanager_event_handling Event Handling
211
212 See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
213 for more information.
214
215 @library{wxpropgrid}
216 @category{propgrid}
217 */
218 class WXDLLIMPEXP_PROPGRID
219 wxPropertyGridManager : public wxPanel, public wxPropertyGridInterface
220 {
221 #ifndef SWIG
222 DECLARE_CLASS(wxPropertyGridManager)
223 #endif
224 friend class wxPropertyGridPage;
225 public:
226
227 #ifdef SWIG
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 = {}
235 }
236 %pythonAppend wxPropertyGridManager() ""
237
238 wxPropertyGridManager( wxWindow *parent, wxWindowID id = wxID_ANY,
239 const wxPoint& pos = wxDefaultPosition,
240 const wxSize& size = wxDefaultSize,
241 long style = wxPGMAN_DEFAULT_STYLE,
242 const wxChar* name =
243 wxPyPropertyGridManagerNameStr );
244 %RenameCtor(PrePropertyGridManager, wxPropertyGridManager());
245
246 #else
247
248 /**
249 Two step constructor.
250 Call Create when this constructor is called to build up the
251 wxPropertyGridManager.
252 */
253 wxPropertyGridManager();
254
255 /** The default constructor. The styles to be used are styles valid for
256 the wxWindow.
257 @see @link wndflags Additional Window Styles@endlink
258 */
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 );
264
265 /** Destructor */
266 virtual ~wxPropertyGridManager();
267
268 #endif
269
270 /** Creates new property page. Note that the first page is not created
271 automatically.
272 @param label
273 A label for the page. This may be shown as a toolbar tooltip etc.
274 @param bmp
275 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
276 default image is used.
277 @param pageObj
278 wxPropertyGridPage instance. Manager will take ownership of this object.
279 NULL indicates that a default page instance should be created.
280
281 @return
282 Returns pointer to created page.
283
284 @remarks
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
287 switching.
288 */
289 wxPropertyGridPage* AddPage( const wxString& label = wxEmptyString,
290 const wxBitmap& bmp = wxPG_NULL_BITMAP,
291 wxPropertyGridPage* pageObj = NULL )
292 {
293 return InsertPage(-1, label, bmp, pageObj);
294 }
295
296 void ClearModifiedStatus ( wxPGPropArg id );
297
298 void ClearModifiedStatus ()
299 {
300 m_pPropGrid->ClearModifiedStatus();
301 }
302
303 /** Deletes all all properties and all pages.
304 */
305 virtual void Clear();
306
307 /** Deletes all properties on given page.
308 */
309 void ClearPage( int page );
310
311 /** Forces updating the value of property from the editor control.
312 Returns true if DoPropertyChanged was actually called.
313 */
314 bool CommitChangesFromEditor( wxUint32 flags = 0 )
315 {
316 return m_pPropGrid->CommitChangesFromEditor(flags);
317 }
318
319 /**
320 Two step creation.
321 Whenever the control is created without any parameters, use Create to
322 actually create it. Don't access the control's public methods before
323 this is called.
324 @see @link wndflags Additional Window Styles@endlink
325 */
326 bool Create( wxWindow *parent, wxWindowID id = wxID_ANY,
327 const wxPoint& pos = wxDefaultPosition,
328 const wxSize& size = wxDefaultSize,
329 long style = wxPGMAN_DEFAULT_STYLE,
330 const wxChar* name = wxPropertyGridManagerNameStr );
331
332 /**
333 Enables or disables (shows/hides) categories according to parameter
334 enable.
335
336 WARNING: Not tested properly, use at your own risk.
337 */
338 bool EnableCategories( bool enable )
339 {
340 long fl = m_windowStyle | wxPG_HIDE_CATEGORIES;
341 if ( enable ) fl = m_windowStyle & ~(wxPG_HIDE_CATEGORIES);
342 SetWindowStyleFlag(fl);
343 return true;
344 }
345
346 /** Selects page, scrolls and/or expands items to ensure that the
347 given item is visible. Returns true if something was actually done.
348 */
349 bool EnsureVisible( wxPGPropArg id );
350
351 /** Returns number of columns on given page. By the default,
352 returns number of columns on current page. */
353 int GetColumnCount( int page = -1 ) const;
354
355 /** Returns height of the description text box. */
356 int GetDescBoxHeight() const;
357
358 /** Returns pointer to the contained wxPropertyGrid. This does not change
359 after wxPropertyGridManager has been created, so you can safely obtain
360 pointer once and use it for the entire lifetime of the instance.
361 */
362 wxPropertyGrid* GetGrid()
363 {
364 wxASSERT(m_pPropGrid);
365 return m_pPropGrid;
366 };
367
368 const wxPropertyGrid* GetGrid() const
369 {
370 wxASSERT(m_pPropGrid);
371 return (const wxPropertyGrid*)m_pPropGrid;
372 };
373
374 /** Returns iterator class instance.
375 @remarks
376 Calling this method in wxPropertyGridManager causes run-time assertion
377 failure. Please only iterate through individual pages or use
378 CreateVIterator().
379 */
380 wxPropertyGridIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT,
381 wxPGProperty* firstProp = NULL )
382 {
383 wxFAIL_MSG( "Please only iterate through individual pages "
384 "or use CreateVIterator()" );
385 return wxPropertyGridInterface::GetIterator( flags, firstProp );
386 }
387
388 wxPropertyGridConstIterator
389 GetIterator(int flags = wxPG_ITERATE_DEFAULT,
390 wxPGProperty* firstProp = NULL) const
391 {
392 wxFAIL_MSG( "Please only iterate through individual pages "
393 " or use CreateVIterator()" );
394 return wxPropertyGridInterface::GetIterator( flags, firstProp );
395 }
396
397 /** Returns iterator class instance.
398 @remarks
399 Calling this method in wxPropertyGridManager causes run-time assertion
400 failure. Please only iterate through individual pages or use
401 CreateVIterator().
402 */
403 wxPropertyGridIterator GetIterator( int flags, int startPos )
404 {
405 wxFAIL_MSG( "Please only iterate through individual pages "
406 "or use CreateVIterator()" );
407
408 return wxPropertyGridInterface::GetIterator( flags, startPos );
409 }
410
411 wxPropertyGridConstIterator GetIterator( int flags, int startPos ) const
412 {
413 wxFAIL_MSG( "Please only iterate through individual pages "
414 "or use CreateVIterator()" );
415 return wxPropertyGridInterface::GetIterator( flags, startPos );
416 }
417
418 /** Similar to GetIterator, but instead returns wxPGVIterator instance,
419 which can be useful for forward-iterating through arbitrary property
420 containers.
421 */
422 virtual wxPGVIterator GetVIterator( int flags ) const;
423
424 /** Returns currently selected page.
425 */
426 wxPropertyGridPage* GetCurrentPage() const
427 {
428 return GetPage(m_selPage);
429 }
430
431 /** Returns page object for given page index.
432 */
433 wxPropertyGridPage* GetPage( unsigned int ind ) const
434 {
435 return m_arrPages[ind];
436 }
437
438 /** Returns page object for given page name.
439 */
440 wxPropertyGridPage* GetPage( const wxString& name ) const
441 {
442 return GetPage(GetPageByName(name));
443 }
444
445 /**
446 Returns index for a page name.
447
448 If no match is found, wxNOT_FOUND is returned.
449 */
450 int GetPageByName( const wxString& name ) const;
451
452 /** Returns index for a relevant propertygrid state.
453
454 If no match is found, wxNOT_FOUND is returned.
455 */
456 int GetPageByState( const wxPropertyGridPageState* pstate ) const;
457
458 /** Returns wxPropertyGridPageState of given page, current page's for -1.
459 */
460 virtual wxPropertyGridPageState* GetPageState( int page ) const;
461
462 /** Returns number of managed pages. */
463 size_t GetPageCount() const;
464
465 /** Returns name of given page. */
466 const wxString& GetPageName( int index ) const;
467
468 /** Returns "root property" of the given page. It does not have name, etc.
469 and it is not visible. It is only useful for accessing its children.
470 */
471 wxPGProperty* GetPageRoot( int index ) const;
472
473 /** Returns index to currently selected page. */
474 int GetSelectedPage() const { return m_selPage; }
475
476 /** Shortcut for GetGrid()->GetSelection(). */
477 wxPGProperty* GetSelection() const
478 {
479 return m_pPropGrid->GetSelection();
480 }
481
482 /** Returns a pointer to the toolbar currently associated with the
483 wxPropertyGridManager (if any). */
484 wxToolBar* GetToolBar() const { return m_pToolbar; }
485
486 /** Creates new property page. Note that the first page is not created
487 automatically.
488 @param index
489 Add to this position. -1 will add as the last item.
490 @param label
491 A label for the page. This may be shown as a toolbar tooltip etc.
492 @param bmp
493 Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
494 default image is used.
495 @param pageObj
496 wxPropertyGridPage instance. Manager will take ownership of this object.
497 If NULL, default page object is constructed.
498
499 @return
500 Returns pointer to created page.
501 */
502 virtual wxPropertyGridPage* InsertPage( int index,
503 const wxString& label,
504 const wxBitmap& bmp = wxNullBitmap,
505 wxPropertyGridPage* pageObj = NULL );
506
507 /**
508 Returns true if any property on any page has been modified by the user.
509 */
510 bool IsAnyModified() const;
511
512 /**
513 Returns true if updating is frozen (ie Freeze() called but not yet
514 Thaw() ).
515 */
516 bool IsFrozen() const { return m_pPropGrid->m_frozen > 0; }
517
518 /**
519 Returns true if any property on given page has been modified by the
520 user.
521 */
522 bool IsPageModified( size_t index ) const;
523
524 virtual void Refresh( bool eraseBackground = true,
525 const wxRect* rect = (const wxRect*) NULL );
526
527 /** Removes a page.
528 @return
529 Returns false if it was not possible to remove page in question.
530 */
531 virtual bool RemovePage( int page );
532
533 /** Select and displays a given page.
534
535 @param index
536 Index of page being seleced. Can be -1 to select nothing.
537 */
538 void SelectPage( int index );
539
540 /** Select and displays a given page (by label). */
541 void SelectPage( const wxString& label )
542 {
543 int index = GetPageByName(label);
544 wxCHECK_RET( index >= 0, wxT("No page with such name") );
545 SelectPage( index );
546 }
547
548 /** Select and displays a given page. */
549 void SelectPage( wxPropertyGridPage* ptr )
550 {
551 SelectPage( GetPageByState(ptr) );
552 }
553
554 /** Select a property. */
555 bool SelectProperty( wxPGPropArg id, bool focus = false )
556 {
557 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
558 return p->GetParentState()->DoSelectProperty(p, focus);
559 }
560
561 /** Sets number of columns on given page (default is current page).
562 */
563 void SetColumnCount( int colCount, int page = -1 );
564
565 /** Sets label and text in description box.
566 */
567 void SetDescription( const wxString& label, const wxString& content );
568
569 /** Sets y coordinate of the description box splitter. */
570 void SetDescBoxHeight( int ht, bool refresh = true );
571
572 /** Moves splitter as left as possible, while still allowing all
573 labels to be shown in full.
574 @param subProps
575 If false, will still allow sub-properties (ie. properties which
576 parent is not root or category) to be cropped.
577 @param allPages
578 If true, takes labels on all pages into account.
579 */
580 void SetSplitterLeft( bool subProps = false, bool allPages = true );
581
582 /** Sets splitter position on individual page. */
583 void SetPageSplitterPosition( int page, int pos, int column = 0 )
584 {
585 GetPage(page)->DoSetSplitterPosition( pos, column );
586 }
587
588 /** Sets splitter position for all pages.
589 @remarks
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.
593 */
594 void SetSplitterPosition( int pos, int column = 0 );
595
596 #ifdef SWIG
597 %pythoncode {
598 def GetValuesFromPage(self,
599 page,
600 dict_=None,
601 as_strings=False,
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)
606 }
607 #endif
608
609 protected:
610
611 //
612 // Subclassing helpers
613 //
614
615 /** Creates property grid for the manager. Override to use subclassed
616 wxPropertyGrid.
617 */
618 virtual wxPropertyGrid* CreatePropertyGrid() const;
619
620 virtual void RefreshProperty( wxPGProperty* p );
621
622 public:
623
624 #ifndef DOXYGEN
625
626 //
627 // Overridden functions - no documentation required.
628 //
629
630 virtual wxSize DoGetBestSize() const;
631 void SetId( wxWindowID winid );
632
633 virtual void Freeze();
634 virtual void Thaw();
635 virtual void SetExtraStyle ( long exStyle );
636 virtual bool SetFont ( const wxFont& font );
637 virtual void SetWindowStyleFlag ( long style );
638
639 protected:
640
641 public:
642
643 #ifndef SWIG
644
645 //
646 // Event handlers
647 //
648 void OnMouseMove( wxMouseEvent &event );
649 void OnMouseClick( wxMouseEvent &event );
650 void OnMouseUp( wxMouseEvent &event );
651 void OnMouseEntry( wxMouseEvent &event );
652
653 void OnPaint( wxPaintEvent &event );
654
655 void OnToolbarClick( wxCommandEvent &event );
656 void OnResize( wxSizeEvent& event );
657 void OnPropertyGridSelect( wxPropertyGridEvent& event );
658
659 protected:
660
661 wxPropertyGrid* m_pPropGrid;
662
663 wxVector<wxPropertyGridPage*> m_arrPages;
664
665 #if wxUSE_TOOLBAR
666 wxToolBar* m_pToolbar;
667 #endif
668 wxStaticText* m_pTxtHelpCaption;
669 wxStaticText* m_pTxtHelpContent;
670
671 wxPropertyGridPage* m_emptyPage;
672
673 long m_iFlags;
674
675 // Selected page index.
676 int m_selPage;
677
678 int m_width;
679
680 int m_height;
681
682 int m_extraHeight;
683
684 int m_splitterY;
685
686 int m_splitterHeight;
687
688 int m_nextTbInd;
689
690 int m_dragOffset;
691
692 wxCursor m_cursorSizeNS;
693
694 int m_nextDescBoxSize;
695
696 wxWindowID m_baseId;
697
698 unsigned char m_dragStatus;
699
700 unsigned char m_onSplitter;
701
702 virtual wxPGProperty* DoGetPropertyByName( const wxString& name ) const;
703
704 /** Select and displays a given page. */
705 virtual bool DoSelectPage( int index );
706
707 // Sets some members to defaults.
708 void Init1();
709
710 // Initializes some members.
711 void Init2( int style );
712
713 /*#ifdef __WXMSW__
714 virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle) const;
715 #endif*/
716
717 /** Recalculates new positions for components, according to the
718 given size.
719 */
720 void RecalculatePositions( int width, int height );
721
722 /** (Re)creates/destroys controls, according to the window style bits. */
723 void RecreateControls();
724
725 void RefreshHelpBox( int new_splittery, int new_width, int new_height );
726
727 void RepaintSplitter( wxDC& dc,
728 int new_splittery,
729 int new_width,
730 int new_height,
731 bool desc_too );
732
733 void SetDescribedProperty( wxPGProperty* p );
734
735 virtual bool ProcessEvent( wxEvent& event );
736
737 private:
738 DECLARE_EVENT_TABLE()
739 #endif // #ifndef SWIG
740 #endif // #ifndef DOXYGEN
741 };
742
743 // -----------------------------------------------------------------------
744
745 inline int wxPropertyGridPage::GetIndex() const
746 {
747 if ( !m_manager )
748 return wxNOT_FOUND;
749 return m_manager->GetPageByState(this);
750 }
751
752 // -----------------------------------------------------------------------
753
754 #endif // wxUSE_PROPGRID
755
756 #endif // _WX_PROPGRID_MANAGER_H_