543 lines
17 KiB
C
543 lines
17 KiB
C
|
/////////////////////////////////////////////////////////////////////////////
|
||
|
|
// Name: manager.h
|
||
|
|
// Purpose: interface of wxPropertyGridManager
|
||
|
|
// Author: wxWidgets team
|
||
|
|
// Licence: wxWindows licence
|
||
|
|
/////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
/**
|
||
|
|
@class wxPropertyGridPage
|
||
|
|
|
||
|
|
Holder of property grid page information. You can subclass this and
|
||
|
|
give instance in wxPropertyGridManager::AddPage. It inherits from
|
||
|
|
wxEvtHandler and can be used to process events specific to this
|
||
|
|
page (id of events will still be same as manager's). If you don't
|
||
|
|
want to use it to process all events of the page, you need to
|
||
|
|
return @false in the derived wxPropertyGridPage::IsHandlingAllEvents.
|
||
|
|
|
||
|
|
Please note that wxPropertyGridPage lacks many non-const property
|
||
|
|
manipulation functions found in wxPropertyGridManager.
|
||
|
|
Please use parent manager (m_manager member variable) when needed.
|
||
|
|
|
||
|
|
Please note that most member functions are inherited and as such not
|
||
|
|
documented on this page. This means you will probably also want to read
|
||
|
|
wxPropertyGridInterface class reference.
|
||
|
|
|
||
|
|
@section propgridpage_event_handling Event Handling
|
||
|
|
|
||
|
|
wxPropertyGridPage receives events emitted by its wxPropertyGridManager, but
|
||
|
|
only those events that are specific to that page. If wxPropertyGridPage::
|
||
|
|
IsHandlingAllEvents returns false, then unhandled events are sent to the
|
||
|
|
manager's parent, as usual.
|
||
|
|
|
||
|
|
See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
|
||
|
|
for more information.
|
||
|
|
|
||
|
|
@library{wxpropgrid}
|
||
|
|
@category{propgrid}
|
||
|
|
*/
|
||
|
|
class wxPropertyGridPage : public wxEvtHandler,
|
||
|
|
public wxPropertyGridInterface,
|
||
|
|
public wxPropertyGridPageState
|
||
|
|
{
|
||
|
|
friend class wxPropertyGridManager;
|
||
|
|
|
||
|
|
public:
|
||
|
|
wxPropertyGridPage();
|
||
|
|
virtual ~wxPropertyGridPage();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Deletes all properties on page.
|
||
|
|
*/
|
||
|
|
virtual void Clear();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Reduces column sizes to minimum possible that contents are still visibly
|
||
|
|
(naturally some margin space will be applied as well).
|
||
|
|
|
||
|
|
@return Returns minimum size for the page to still display everything.
|
||
|
|
|
||
|
|
@remarks This function only works properly if size of containing grid was
|
||
|
|
already fairly large.
|
||
|
|
|
||
|
|
Note that you can also get calculated column widths by calling
|
||
|
|
GetColumnWidth() immediately after this function returns.
|
||
|
|
*/
|
||
|
|
wxSize FitColumns();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns page index in manager;
|
||
|
|
*/
|
||
|
|
inline int GetIndex() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns "root property". It does not have name, etc. and it is not
|
||
|
|
visible. It is only useful for accessing its children.
|
||
|
|
*/
|
||
|
|
wxPGProperty* GetRoot() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns x-coordinate position of splitter on a page.
|
||
|
|
*/
|
||
|
|
int GetSplitterPosition( int col = 0 ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns id of the tool bar item that represents this page on
|
||
|
|
wxPropertyGridManager's wxToolBar.
|
||
|
|
*/
|
||
|
|
int GetToolId() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Do any member initialization in this method.
|
||
|
|
|
||
|
|
@remarks - Called every time the page is added into a manager.
|
||
|
|
- You can add properties to the page here.
|
||
|
|
*/
|
||
|
|
virtual void Init();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Return false here to indicate unhandled events should be
|
||
|
|
propagated to manager's parent, as normal.
|
||
|
|
*/
|
||
|
|
virtual bool IsHandlingAllEvents() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Called every time page is about to be shown.
|
||
|
|
Useful, for instance, creating properties just-in-time.
|
||
|
|
*/
|
||
|
|
virtual void OnShow();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Refreshes given property on page.
|
||
|
|
*/
|
||
|
|
virtual void RefreshProperty( wxPGProperty* p );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Sets splitter position on page.
|
||
|
|
|
||
|
|
@remarks
|
||
|
|
Splitter position cannot exceed grid size, and therefore setting it
|
||
|
|
during form creation may fail as initial grid size is often smaller than
|
||
|
|
desired splitter position, especially when sizers are being used.
|
||
|
|
*/
|
||
|
|
void SetSplitterPosition( int splitterPos, int col = 0 );
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
@class wxPropertyGridManager
|
||
|
|
|
||
|
|
wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid,
|
||
|
|
which can optionally have toolbar for mode and page selection, a help text
|
||
|
|
box, and a header.
|
||
|
|
|
||
|
|
wxPropertyGridManager inherits from wxPropertyGridInterface, and as such
|
||
|
|
it has most property manipulation functions. However, only some of them affect
|
||
|
|
properties on all pages (eg. GetPropertyByName() and ExpandAll()), while some
|
||
|
|
(eg. Append()) only apply to the currently selected page.
|
||
|
|
|
||
|
|
To operate explicitly on properties on specific page, use
|
||
|
|
wxPropertyGridManager::GetPage() to obtain pointer to page's
|
||
|
|
wxPropertyGridPage object.
|
||
|
|
|
||
|
|
Visual methods, such as SetCellBackgroundColour() are only available in
|
||
|
|
wxPropertyGrid. Use wxPropertyGridManager::GetGrid() to obtain pointer to it.
|
||
|
|
|
||
|
|
Non-virtual iterators will not work in wxPropertyGridManager. Instead, you must
|
||
|
|
acquire the internal grid (GetGrid()) or wxPropertyGridPage object (GetPage()).
|
||
|
|
|
||
|
|
wxPropertyGridManager constructor has exact same format as wxPropertyGrid
|
||
|
|
constructor, and basically accepts same extra window style flags (albeit also
|
||
|
|
has some extra ones).
|
||
|
|
|
||
|
|
Here's some example code for creating and populating a wxPropertyGridManager:
|
||
|
|
|
||
|
|
@code
|
||
|
|
wxPropertyGridManager* pgMan = new wxPropertyGridManager(this, PGID,
|
||
|
|
wxDefaultPosition, wxDefaultSize,
|
||
|
|
// These and other similar styles are automatically
|
||
|
|
// passed to the embedded wxPropertyGrid.
|
||
|
|
wxPG_BOLD_MODIFIED|wxPG_SPLITTER_AUTO_CENTER|
|
||
|
|
// Include toolbar.
|
||
|
|
wxPG_TOOLBAR |
|
||
|
|
// Include description box.
|
||
|
|
wxPG_DESCRIPTION |
|
||
|
|
// Include compactor.
|
||
|
|
wxPG_COMPACTOR |
|
||
|
|
// Plus defaults.
|
||
|
|
wxPGMAN_DEFAULT_STYLE
|
||
|
|
);
|
||
|
|
|
||
|
|
wxPropertyGridPage* page;
|
||
|
|
|
||
|
|
page = pgMan->AddPage("First Page");
|
||
|
|
|
||
|
|
page->Append( new wxPropertyCategory("Category A1") );
|
||
|
|
|
||
|
|
page->Append( new wxIntProperty("Number",wxPG_LABEL,1) );
|
||
|
|
|
||
|
|
page->Append( new wxColourProperty("Colour",wxPG_LABEL,*wxWHITE) );
|
||
|
|
|
||
|
|
page = pgMan->AddPage("Second Page");
|
||
|
|
|
||
|
|
page->Append( "Text",wxPG_LABEL,"(no text)" );
|
||
|
|
|
||
|
|
page->Append( new wxFontProperty("Font",wxPG_LABEL) );
|
||
|
|
|
||
|
|
// Display a header above the grid
|
||
|
|
pgMan->ShowHeader();
|
||
|
|
@endcode
|
||
|
|
|
||
|
|
@section propgridmanager_window_styles_ Window Styles
|
||
|
|
|
||
|
|
See @ref propgrid_window_styles.
|
||
|
|
|
||
|
|
@section propgridmanager_event_handling Event Handling
|
||
|
|
|
||
|
|
See @ref propgrid_event_handling "wxPropertyGrid Event Handling"
|
||
|
|
for more information.
|
||
|
|
|
||
|
|
@library{wxpropgrid}
|
||
|
|
@category{propgrid}
|
||
|
|
*/
|
||
|
|
class wxPropertyGridManager : public wxPanel, public wxPropertyGridInterface
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
Two step constructor.
|
||
|
|
Call Create when this constructor is called to build up the
|
||
|
|
wxPropertyGridManager.
|
||
|
|
*/
|
||
|
|
wxPropertyGridManager();
|
||
|
|
|
||
|
|
/**
|
||
|
|
The default constructor. The styles to be used are styles valid for
|
||
|
|
the wxWindow.
|
||
|
|
@see @link wndflags Additional Window Styles @endlink
|
||
|
|
*/
|
||
|
|
wxPropertyGridManager( wxWindow *parent, wxWindowID id = wxID_ANY,
|
||
|
|
const wxPoint& pos = wxDefaultPosition,
|
||
|
|
const wxSize& size = wxDefaultSize,
|
||
|
|
long style = wxPGMAN_DEFAULT_STYLE,
|
||
|
|
const wxString& name = wxPropertyGridManagerNameStr );
|
||
|
|
|
||
|
|
/** Destructor */
|
||
|
|
virtual ~wxPropertyGridManager();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Creates new property page. Note that the first page is not created
|
||
|
|
automatically.
|
||
|
|
|
||
|
|
@param label
|
||
|
|
A label for the page. This may be shown as a toolbar tooltip etc.
|
||
|
|
|
||
|
|
@param bmp
|
||
|
|
Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
|
||
|
|
default image is used.
|
||
|
|
|
||
|
|
@param pageObj
|
||
|
|
wxPropertyGridPage instance. Manager will take ownership of this
|
||
|
|
object. NULL indicates that a default page instance should be created.
|
||
|
|
|
||
|
|
@return Returns pointer to created property grid page.
|
||
|
|
|
||
|
|
@remarks If toolbar is used, it is highly recommended that the pages are
|
||
|
|
added when the toolbar is not turned off using window style flag
|
||
|
|
switching. Otherwise toolbar buttons might not be added properly.
|
||
|
|
*/
|
||
|
|
wxPropertyGridPage* AddPage( const wxString& label = wxEmptyString,
|
||
|
|
const wxBitmap& bmp = wxPG_NULL_BITMAP,
|
||
|
|
wxPropertyGridPage* pageObj = NULL );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Deletes all properties and all pages.
|
||
|
|
*/
|
||
|
|
virtual void Clear();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Deletes all properties on given page.
|
||
|
|
*/
|
||
|
|
void ClearPage( int page );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Forces updating the value of property from the editor control.
|
||
|
|
|
||
|
|
@return Returns @true if value was actually updated.
|
||
|
|
*/
|
||
|
|
bool CommitChangesFromEditor( wxUint32 flags = 0 );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Two step creation. Whenever the control is created without any parameters,
|
||
|
|
use Create to actually create it. Don't access the control's public methods
|
||
|
|
before this is called.
|
||
|
|
|
||
|
|
@see @ref propgrid_window_styles
|
||
|
|
*/
|
||
|
|
bool Create( wxWindow *parent, wxWindowID id = wxID_ANY,
|
||
|
|
const wxPoint& pos = wxDefaultPosition,
|
||
|
|
const wxSize& size = wxDefaultSize,
|
||
|
|
long style = wxPGMAN_DEFAULT_STYLE,
|
||
|
|
const wxString& name = wxPropertyGridManagerNameStr );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Enables or disables (shows/hides) categories according to parameter enable.
|
||
|
|
|
||
|
|
@remarks
|
||
|
|
Calling his may not properly update toolbar buttons.
|
||
|
|
*/
|
||
|
|
bool EnableCategories( bool enable );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Selects page, scrolls and/or expands items to ensure that the
|
||
|
|
given item is visible.
|
||
|
|
|
||
|
|
@return Returns @true if something was actually done.
|
||
|
|
*/
|
||
|
|
bool EnsureVisible( wxPGPropArg id );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns number of columns on given page. By the default,
|
||
|
|
returns number of columns on current page.
|
||
|
|
*/
|
||
|
|
int GetColumnCount( int page = -1 ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns height of the description text box.
|
||
|
|
*/
|
||
|
|
int GetDescBoxHeight() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns pointer to the contained wxPropertyGrid. This does not change
|
||
|
|
after wxPropertyGridManager has been created, so you can safely obtain
|
||
|
|
pointer once and use it for the entire lifetime of the manager
|
||
|
|
instance.
|
||
|
|
*/
|
||
|
|
wxPropertyGrid* GetGrid();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Similar to GetIterator, but instead returns wxPGVIterator instance,
|
||
|
|
which can be useful for forward-iterating through arbitrary property
|
||
|
|
containers.
|
||
|
|
*/
|
||
|
|
virtual wxPGVIterator GetVIterator( int flags ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns currently selected page.
|
||
|
|
*/
|
||
|
|
wxPropertyGridPage* GetCurrentPage() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns page object for given page index.
|
||
|
|
*/
|
||
|
|
wxPropertyGridPage* GetPage( unsigned int ind ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns page object for given page name.
|
||
|
|
*/
|
||
|
|
wxPropertyGridPage* GetPage( const wxString& name ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns index for a page name. If no match is found, wxNOT_FOUND is
|
||
|
|
returned.
|
||
|
|
*/
|
||
|
|
int GetPageByName( const wxString& name ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns number of managed pages.
|
||
|
|
*/
|
||
|
|
size_t GetPageCount() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns name of given page.
|
||
|
|
*/
|
||
|
|
const wxString& GetPageName( int index ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns "root property" of the given page. It does not have name, etc.
|
||
|
|
and it is not visible. It is only useful for accessing its children.
|
||
|
|
*/
|
||
|
|
wxPGProperty* GetPageRoot( int index ) const;
|
||
|
|
|
||
|
|
/** Returns index to currently selected page. */
|
||
|
|
int GetSelectedPage() const;
|
||
|
|
|
||
|
|
/** Alias for GetSelection(). */
|
||
|
|
wxPGProperty* GetSelectedProperty() const;
|
||
|
|
|
||
|
|
/** Shortcut for GetGrid()->GetSelection(). */
|
||
|
|
wxPGProperty* GetSelection() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns a pointer to the toolbar currently associated with the
|
||
|
|
wxPropertyGridManager (if any).
|
||
|
|
*/
|
||
|
|
wxToolBar* GetToolBar() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Creates new property page. Note that the first page is not created
|
||
|
|
automatically.
|
||
|
|
|
||
|
|
@param index
|
||
|
|
Add to this position. -1 will add as the last item.
|
||
|
|
|
||
|
|
@param label
|
||
|
|
A label for the page. This may be shown as a toolbar tooltip etc.
|
||
|
|
|
||
|
|
@param bmp
|
||
|
|
Bitmap image for toolbar. If wxNullBitmap is used, then a built-in
|
||
|
|
default image is used.
|
||
|
|
|
||
|
|
@param pageObj
|
||
|
|
wxPropertyGridPage instance. Manager will take ownership of this
|
||
|
|
object. If NULL, default page object is constructed.
|
||
|
|
|
||
|
|
@return Returns pointer to created page.
|
||
|
|
*/
|
||
|
|
virtual wxPropertyGridPage* InsertPage( int index, const wxString& label,
|
||
|
|
const wxBitmap& bmp = wxNullBitmap,
|
||
|
|
wxPropertyGridPage* pageObj = NULL );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns @true if any property on any page has been modified by the user.
|
||
|
|
*/
|
||
|
|
bool IsAnyModified() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns @true if updating is frozen (ie. Freeze() called but not yet Thaw() ).
|
||
|
|
*/
|
||
|
|
bool IsFrozen() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns @true if any property on given page has been modified by the user.
|
||
|
|
*/
|
||
|
|
bool IsPageModified( size_t index ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns true if property is selected. Since selection is page
|
||
|
|
based, this function checks every page in the manager.
|
||
|
|
*/
|
||
|
|
virtual bool IsPropertySelected( wxPGPropArg id ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Removes a page.
|
||
|
|
|
||
|
|
@return Returns @false if it was not possible to remove page in question.
|
||
|
|
*/
|
||
|
|
virtual bool RemovePage( int page );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Select and displays a given page.
|
||
|
|
|
||
|
|
@param index
|
||
|
|
Index of page being seleced. Can be -1 to select nothing.
|
||
|
|
*/
|
||
|
|
void SelectPage( int index );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Select and displays a given page (by label).
|
||
|
|
*/
|
||
|
|
void SelectPage( const wxString& label );
|
||
|
|
|
||
|
|
/** Select and displays a given page. */
|
||
|
|
void SelectPage( wxPropertyGridPage* page );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Select a property.
|
||
|
|
|
||
|
|
@see wxPropertyGrid::SelectProperty(),
|
||
|
|
wxPropertyGridInterface::ClearSelection()
|
||
|
|
*/
|
||
|
|
bool SelectProperty( wxPGPropArg id, bool focus = false );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Sets number of columns on given page (default is current page).
|
||
|
|
|
||
|
|
@remarks If you use header, then you should always use this
|
||
|
|
member function to set the column count, instead of
|
||
|
|
ones present in wxPropertyGrid or wxPropertyGridPage.
|
||
|
|
*/
|
||
|
|
void SetColumnCount( int colCount, int page = -1 );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Sets a column title. Default title for column 0 is "Property",
|
||
|
|
and "Value" for column 1.
|
||
|
|
|
||
|
|
@remarks If header is not shown yet, then calling this
|
||
|
|
member function will make it visible.
|
||
|
|
*/
|
||
|
|
void SetColumnTitle( int idx, const wxString& title );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Sets label and text in description box.
|
||
|
|
*/
|
||
|
|
void SetDescription( const wxString& label, const wxString& content );
|
||
|
|
|
||
|
|
/** Sets y coordinate of the description box splitter. */
|
||
|
|
void SetDescBoxHeight( int ht, bool refresh = true );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Moves splitter as left as possible, while still allowing all
|
||
|
|
labels to be shown in full.
|
||
|
|
|
||
|
|
@param subProps
|
||
|
|
If @false, will still allow sub-properties (ie. properties which
|
||
|
|
parent is not root or category) to be cropped.
|
||
|
|
|
||
|
|
@param allPages
|
||
|
|
If @true, takes labels on all pages into account.
|
||
|
|
*/
|
||
|
|
void SetSplitterLeft( bool subProps = false, bool allPages = true );
|
||
|
|
|
||
|
|
/** Moves splitter as left as possible on an individual page, while still allowing all
|
||
|
|
labels to be shown in full.
|
||
|
|
*/
|
||
|
|
void SetPageSplitterLeft(int page, bool subProps = false);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Sets splitter position on individual page.
|
||
|
|
|
||
|
|
@remarks If you use header, then you should always use this
|
||
|
|
member function to set the splitter position, instead of
|
||
|
|
ones present in wxPropertyGrid or wxPropertyGridPage.
|
||
|
|
*/
|
||
|
|
void SetPageSplitterPosition( int page, int pos, int column = 0 );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Sets splitter position for all pages.
|
||
|
|
|
||
|
|
@remarks Splitter position cannot exceed grid size, and therefore
|
||
|
|
setting it during form creation may fail as initial grid
|
||
|
|
size is often smaller than desired splitter position,
|
||
|
|
especially when sizers are being used.
|
||
|
|
|
||
|
|
If you use header, then you should always use this
|
||
|
|
member function to set the splitter position, instead of
|
||
|
|
ones present in wxPropertyGrid or wxPropertyGridPage.
|
||
|
|
*/
|
||
|
|
void SetSplitterPosition( int pos, int column = 0 );
|
||
|
|
|
||
|
|
/**
|
||
|
|
Show or hide the property grid header control. It is hidden
|
||
|
|
by the default.
|
||
|
|
|
||
|
|
@remarks Grid may look better if you use wxPG_NO_INTERNAL_BORDER
|
||
|
|
window style when showing a header.
|
||
|
|
*/
|
||
|
|
void ShowHeader(bool show = true);
|
||
|
|
|
||
|
|
protected:
|
||
|
|
|
||
|
|
//
|
||
|
|
// Subclassing helpers
|
||
|
|
//
|
||
|
|
|
||
|
|
/**
|
||
|
|
Creates property grid for the manager. Reimplement in derived class to
|
||
|
|
use subclassed wxPropertyGrid. However, if you do this then you
|
||
|
|
must also use the two-step construction (ie. default constructor and
|
||
|
|
Create() instead of constructor with arguments) when creating the
|
||
|
|
manager.
|
||
|
|
*/
|
||
|
|
virtual wxPropertyGrid* CreatePropertyGrid() const;
|
||
|
|
};
|