From bb6720bb9e4bbc17bcea2d933e80ba7cb8246d67 Mon Sep 17 00:00:00 2001 From: Jaakko Salli Date: Tue, 23 Sep 2008 17:37:27 +0000 Subject: [PATCH] Document revisioning (including more wx-like formatting and internal function removal) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55822 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- include/wx/propgrid/property.h | 8 +- interface/wx/propgrid/manager.h | 350 +++++------ interface/wx/propgrid/property.h | 981 +++++++++++++++---------------- 3 files changed, 652 insertions(+), 687 deletions(-) diff --git a/include/wx/propgrid/property.h b/include/wx/propgrid/property.h index 682732813c..b19ab1dfab 100644 --- a/include/wx/propgrid/property.h +++ b/include/wx/propgrid/property.h @@ -1565,7 +1565,9 @@ public: /** Determines, recursively, if all children are not unspecified. - Takes values in given list into account. + @param pendingList + Assumes members in this wxVariant list as pending + replacement values. */ bool AreAllChildrenSpecified( wxVariant* pendingList = NULL ) const; @@ -1579,9 +1581,9 @@ public: /** Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES. */ - FlagType UsesAutoUnspecified() const + bool UsesAutoUnspecified() const { - return HasFlag(wxPG_PROP_AUTO_UNSPECIFIED); + return HasFlag(wxPG_PROP_AUTO_UNSPECIFIED)?true:false; } wxBitmap* GetValueImage() const diff --git a/interface/wx/propgrid/manager.h b/interface/wx/propgrid/manager.h index ca86ad436c..7cf20d0ab7 100644 --- a/interface/wx/propgrid/manager.h +++ b/interface/wx/propgrid/manager.h @@ -19,15 +19,16 @@ 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. + 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. + 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. @@ -44,68 +45,80 @@ public: wxPropertyGridPage(); virtual ~wxPropertyGridPage(); - /** Deletes all properties on page. + /** + 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). + /** + Reduces column sizes to minimum possible that contents are still visibly + (naturally some margin space will be applied as well). - @retval - Minimum size for the page to still display everything. + @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. + @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. + Note that you can also get calculated column widths by calling + GetColumnWidth() immediately after this function returns. */ wxSize FitColumns(); - /** Returns page index in manager; + /** + Returns page index in manager; */ inline int GetIndex() const; - /** Returns x-coordinate position of splitter on a page. + /** + Returns "root property". It does not have name, etc. and it is not + visible. It is only useful for accessing its children. */ - int GetSplitterPosition( int col = 0 ) const { return GetStatePtr()->DoGetSplitterPosition(col); } + wxPGProperty* GetRoot() const; - /** Returns "root property". It does not have name, etc. and it is not - visible. It is only useful for accessing its children. + /** + Returns x-coordinate position of splitter on a page. */ - wxPGProperty* GetRoot() const { return GetStatePtr()->DoGetRoot(); } + int GetSplitterPosition( int col = 0 ) const; - /** Returns id of the tool bar item that represents this page on wxPropertyGridManager's wxToolBar. + /** + Returns id of the tool bar item that represents this page on + wxPropertyGridManager's wxToolBar. */ int GetToolId() const { return m_id; } - /** 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. + /** + 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 + /** + Return false here to indicate unhandled events should be propagated to manager's parent, as normal. */ virtual bool IsHandlingAllEvents() const { return true; } - /** Called every time page is about to be shown. + /** + 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. + 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 ); }; @@ -123,8 +136,9 @@ public: 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. + 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. @@ -191,22 +205,26 @@ public: class wxPropertyGridManager : public wxPanel, public wxPropertyGridInterface { public: - /** Creates new property page. Note that the first page is not created + /** + 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. + 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. + 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. - @retval - Returns index to the page created. - @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. + wxPropertyGridPage instance. Manager will take ownership of this + object. NULL indicates that a default page instance should be created. + + @return Returns index to the page created. + + @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. */ int AddPage( const wxString& label = wxEmptyString, const wxBitmap& bmp = wxPG_NULL_BITMAP, @@ -215,33 +233,39 @@ public: return InsertPage(-1,label,bmp,pageObj); } - void ClearModifiedStatus ( wxPGPropArg id ); + void ClearModifiedStatus( wxPGPropArg id ); - void ClearModifiedStatus () + void ClearModifiedStatus() { m_pPropGrid->ClearModifiedStatus(); } - /** Deletes all all properties and all pages. + /** + Deletes all properties and all pages. */ virtual void Clear(); - /** Deletes all properties on given page. + /** + Deletes all properties on given page. */ void ClearPage( int page ); - /** Forces updating the value of property from the editor control. - Returns true if DoPropertyChanged was actually called. + /** + Forces updating the value of property from the editor control. + + @return Returns @true if value was actually updated. */ bool CommitChangesFromEditor( wxUint32 flags = 0 ) { return m_pPropGrid->CommitChangesFromEditor(flags); } - /** Two step creation. Whenever the control is created without any parameters, + /** + 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. - @sa @link wndflags Additional Window Styles@endlink + + @see @ref propgrid_window_styles */ bool Create( wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, @@ -249,8 +273,11 @@ public: long style = wxPGMAN_DEFAULT_STYLE, const wxChar* name = wxPropertyGridManagerNameStr ); - /** Enables or disables (shows/hides) categories according to parameter enable. - WARNING: Not tested properly, use at your own risk. + /** + Enables or disables (shows/hides) categories according to parameter enable. + + @remarks + Calling his may not properly update toolbar buttons. */ bool EnableCategories( bool enable ) { @@ -260,21 +287,29 @@ public: return true; } - /** Selects page, scrolls and/or expands items to ensure that the - given item is visible. Returns true if something was actually done. + /** + 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 children of the root property of the selected page. */ + /** + Returns number of children of the root property of the selected page. + */ size_t GetChildrenCount() { return GetChildrenCount( m_pPropGrid->m_pState->m_properties ); } - /** Returns number of children of the root property of given page. */ + /** + Returns number of children of the root property of given page. + */ size_t GetChildrenCount( int pageIndex ); - /** Returns number of children for the property. + /** + Returns number of children for the property. NB: Cannot be in container methods class due to name hiding. */ @@ -284,107 +319,77 @@ public: return p->GetChildCount(); } - /** Returns number of columns on given page. By the default, - returns number of columns on current page. */ + /** + 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. */ + /** + Returns height of the description text box. + */ int GetDescBoxHeight() const; - /** Returns pointer to the contained wxPropertyGrid. This does not change + /** + 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 instance. + pointer once and use it for the entire lifetime of the manager + instance. */ - wxPropertyGrid* GetGrid() - { - wxASSERT(m_pPropGrid); - return m_pPropGrid; - }; + wxPropertyGrid* GetGrid(); - const wxPropertyGrid* GetGrid() const - { - wxASSERT(m_pPropGrid); - return (const wxPropertyGrid*)m_pPropGrid; - }; - - /** Returns iterator class instance. - @remarks - Calling this method in wxPropertyGridManager causes run-time assertion failure. - Please only iterate through individual pages or use CreateVIterator(). - */ - wxPropertyGridIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT, wxPGProperty* firstProp = NULL ) - { - wxFAIL_MSG(wxT("Please only iterate through individual pages or use CreateVIterator()")); - return wxPropertyGridInterface::GetIterator( flags, firstProp ); - } - - wxPropertyGridConstIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT, wxPGProperty* firstProp = NULL ) const - { - wxFAIL_MSG(wxT("Please only iterate through individual pages or use CreateVIterator()")); - return wxPropertyGridInterface::GetIterator( flags, firstProp ); - } - - /** Returns iterator class instance. - @remarks - Calling this method in wxPropertyGridManager causes run-time assertion failure. - Please only iterate through individual pages or use CreateVIterator(). - */ - wxPropertyGridIterator GetIterator( int flags, int startPos ) - { - wxFAIL_MSG(wxT("Please only iterate through individual pages or use CreateVIterator()")); - return wxPropertyGridInterface::GetIterator( flags, startPos ); - } - - wxPropertyGridConstIterator GetIterator( int flags, int startPos ) const - { - wxFAIL_MSG(wxT("Please only iterate through individual pages or use CreateVIterator()")); - return wxPropertyGridInterface::GetIterator( flags, startPos ); - } - - /** Similar to GetIterator, but instead returns wxPGVIterator instance, + /** + 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. + /** + Returns currently selected page. */ - wxPropertyGridPage* GetCurrentPage() const - { - return GetPage(m_selPage); - } + wxPropertyGridPage* GetCurrentPage() const; - /** Returns last page. + /** + Returns last page. */ wxPropertyGridPage* GetLastPage() const { return GetPage(m_arrPages.size()-1); } - /** Returns page object for given page index. + /** + Returns page object for given page index. */ wxPropertyGridPage* GetPage( unsigned int ind ) const { return (wxPropertyGridPage*)m_arrPages.Item(ind); } - /** Returns page object for given page name. + /** + Returns page object for given page name. */ wxPropertyGridPage* GetPage( const wxString& name ) const { return GetPage(GetPageByName(name)); } - /** Returns index for a page name. If no match is found, wxNOT_FOUND is returned. */ + /** + 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. */ + /** + 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. + /** + 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; @@ -401,43 +406,54 @@ public: /** Synonyme for GetSelectedPage. */ int GetSelection() const { return m_selPage; } - /** Returns a pointer to the toolbar currently associated with the - wxPropertyGridManager (if any). */ + /** + Returns a pointer to the toolbar currently associated with the + wxPropertyGridManager (if any). + */ wxToolBar* GetToolBar() const { return m_pToolbar; } /** 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. + 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. + 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. + 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. - @retval - Returns index to the page created. + wxPropertyGridPage instance. Manager will take ownership of this + object. If NULL, default page object is constructed. + + @return Returns index to the page created. */ - virtual int InsertPage( int index, const wxString& label, const wxBitmap& bmp = wxNullBitmap, - wxPropertyGridPage* pageObj = (wxPropertyGridPage*) NULL ); + virtual int 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. */ + /** + 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 { return (m_pPropGrid->m_frozen>0)?true:false; } + /** + 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. */ + /** + Returns @true if any property on given page has been modified by the user. + */ bool IsPageModified( size_t index ) const; - virtual void Refresh( bool eraseBackground = true, - const wxRect* rect = (const wxRect*) NULL ); - /** Removes a page. - @retval - Returns false if it was not possible to remove page in question. + + @return Returns @false if it was not possible to remove page in question. */ virtual bool RemovePage( int page ); @@ -448,28 +464,19 @@ public: */ void SelectPage( int index ); - /** Select and displays a given page (by label). */ - void SelectPage( const wxString& label ) - { - int index = GetPageByName(label); - wxCHECK_RET( index >= 0, wxT("No page with such name") ); - SelectPage( index ); - } + /** + Select and displays a given page (by label). + */ + void SelectPage( const wxString& label ); /** Select and displays a given page. */ - void SelectPage( wxPropertyGridPage* ptr ) - { - SelectPage( GetPageByState(ptr) ); - } + void SelectPage( wxPropertyGridPage* page ); /** Select a property. */ - bool SelectProperty( wxPGPropArg id, bool focus = false ) - { - wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false) - return p->GetParentState()->DoSelectProperty(p, focus); - } + bool SelectProperty( wxPGPropArg id, bool focus = false ); - /** Sets number of columns on given page (default is current page). + /** + Sets number of columns on given page (default is current page). */ void SetColumnCount( int colCount, int page = -1 ); @@ -482,11 +489,13 @@ public: /** 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. + 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. + If @true, takes labels on all pages into account. */ void SetSplitterLeft( bool subProps = false, bool allPages = true ); @@ -496,11 +505,13 @@ public: GetPage(page)->DoSetSplitterPosition( pos, column ); } - /** 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. + /** + 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. */ void SetSplitterPosition( int pos, int column = 0 ); @@ -516,12 +527,11 @@ protected: // Subclassing helpers // - /** Creates property grid for the manager. Override to use subclassed + /** + Creates property grid for the manager. Override to use subclassed wxPropertyGrid. */ virtual wxPropertyGrid* CreatePropertyGrid() const; - - virtual void RefreshProperty( wxPGProperty* p ); }; // ----------------------------------------------------------------------- diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h index b5c50da741..8394762127 100644 --- a/interface/wx/propgrid/property.h +++ b/interface/wx/propgrid/property.h @@ -187,11 +187,10 @@ Simple string property. wxPG_STRING_PASSWORD attribute may be used to echo value as asterisks and use wxTE_PASSWORD for wxTextCtrl. - @remarks - * wxStringProperty has a special trait: if it has value of "", - and also has child properties, then its displayed value becomes - composition of child property values, similar as with wxFontProperty, - for instance. + @remarks wxStringProperty has a special trait: if it has value of + "", and also has child properties, then its displayed + value becomes composition of child property values, similar as + with wxFontProperty, for instance. @subsection wxIntProperty @@ -412,18 +411,18 @@ class wxPGProperty : public wxObject public: typedef wxUint32 FlagType; - /** Basic constructor. + /** + Default constructor. */ wxPGProperty(); - /** Constructor. + /** + Constructor. Non-abstract property classes should have constructor of this style: @code - // If T is a class, then it should be a constant reference - // (e.g. const T& ) instead. - MyProperty( const wxString& label, const wxString& name, T value ) + MyProperty( const wxString& label, const wxString& name, const T& value ) : wxPGProperty() { // Generally recommended way to set the initial value @@ -440,10 +439,13 @@ public: */ wxPGProperty( const wxString& label, const wxString& name ); - /** Virtual destructor. It is customary for derived properties to implement this. */ + /** + Virtual destructor. It is customary for derived properties to implement this. + */ virtual ~wxPGProperty(); - /** This virtual function is called after m_value has been set. + /** + This virtual function is called after m_value has been set. @remarks - If m_value was set to Null variant (ie. unspecified value), OnSetValue() @@ -455,11 +457,13 @@ public: */ virtual void OnSetValue(); - /** Override this to return something else than m_value as the value. + /** + Override this to return something else than m_value as the value. */ virtual wxVariant DoGetValue() const { return m_value; } - /** Implement this function in derived class to check the value. + /** + Implement this function in derived class to check the value. Return true if it is ok. Returning false prevents property change events from occurring. @@ -468,7 +472,8 @@ public: */ virtual bool ValidateValue( wxVariant& value, wxPGValidationInfo& validationInfo ) const; - /** Converts 'text' into proper value 'variant'. Returns true if new (different than + /** + Converts 'text' into proper value 'variant'. Returns true if new (different than m_value) value could be interpreted from the text. @param argFlags If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable @@ -483,7 +488,8 @@ public: */ virtual bool StringToValue( wxVariant& variant, const wxString& text, int argFlags = 0 ) const; - /** Converts 'number' (including choice selection) into proper value 'variant'. + /** + Converts 'number' (including choice selection) into proper value 'variant'. Returns true if new (different than m_value) value could be interpreted from the integer. @param argFlags If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable one. @@ -497,9 +503,8 @@ public: */ virtual bool IntToValue( wxVariant& value, int number, int argFlags = 0 ) const; -public: - - /** Returns text representation of property's value. + /** + Returns text representation of property's value. @param argFlags If wxPG_FULL_VALUE is set, returns complete, storable string value instead of displayable. @@ -513,7 +518,8 @@ public: */ virtual wxString GetValueAsString( int argFlags = 0 ) const; - /** Converts string to a value, and if successful, calls SetValue() on it. + /** + Converts string to a value, and if successful, calls SetValue() on it. Default behavior is to do nothing. @param text String to get the value from. @@ -522,7 +528,8 @@ public: */ bool SetValueFromString( const wxString& text, int flags = 0 ); - /** Converts integer to a value, and if succesful, calls SetValue() on it. + /** + Converts integer to a value, and if succesful, calls SetValue() on it. Default behavior is to do nothing. @param value Int to get the value from. @@ -533,7 +540,8 @@ public: */ bool SetValueFromInt( long value, int flags = 0 ); - /** Returns size of the custom painted image in front of property. This method + /** + Returns size of the custom painted image in front of property. This method must be overridden to return non-default value if OnCustomPaint is to be called. @param item @@ -545,7 +553,8 @@ public: */ virtual wxSize OnMeasureImage( int item = -1 ) const; - /** Events received by editor widgets are processed here. Note that editor class + /** + Events received by editor widgets are processed here. Note that editor class usually processes most events. Some, such as button press events of TextCtrlAndButton class, can be handled here. Also, if custom handling for regular events is desired, then that can also be done (for example, @@ -565,7 +574,8 @@ public: */ virtual bool OnEvent( wxPropertyGrid* propgrid, wxWindow* wnd_primary, wxEvent& event ); - /** Called after value of a child property has been altered. Note that this function is + /** + Called after value of a child property has been altered. Note that this function is usually called at the time that value of this property, or given child property, is still pending for change. @@ -602,11 +612,13 @@ public: */ virtual void ChildChanged( wxVariant& thisValue, int childIndex, wxVariant& childValue ) const; - /** Returns pointer to an instance of used editor. + /** + Returns pointer to an instance of used editor. */ virtual const wxPGEditor* DoGetEditorClass() const; - /** Returns pointer to the wxValidator that should be used + /** + Returns pointer to the wxValidator that should be used with the editor of this property (NULL for no validator). Setting validator explicitly via SetPropertyValidator will override this. @@ -638,7 +650,8 @@ public: */ virtual wxValidator* DoGetValidator () const; - /** Override to paint an image in front of the property value text or drop-down + /** + Override to paint an image in front of the property value text or drop-down list item (but only if wxPGProperty::OnMeasureImage is overridden as well). If property's OnMeasureImage() returns size that has height != 0 but less than @@ -693,13 +706,15 @@ public: */ virtual void OnCustomPaint( wxDC& dc, const wxRect& rect, wxPGPaintData& paintdata ); - /** Returns used wxPGCellRenderer instance for given property column (label=0, value=1). + /** + Returns used wxPGCellRenderer instance for given property column (label=0, value=1). Default implementation returns editor's renderer for all columns. */ virtual wxPGCellRenderer* GetCellRenderer( int column ) const; - /** Returns which choice is currently selected. Only applies to properties + /** + Returns which choice is currently selected. Only applies to properties which have choices. Needs to reimplemented in derived class if property value does not @@ -707,11 +722,13 @@ public: */ virtual int GetChoiceSelection() const; - /** Refresh values of child properties. Automatically called after value is set. + /** + Refresh values of child properties. Automatically called after value is set. */ virtual void RefreshChildren(); - /** Special handling for attributes of this property. + /** + Special handling for attributes of this property. If returns false, then the attribute will be automatically stored in m_attributes. @@ -720,7 +737,8 @@ public: */ virtual bool DoSetAttribute( const wxString& name, wxVariant& value ); - /** Returns value of an attribute. + /** + Returns value of an attribute. Override if custom handling of attributes is needed. @@ -728,7 +746,8 @@ public: */ virtual wxVariant DoGetAttribute( const wxString& name ) const; - /** Returns instance of a new wxPGEditorDialogAdapter instance, which is + /** + Returns instance of a new wxPGEditorDialogAdapter instance, which is used when user presses the (optional) button next to the editor control; Default implementation returns NULL (ie. no action is generated when @@ -736,7 +755,8 @@ public: */ virtual wxPGEditorDialogAdapter* GetEditorDialog() const; - /** Returns wxPGCell of given column, NULL if none. If valid + /** + Returns wxPGCell of given column, NULL if none. If valid object is returned, caller will gain its ownership. */ wxPGCell* AcquireCell( unsigned int column ) @@ -749,7 +769,8 @@ public: return cell; } - /** Append a new choice to property's list of choices. + /** + Append a new choice to property's list of choices. @param label Label for added choice. @@ -763,7 +784,29 @@ public: */ int AddChoice( const wxString& label, int value = wxPG_INVALID_VALUE ); - /** Returns true if children of this property are component values (for instance, + /** + Properties which have private child properties should add them + with this function, called in their constructor. + */ + void AddChild( wxPGProperty* property ); + + /** + Adapts list variant into proper value using consecutive + ChildChanged() calls. + */ + void AdaptListToValue( wxVariant& list, wxVariant* value ) const; + + /** + Determines, recursively, if all children are not unspecified. + + @param pendingList + Assumes members in this wxVariant list as pending + replacement values. + */ + bool AreAllChildrenSpecified( wxVariant* pendingList = NULL ) const; + + /** + Returns true if children of this property are component values (for instance, points size, face name, and is_underlined are component values of a font). */ bool AreChildrenComponents() const @@ -774,61 +817,57 @@ public: return false; } - /** Removes entry from property's wxPGChoices and editor control (if it is active). + /** + Removes entry from property's wxPGChoices and editor control (if it is active). If selected item is deleted, then the value is set to unspecified. */ void DeleteChoice( int index ); + /** Deletes all child properties. */ + void Empty(); + /** Composes text from values of child properties. */ void GenerateComposedValue( wxString& text, int argFlags = 0 ) const; - /** Returns property's label. */ - const wxString& GetLabel() const { return m_label; } - - /** Returns property's name with all (non-category, non-root) parents. */ - wxString GetName() const; + /** + Returns property attribute value, null variant if not found. + */ + wxVariant GetAttribute( const wxString& name ) const; - /** Returns property's base name (ie. parent's name is not added in any case) */ - const wxString& GetBaseName() const { return m_name; } + /** Returns named attribute, as string, if found. Otherwise defVal is returned. + */ + wxString GetAttribute( const wxString& name, const wxString& defVal ) const; - /** Returns read-only reference to property's list of choices. + /** Returns named attribute, as long, if found. Otherwise defVal is returned. */ - const wxPGChoices& GetChoices() const; + long GetAttributeAsLong( const wxString& name, long defVal ) const; - /** Returns coordinate to the top y of the property. Note that the - position of scrollbars is not taken into account. + /** Returns named attribute, as double, if found. Otherwise defVal is returned. */ - int GetY() const; + double GetAttributeAsDouble( const wxString& name, double defVal ) const; - wxVariant GetValue() const - { - return DoGetValue(); - } + /** + Returns attributes as list wxVariant. + */ + wxVariant GetAttributesAsList() const; - /** Returns reference to the internal stored value. GetValue is preferred - way to get the actual value, since GetValueRef ignores DoGetValue, - which may override stored value. + /** + Returns editor used for given column. NULL for no editor. */ - wxVariant& GetValueRef() + const wxPGEditor* GetColumnEditor( int column ) const { - return m_value; - } + if ( column == 1 ) + return GetEditorClass(); - const wxVariant& GetValueRef() const - { - return m_value; + return NULL; } - /** To acquire property's value as string, you should use this - function (instead of GetValueAsString()), as it may produce - more accurate value in future versions. - */ - wxString GetValueString( int argFlags = 0 ) const; - - void UpdateControl( wxWindow* primary ); + /** Returns property's base name (ie. parent's name is not added in any case) */ + const wxString& GetBaseName() const { return m_name; } - /** Returns wxPGCell of given column, NULL if none. wxPGProperty + /** + Returns wxPGCell of given column, NULL if none. wxPGProperty will retain ownership of the cell object. */ wxPGCell* GetCell( unsigned int column ) const @@ -839,88 +878,178 @@ public: return (wxPGCell*) m_cells[column]; } + /** + Returns number of child properties. + */ + unsigned int GetChildCount() const; + + /** + Returns height of children, recursively, and + by taking expanded/collapsed status into account. + + @param lh + Line height. Pass result of GetGrid()->GetRowHeight() here. + + @param iMax + Only used (internally) when finding property y-positions. + */ + int GetChildrenHeight( int lh, int iMax = -1 ) const; + + /** + Returns read-only reference to property's list of choices. + */ + const wxPGChoices& GetChoices() const; + + /** + Returns client data (void*) of a property. + */ + void* GetClientData() const; + + /** Sets managed client object of a property. + */ + wxClientData *GetClientObject() const; + + /** + Returns property's default value. If property's value type is not + a built-in one, and "DefaultValue" attribute is not defined, then + this function usually returns Null variant. + */ + wxVariant GetDefaultValue() const; + /** Returns property's displayed text. - */ + */ wxString GetDisplayedString() const { return GetValueString(0); } + /** + Returns wxPGEditor that will be used and created when + property becomes selected. Returns more accurate value + than DoGetEditorClass(). + */ + const wxPGEditor* GetEditorClass() const; + /** Returns property grid where property lies. */ wxPropertyGrid* GetGrid() const; - /** Returns owner wxPropertyGrid, but only if one is currently on a page - displaying this property. */ + /** + Returns owner wxPropertyGrid, but only if one is currently on a page + displaying this property. + */ wxPropertyGrid* GetGridIfDisplayed() const; - /** Returns highest level non-category, non-root parent. Useful when you - have nested wxCustomProperties/wxParentProperties. - @remarks - Thus, if immediate parent is root or category, this will return the - property itself. + /** + Returns property's help or description text. + + @see SetHelpString() */ - wxPGProperty* GetMainParent() const; + const wxString& GetHelpString() const; - /** Return parent of property */ - wxPGProperty* GetParent() const { return m_parent; } + /** + Returns position in parent's array. + */ + unsigned int GetIndexInParent() const; - /** Returns true if property has editable wxTextCtrl when selected. + /** Returns property's label. */ + const wxString& GetLabel() const { return m_label; } - @remarks - Altough disabled properties do not displayed editor, they still - return True here as being disabled is considered a temporary - condition (unlike being read-only or having limited editing enabled). + /** + Returns last visible child property, recursively. */ - bool IsTextEditable() const; + const wxPGProperty* GetLastVisibleSubItem() const; - bool IsValueUnspecified() const - { - return m_value.IsNull(); - } + /** + Returns highest level non-category, non-root parent. Useful when you + have nested wxCustomProperties/wxParentProperties. - FlagType HasFlag( FlagType flag ) const - { - return ( m_flags & flag ); - } + @remarks If immediate parent is root or category, this will return the + property itself. + */ + wxPGProperty* GetMainParent() const; - /** Returns comma-delimited string of property attributes. + /** Returns maximum allowed length of property's text value. */ - const wxPGAttributeStorage& GetAttributes() const + int GetMaxLength() const { - return m_attributes; + return (int) m_maxLen; } - /** Returns m_attributes as list wxVariant. + /** Returns property's name with all (non-category, non-root) parents. */ + wxString GetName() const; + + /** Return parent of property */ + wxPGProperty* GetParent() const { return m_parent; } + + /** + Returns (direct) child property with given name (or NULL if not found). */ - wxVariant GetAttributesAsList() const; + wxPGProperty* GetPropertyByName( const wxString& name ) const; + + /** Gets assignable version of property's validator. */ + wxValidator* GetValidator() const; - FlagType GetFlags() const + /** + Returns property's value. + */ + wxVariant GetValue() const { - return m_flags; + return DoGetValue(); } - const wxPGEditor* GetEditorClass() const; + /** + Returns bitmap that appears next to value text. Only returns non-NULL + bitmap if one was set with SetValueImage(). + */ + wxBitmap* GetValueImage() const; + /** + To acquire property's value as string, you should use this + function (instead of GetValueAsString()), as it may produce + more accurate value in future versions. + + @see GetValueAsString() + */ + wxString GetValueString( int argFlags = 0 ) const; + + /** + Returns value type used by this property. + */ wxString GetValueType() const { return m_value.GetType(); } - /** Returns editor used for given column. NULL for no editor. + /** + Returns coordinate to the top y of the property. Note that the + position of scrollbars is not taken into account. */ - const wxPGEditor* GetColumnEditor( int column ) const - { - if ( column == 1 ) - return GetEditorClass(); - - return NULL; - } + int GetY() const; - /** Returns true if property has even one visible child. + /** + Returns true if property has even one visible child. */ bool HasVisibleChildren() const; - /** Inserts a new choice to property's list of choices. + /** + Hides or reveals the property. + + @param hide + @true for hide, @false for reveal. + + @param flags + By default changes are applied recursively. Set this parameter wxPG_DONT_RECURSE to prevent this. + */ + bool Hide( bool hide, int flags = wxPG_RECURSE ); + + /** + Returns index of given child property. wxNOT_FOUND if + given property is not child of this. + */ + int Index( const wxPGProperty* p ) const; + + /** + Inserts a new choice to property's list of choices. @param label Text for new choice @@ -934,369 +1063,234 @@ public: */ int InsertChoice( const wxString& label, int index, int value = wxPG_INVALID_VALUE ); - /** Returns true if this property is actually a wxPropertyCategory. + /** + Returns @true if this property is actually a wxPropertyCategory. */ - bool IsCategory() const { return HasFlag(wxPG_PROP_CATEGORY)?true:false; } + bool IsCategory() const; - /** Returns true if this property is actually a wxRootProperty. + /** + Returns @true if property is enabled. */ - bool IsRoot() const { return (m_parent == NULL); } - - /** Returns true if this is a sub-property. */ - bool IsSubProperty() const - { - wxPGProperty* parent = (wxPGProperty*)m_parent; - if ( parent && !parent->IsCategory() ) - return true; - return false; - } - - /** Returns last visible sub-property, recursively. - */ - const wxPGProperty* GetLastVisibleSubItem() const; - - wxVariant GetDefaultValue() const; - - int GetMaxLength() const - { - return (int) m_maxLen; - } + bool IsEnabled() const; - /** Determines, recursively, if all children are not unspecified. Takes values in given list into account. + /** + Returns @true if property has visible children. */ - bool AreAllChildrenSpecified( wxVariant* pendingList = NULL ) const; - - /** Updates composed values of parent non-category properties, recursively. - Returns topmost property updated. + bool IsExpanded() const; - @remarks - - Must not call SetValue() (as can be called in it). + /** + Returns @true if this property is actually a wxRootProperty. */ - wxPGProperty* UpdateParentValues(); + bool IsRoot() const { return (m_parent == NULL); } - /** Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES. + /** + Returns @true if candidateParent is some parent of this property. */ - FlagType UsesAutoUnspecified() const - { - return HasFlag(wxPG_PROP_AUTO_UNSPECIFIED); - } + bool IsSomeParent( wxPGProperty* candidateParent ) const; - wxBitmap* GetValueImage() const - { - return m_valueBitmap; - } + /** + Returns true if property has editable wxTextCtrl when selected. - wxVariant GetAttribute( const wxString& name ) const; - - /** Returns named attribute, as string, if found. Otherwise defVal is returned. + @remarks Altough disabled properties do not displayed editor, they still + return @true here as being disabled is considered a temporary + condition (unlike being read-only or having limited editing enabled). */ - wxString GetAttribute( const wxString& name, const wxString& defVal ) const; + bool IsTextEditable() const; - /** Returns named attribute, as long, if found. Otherwise defVal is returned. + /** + Returns @true if property's value is considered unspecified. This + usually means that value is Null variant. */ - long GetAttributeAsLong( const wxString& name, long defVal ) const; + bool IsValueUnspecified() const; - /** Returns named attribute, as double, if found. Otherwise defVal is returned. + /** + Returns true if all parents expanded. */ - double GetAttributeAsDouble( const wxString& name, double defVal ) const; - - inline unsigned int GetArrIndex() const { return m_arrIndex; } - - inline unsigned int GetDepth() const { return (unsigned int)m_depth; } + bool IsVisible() const; - /** Gets flags as a'|' delimited string. Note that flag names are not - prepended with 'wxPG_PROP_'. - @param flagsMask - String will only be made to include flags combined by this parameter. + /** + Returns child property at index i. */ - wxString GetFlagsAsString( FlagType flagsMask ) const; + wxPGProperty* Item( size_t i ) const; - /** Returns position in parent's array. */ - unsigned int GetIndexInParent() const - { - return (unsigned int)m_arrIndex; - } - - /** Hides or reveals the property. - @param hide - true for hide, false for reveal. - @param flags - By default changes are applied recursively. Set this paramter wxPG_DONT_RECURSE to prevent this. - */ - inline bool Hide( bool hide, int flags = wxPG_RECURSE ); - - bool IsExpanded() const { return (!(m_flags & wxPG_PROP_COLLAPSED) && GetChildCount()); } - - /** Returns true if all parents expanded. - */ - bool IsVisible() const; + /** + Updates property value in case there were last minute + changes. If value was unspecified, it will be set to default. + Use only for properties that have TextCtrl-based editor. - bool IsEnabled() const - { - return ( m_flags & wxPG_PROP_DISABLED ) ? false : true; - } + @remarks If you have code similar to + @code + // Update the value in case of last minute changes + if ( primary && propgrid->IsEditorsValueModified() ) + GetEditorClass()->CopyValueFromControl( this, primary ); + @endcode + in wxPGProperty::OnEvent wxEVT_COMMAND_BUTTON_CLICKED handler, + then replace it with call to this method. - /** If property's editor is created this forces its recreation. Useful - in SetAttribute etc. Returns true if actually did anything. + @return Returns @true if value changed. */ - bool RecreateEditor(); + bool PrepareValueForDialogEditing( wxPropertyGrid* propgrid ); - /** If property's editor is active, then update it's value. + /** + If property's editor is active, then update it's value. */ void RefreshEditor(); - /** Sets an attribute for this property. + /** + Sets an attribute for this property. + @param name - Text identifier of attribute. See @ref propgrid_property_attributes. + Text identifier of attribute. See @ref propgrid_property_attributes. + @param value - Value of attribute. + Value of attribute. */ void SetAttribute( const wxString& name, wxVariant value ); - void SetAttributes( const wxPGAttributeStorage& attributes ); - - /** Sets editor for a property. + /** + Sets editor for a property. @param editor - For builtin editors, use wxPGEditor_X, where X is builtin editor's - name (TextCtrl, Choice, etc. see wxPGEditor documentation for full list). + For builtin editors, use wxPGEditor_X, where X is builtin editor's + name (TextCtrl, Choice, etc. see wxPGEditor documentation for full list). For custom editors, use pointer you received from wxPropertyGrid::RegisterEditorClass(). */ - void SetEditor( const wxPGEditor* editor ) - { - m_customEditor = editor; - } + void SetEditor( const wxPGEditor* editor ); - /** Sets editor for a property. + /** + Sets editor for a property, by editor name. */ - inline void SetEditor( const wxString& editorName ); + void SetEditor( const wxString& editorName ); - /** Sets cell information for given column. + /** + Sets cell information for given column. Note that the property takes ownership of given wxPGCell instance. */ void SetCell( int column, wxPGCell* cellObj ); - /** If property has choices and they are not yet exclusive, new such copy - of them will be created. - */ - void SetChoicesExclusive(); - - /** Sets selected choice and changes property value. - - Tries to retain value type, although currently if it is not string, - then it is forced to integer. - */ - void SetChoiceSelection( int newValue ); + /** + Sets new set of choices for property. - /** Sets flags from a '|' delimited string. Note that flag names are not - prepended with 'wxPG_PROP_'. + @remarks This operation clears the property value. */ - void SetFlagsFromString( const wxString& str ); + bool SetChoices( wxPGChoices& choices ); - /** Sets property's "is it modified?" flag. Affects children recursively. + /** + If property has choices and they are not yet exclusive, new such copy + of them will be created. */ - void SetModifiedStatus( bool modified ) - { - SetFlagRecursively(wxPG_PROP_MODIFIED, modified); - } + void SetChoicesExclusive(); - /** Call in OnEvent(), OnButtonClick() etc. to change the property value - based on user input. + /** + Sets client data (void*) of a property. - @remarks - This method is const since it doesn't actually modify value, but posts - given variant as pending value, stored in wxPropertyGrid. + @remarks This untyped client data has to be deleted manually. */ - void SetValueInEvent( wxVariant value ) const; - - /** Call this to set value of the property. Unlike methods in wxPropertyGrid, - this does not automatically update the display. + void SetClientData( void* clientData ); - @remarks - Use wxPropertyGrid::ChangePropertyValue() instead if you need to run through - validation process and send property change event. + /** Returns client object of a property. + */ + void SetClientObject(wxClientData* clientObject); - If you need to change property value in event, based on user input, use - SetValueInEvent() instead. + /** + Sets selected choice and changes property value. - @param pList - Pointer to list variant that contains child values. Used to indicate - which children should be marked as modified. - @param flags - Various flags (for instance, wxPG_SETVAL_REFRESH_EDITOR). + Tries to retain value type, although currently if it is not string, + then it is forced to integer. */ - void SetValue( wxVariant value, wxVariant* pList = NULL, int flags = 0 ); + void SetChoiceSelection( int newValue ); - /** Set wxBitmap in front of the value. This bitmap may be ignored - by custom cell renderers. + /** + Sets property's help string, which is shown, for example, in + wxPropertyGridManager's description text box. */ - void SetValueImage( wxBitmap& bmp ); + void SetHelpString( const wxString& helpString ); - void SetExpanded( bool expanded ) - { - if ( !expanded ) m_flags |= wxPG_PROP_COLLAPSED; - else m_flags &= ~wxPG_PROP_COLLAPSED; - } - - void SetFlag( FlagType flag ) { m_flags |= flag; } + /** + Sets property's label. - void SetFlagRecursively( FlagType flag, bool set ); - - void SetHelpString( const wxString& helpString ) - { - m_helpString = helpString; - } - - /** Sets property's label. - - @remarks - - Properties under same parent may have same labels. However, - property names must still remain unique. + @remarks Properties under same parent may have same labels. However, + property names must still remain unique. */ void SetLabel( const wxString& label ) { m_label = label; } - inline void SetName( const wxString& newName ); - - void SetValueToUnspecified() - { - wxVariant val; // Create NULL variant - SetValue(val); - } - - /** Sets wxValidator for a property*/ - void SetValidator( const wxValidator& validator ) - { - m_validator = wxDynamicCast(validator.Clone(),wxValidator); - } - - /** Gets assignable version of property's validator. */ - wxValidator* GetValidator() const - { - if ( m_validator ) - return m_validator; - return DoGetValidator(); - } - - /** Updates property value in case there were last minute - changes. If value was unspecified, it will be set to default. - Use only for properties that have TextCtrl-based editor. - @remarks - If you have code similar to - @code - // Update the value in case of last minute changes - if ( primary && propgrid->IsEditorsValueModified() ) - GetEditorClass()->CopyValueFromControl( this, primary ); - @endcode - in wxPGProperty::OnEvent wxEVT_COMMAND_BUTTON_CLICKED handler, - then replace it with call to this method. - @retval - True if value changed. - */ - bool PrepareValueForDialogEditing( wxPropertyGrid* propgrid ); - - /** Returns client data (void*) of a property. + /** + Set max length of text in text editor. */ - void* GetClientData() const - { - return m_clientData; - } + bool SetMaxLength( int maxLen ); - /** Sets client data (void*) of a property. - @remarks - This untyped client data has to be deleted manually. + /** + Sets property's "is it modified?" flag. Affects children recursively. */ - void SetClientData( void* clientData ) - { - m_clientData = clientData; - } + void SetModifiedStatus( bool modified ); - /** Returns client object of a property. + /** + Sets new (base) name for property. */ - void SetClientObject(wxClientData* clientObject) - { - delete m_clientObject; - m_clientObject = clientObject; - } + void SetName( const wxString& newName ); - /** Sets managed client object of a property. - */ - wxClientData *GetClientObject() const { return m_clientObject; } + /** Sets wxValidator for a property */ + void SetValidator( const wxValidator& validator ); - /** Sets new set of choices for property. + /** + Call this to set value of the property. Unlike methods in wxPropertyGrid, + this does not automatically update the display. @remarks - This operation clears the property value. - */ - bool SetChoices( wxPGChoices& choices ); + Use wxPropertyGrid::ChangePropertyValue() instead if you need to run through + validation process and send property change event. - /** Sets new set of choices for property. - */ - inline bool SetChoices( const wxArrayString& labels, - const wxArrayInt& values = wxArrayInt() ); + If you need to change property value in event, based on user input, use + SetValueInEvent() instead. - /** Set max length of text in text editor. - */ - inline bool SetMaxLength( int maxLen ); + @param pList + Pointer to list variant that contains child values. Used to indicate + which children should be marked as modified. Usually you just use NULL. - /** Call with 'false' in OnSetValue to cancel value changes after all - (ie. cancel 'true' returned by StringToValue() or IntToValue()). + @param flags + Use wxPG_SETVAL_REFRESH_EDITOR to update editor control, if it + was selected. */ - void SetWasModified( bool set = true ) - { - if ( set ) m_flags |= wxPG_PROP_WAS_MODIFIED; - else m_flags &= ~wxPG_PROP_WAS_MODIFIED; - } - - const wxString& GetHelpString() const - { - return m_helpString; - } - - void ClearFlag( FlagType flag ) { m_flags &= ~(flag); } - - // Use, for example, to detect if item is inside collapsed section. - bool IsSomeParent( wxPGProperty* candidate_parent ) const; + void SetValue( wxVariant value, wxVariant* pList = NULL, int flags = 0 ); - /** Adapts list variant into proper value using consequtive ChildChanged-calls. + /** + Set wxBitmap in front of the value. This bitmap may be ignored + by custom cell renderers. */ - void AdaptListToValue( wxVariant& list, wxVariant* value ) const; - - /** This is used by properties that have fixed sub-properties. */ - void AddChild( wxPGProperty* prop ); + void SetValueImage( wxBitmap& bmp ); - /** Returns height of children, recursively, and - by taking expanded/collapsed status into account. + /** + Call this function in OnEvent(), OnButtonClick() etc. to change the + property value based on user input. - iMax is used when finding property y-positions. + @remarks This method is const since it doesn't actually modify value, but posts + given variant as pending value, stored in wxPropertyGrid. */ - int GetChildrenHeight( int lh, int iMax = -1 ) const; - - /** Returns number of child properties */ - unsigned int GetChildCount() const { return m_children.GetCount(); } - - /** Returns sub-property at index i. */ - wxPGProperty* Item( size_t i ) const { return (wxPGProperty*)m_children.Item(i); } + void SetValueInEvent( wxVariant value ) const; - /** Returns last sub-property. + /** + Sets property's value to unspecified (ie. Null variant). */ - wxPGProperty* Last() const { return (wxPGProperty*)m_children.Last(); } - - /** Returns index of given sub-property. */ - int Index( const wxPGProperty* p ) const { return m_children.Index((wxPGProperty*)p); } - - /** Deletes all sub-properties. */ - void Empty(); + void SetValueToUnspecified(); - // Puts correct indexes to children - void FixIndexesOfChildren( size_t starthere = 0 ); + /** + Call with @false in OnSetValue() to cancel value changes after all + (ie. cancel @true returned by StringToValue() or IntToValue()). + */ + void SetWasModified( bool set = true ); - wxPGProperty* GetItemAtY( unsigned int y, unsigned int lh, unsigned int* nextItemY ) const; + /** + Updates composed values of parent non-category properties, recursively. + Returns topmost property updated. + */ + wxPGProperty* UpdateParentValues(); - /** Returns (direct) child property with given name (or NULL if not found). + /** + Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES. */ - wxPGProperty* GetPropertyByName( const wxString& name ) const; + bool UsesAutoUnspecified() const; }; @@ -1313,51 +1307,28 @@ class WXDLLIMPEXP_PROPGRID wxPGChoices public: typedef long ValArrItem; - /** Default constructor. */ - wxPGChoices() - { - Init(); - } + /** + Default constructor. + */ + wxPGChoices(); /** Copy constructor. */ - wxPGChoices( const wxPGChoices& a ) - { - if ( a.m_data != wxPGChoicesEmptyData ) - { - m_data = a.m_data; - m_data->m_refCount++; - } - } + wxPGChoices( const wxPGChoices& a ); /** Constructor. */ - wxPGChoices( const wxChar** labels, const long* values = NULL ) - { - Init(); - Set(labels,values); - } + wxPGChoices( const wxChar** labels, const long* values = NULL ); /** Constructor. */ - wxPGChoices( const wxArrayString& labels, const wxArrayInt& values = wxArrayInt() ) - { - Init(); - Set(labels,values); - } + wxPGChoices( const wxArrayString& labels, const wxArrayInt& values = wxArrayInt() ); - /** Simple interface constructor. */ - wxPGChoices( wxPGChoicesData* data ) - { - wxASSERT(data); - m_data = data; - data->m_refCount++; - } + /** Constructor. */ + wxPGChoices( wxPGChoicesData* data ); /** Destructor. */ - ~wxPGChoices() - { - Free(); - } + ~wxPGChoices(); - /** Adds to current. If did not have own copies, creates them now. If was empty, + /** + Adds to current. If did not have own copies, creates them now. If was empty, identical to set except that creates copies. */ void Add( const wxChar** labels, const ValArrItem* values = NULL ); @@ -1372,7 +1343,8 @@ public: wxPGChoiceEntry& Add( const wxString& label, int value = wxPG_INVALID_VALUE ); /** Adds a single item, with bitmap. */ - wxPGChoiceEntry& Add( const wxString& label, const wxBitmap& bitmap, int value = wxPG_INVALID_VALUE ); + wxPGChoiceEntry& Add( const wxString& label, const wxBitmap& bitmap, + int value = wxPG_INVALID_VALUE ); /** Adds a single item with full entry information. */ wxPGChoiceEntry& Add( const wxPGChoiceEntry& entry ) @@ -1380,74 +1352,86 @@ public: return Insert(entry, -1); } - /** Adds single item. */ + /** Adds single item, sorted. */ wxPGChoiceEntry& AddAsSorted( const wxString& label, int value = wxPG_INVALID_VALUE ); + /** + Assigns data from another set of choices. + */ void Assign( const wxPGChoices& a ) { AssignData(a.m_data); } + /** + Assigns data from another set of choices. + */ void AssignData( wxPGChoicesData* data ); - /** Delete all choices. */ + /** + Deletes all items. + */ void Clear() { if ( m_data != wxPGChoicesEmptyData ) m_data->Clear(); } - void EnsureData() - { - if ( m_data == wxPGChoicesEmptyData ) - m_data = new wxPGChoicesData(); - } - - /** Gets a unsigned number identifying this list. */ - wxPGChoicesId GetId() const { return (wxPGChoicesId) m_data; }; - - const wxString& GetLabel( size_t ind ) const - { - wxASSERT( ind >= 0 && ind < GetCount() ); - return Item(ind).GetText(); - } + /** + Returns labe of item. + */ + const wxString& GetLabel( size_t ind ) const; - size_t GetCount () const - { - wxASSERT_MSG( m_data, - wxT("When checking if wxPGChoices is valid, use IsOk() instead of GetCount()") ); - return m_data->GetCount(); - } + /** + Returns number of items. + */ + size_t GetCount () const; - int GetValue( size_t ind ) const { return Item(ind).GetValue(); } + /** + Returns value of item; + */ + int GetValue( size_t ind ) const; - /** Returns array of values matching the given strings. Unmatching strings + /** + Returns array of values matching the given strings. Unmatching strings result in wxPG_INVALID_VALUE entry in array. */ wxArrayInt GetValuesForStrings( const wxArrayString& strings ) const; - /** Returns array of indices matching given strings. Unmatching strings + /** + Returns array of indices matching given strings. Unmatching strings are added to 'unmatched', if not NULL. */ - wxArrayInt GetIndicesForStrings( const wxArrayString& strings, wxArrayString* unmatched = NULL ) const; + wxArrayInt GetIndicesForStrings( const wxArrayString& strings, + wxArrayString* unmatched = NULL ) const; - /** Returns true if choices in general are likely to have values - (depens on that all entries have values or none has) + /** + Returns @true if item at given index has a valid value; */ - bool HasValues() const; + bool HasValue( unsigned int i ) const; - bool HasValue( unsigned int i ) const { return (m_data->GetCount() > i && m_data->Item(i)->HasValue()); } + /** + Returns index of item with given label. + */ + int Index( const wxString& label ) const; - int Index( const wxString& str ) const; + /** + Returns index of item with given value. + */ int Index( int val ) const; - /** Inserts single item. */ + /** + Inserts single item. + */ wxPGChoiceEntry& Insert( const wxString& label, int index, int value = wxPG_INVALID_VALUE ); - /** Inserts a single item with full entry information. */ + /** + Inserts a single item with full entry information. + */ wxPGChoiceEntry& Insert( const wxPGChoiceEntry& entry, int index ); - /** Returns false if this is a constant empty set of choices, + /** + Returns false if this is a constant empty set of choices, which should not be modified. */ bool IsOk() const @@ -1455,78 +1439,47 @@ public: return ( m_data != wxPGChoicesEmptyData ); } + /** + Returns item at given index. + */ const wxPGChoiceEntry& Item( unsigned int i ) const { wxASSERT( IsOk() ); return *m_data->Item(i); } + /** + Returns item at given index. + */ wxPGChoiceEntry& Item( unsigned int i ) { wxASSERT( IsOk() ); return *m_data->Item(i); } - /** Removes count items starting at position nIndex. */ + /** + Removes count items starting at position nIndex. + */ void RemoveAt(size_t nIndex, size_t count = 1); - /** Does not create copies for itself. */ - void Set( const wxChar** labels, const long* values = NULL ) - { - Free(); - Add(labels,values); - } - - /** Version that works with wxArrayString. - TODO: Deprecate this. + /** + Sets contents from lists of strings and values. */ - void Set( wxArrayString& arr, const long* values = (const long*) NULL ) - { - Free(); - Add(arr,values); - } + void Set( const wxChar** labels, const long* values = NULL ); - /** Version that works with wxArrayString and wxArrayInt. */ - void Set( const wxArrayString& labels, const wxArrayInt& values = wxArrayInt() ) - { - Free(); - if ( &values ) - Add(labels,values); - else - Add(labels); - } - - // Creates exclusive copy of current choices - void SetExclusive() - { - if ( m_data->m_refCount != 1 ) - { - wxPGChoicesData* data = new wxPGChoicesData(); - data->CopyDataFrom(m_data); - Free(); - m_data = data; - } - } - - // Returns data, increases refcount. - wxPGChoicesData* GetData() - { - wxASSERT( m_data->m_refCount != 0xFFFFFFF ); - m_data->m_refCount++; - return m_data; - } - - // Returns plain data ptr - no refcounting stuff is done. - wxPGChoicesData* GetDataPtr() const { return m_data; } + /** + Sets contents from lists of strings and values. + */ + void Set( const wxArrayString& labels, const wxArrayInt& values = wxArrayInt() ); - // Changes ownership of data to you. - wxPGChoicesData* ExtractData() - { - wxPGChoicesData* data = m_data; - m_data = wxPGChoicesEmptyData; - return data; - } + /** + Creates exclusive copy of current choices. + */ + void SetExclusive(); + /** + Returns array of choice labels. + */ wxArrayString GetLabels() const; void operator= (const wxPGChoices& a) -- 2.45.2