Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixed doxygen warnings; also restyled (partially) the interface headers to conform to wx doc style

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56491 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-22 20:48:31 +00:00
parent c4e5720224
commit 0ad10f3055
6 changed files with 275 additions and 345 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
interface/wx/propgrid/editors.h
View File

@@ -6,7 +6,6 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------
/**
@class wxPGEditor
@@ -40,11 +39,7 @@ class wxPGEditor : public wxObject
public:
/** Constructor. */
wxPGEditor()
: wxObject()
{
m_clientData = NULL;
}
wxPGEditor();
/** Destructor. */
virtual ~wxPGEditor();
@@ -106,10 +101,10 @@ public:
(see wxPGProperty::OnEvent() for more information).
@remarks wxPropertyGrid will automatically unfocus the editor when
wxEVT_COMMAND_TEXT_ENTER is received and when it results in
property value being modified. This happens regardless of
editor type (ie. behavior is same for any wxTextCtrl and
wxComboBox based editor).
wxEVT_COMMAND_TEXT_ENTER is received and when it results in
property value being modified. This happens regardless of
editor type (ie. behavior is same for any wxTextCtrl and
wxComboBox based editor).
*/
virtual bool OnEvent( wxPropertyGrid* propgrid, wxPGProperty* property,
wxWindow* wnd_primary, wxEvent& event ) const = 0;
@@ -120,26 +115,25 @@ public:
Returns @true if value was different.
*/
virtual bool GetValueFromControl( wxVariant& variant, wxPGProperty* property,
wxWindow* ctrl ) const;
wxWindow* ctrl ) const;
/** Sets value in control to unspecified. */
virtual void SetValueToUnspecified( wxPGProperty* property,
wxWindow* ctrl ) const = 0;
wxWindow* ctrl ) const = 0;
/** Sets control's value specifically from string. */
virtual void SetControlStringValue( wxPGProperty* property,
wxWindow* ctrl, const wxString& txt ) const;
wxWindow* ctrl, const wxString& txt ) const;
/** Sets control's value specifically from int (applies to choice etc.). */
virtual void SetControlIntValue( wxPGProperty* property,
wxWindow* ctrl, int value ) const;
wxWindow* ctrl, int value ) const;
/**
Inserts item to existing control. Index -1 means end of list.
Default implementation does nothing. Returns index of item added.
*/
virtual int InsertItem( wxWindow* ctrl, const wxString& label,
int index ) const;
virtual int InsertItem( wxWindow* ctrl, const wxString& label, int index ) const;
/**
Deletes item from existing control.
@@ -148,19 +142,19 @@ public:
virtual void DeleteItem( wxWindow* ctrl, int index ) const;
/**
Extra processing when control gains focus. For example, wxTextCtrl
based controls should select all text.
Extra processing when control gains focus.
For example, wxTextCtrl based controls should select all text.
*/
virtual void OnFocus( wxPGProperty* property, wxWindow* wnd ) const;
/**
Returns @true if control itself can contain the custom image. Default
implementation returns @false.
Returns @true if control itself can contain the custom image.
Default implementation returns @false.
*/
virtual bool CanContainCustomImage() const;
};
// -----------------------------------------------------------------------
/**
@class wxPGMultiButton
@@ -172,7 +166,6 @@ public:
For instance, here we add three buttons to a TextCtrl editor:
@code
#include <wx/propgrid/editors.h>
class wxSampleMultiButtonEditor : public wxPGTextCtrlEditor
@@ -250,13 +243,11 @@ public:
}
return wxPGTextCtrlEditor::OnEvent(propGrid, property, ctrl, event);
}
@endcode
Further to use this editor, code like this can be used:
@code
// Register editor class - needs only to be called once
wxPGEditor* multiButtonEditor = new wxSampleMultiButtonEditor();
wxPropertyGrid::RegisterEditorClass( multiButtonEditor );
@@ -266,7 +257,6 @@ public:
// Change property to use editor created in the previous code segment
propGrid->SetPropertyEditor( "MultipleButtons", multiButtonEditor );
@endcode
@library{wxpropgrid}
@@ -275,7 +265,6 @@ public:
class WXDLLIMPEXP_PROPGRID wxPGMultiButton : public wxWindow
{
public:
/**
Constructor.
*/
@@ -314,8 +303,8 @@ public:
wxWindow* GetButton( unsigned int i );
/**
Returns Id of one of the buttons. This is utility function to be
used in event handlers.
Returns Id of one of the buttons.
This is utility function to be used in event handlers.
*/
int GetButtonId( unsigned int i ) const;
@@ -331,4 +320,3 @@ public:
wxSize GetPrimarySize() const;
};
// -----------------------------------------------------------------------

103
interface/wx/propgrid/manager.h
View File

@@ -6,18 +6,19 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/** @class wxPropertyGridPage
/**
@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.
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.
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
@@ -40,8 +41,8 @@ class WXDLLIMPEXP_PROPGRID wxPropertyGridPage : public wxEvtHandler,
public wxPropertyGridInterface
{
friend class wxPropertyGridManager;
public:
public:
wxPropertyGridPage();
virtual ~wxPropertyGridPage();
@@ -84,10 +85,7 @@ public:
Returns id of the tool bar item that represents this page on
wxPropertyGridManager's wxToolBar.
*/
int GetToolId() const
{
return m_id;
}
int GetToolId() const;
/**
Do any member initialization in this method.
@@ -95,13 +93,13 @@ public:
@remarks - Called every time the page is added into a manager.
- You can add properties to the page here.
*/
virtual void Init() {}
virtual void Init();
/**
Return false here to indicate unhandled events should be
propagated to manager's parent, as normal.
*/
virtual bool IsHandlingAllEvents() const { return true; }
virtual bool IsHandlingAllEvents() const;
/**
Called every time page is about to be shown.
@@ -114,7 +112,9 @@ public:
*/
virtual void RefreshProperty( wxPGProperty* p );
/** Sets splitter position on page.
/**
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
@@ -123,9 +123,9 @@ public:
void SetSplitterPosition( int splitterPos, int col = 0 );
};
// -----------------------------------------------------------------------
/** @class wxPropertyGridManager
/**
@class wxPropertyGridManager
wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid,
which can optionally have toolbar for mode and page selection, and a help text
@@ -153,7 +153,6 @@ public:
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
@@ -184,10 +183,8 @@ public:
page->Append( wxT("Text"),wxPG_LABEL,wxT("(no text)") );
page->Append( new wxFontProperty(wxT("Font"),wxPG_LABEL) );
@endcode
@section propgridmanager_window_styles_ Window Styles
See @ref propgrid_window_styles.
@@ -243,10 +240,7 @@ public:
@return Returns @true if value was actually updated.
*/
bool CommitChangesFromEditor( wxUint32 flags = 0 )
{
return m_pPropGrid->CommitChangesFromEditor(flags);
}
bool CommitChangesFromEditor( wxUint32 flags = 0 );
/**
Two step creation. Whenever the control is created without any parameters,
@@ -267,13 +261,7 @@ public:
@remarks
Calling his may not properly update toolbar buttons.
*/
bool EnableCategories( bool enable )
{
long fl = m_windowStyle | wxPG_HIDE_CATEGORIES;
if ( enable ) fl = m_windowStyle & ~(wxPG_HIDE_CATEGORIES);
SetWindowStyleFlag(fl);
return true;
}
bool EnableCategories( bool enable );
/**
Selects page, scrolls and/or expands items to ensure that the
@@ -317,18 +305,12 @@ public:
/**
Returns page object for given page index.
*/
wxPropertyGridPage* GetPage( unsigned int ind ) const
{
return (wxPropertyGridPage*)m_arrPages.Item(ind);
}
wxPropertyGridPage* GetPage( unsigned int ind ) const;
/**
Returns page object for given page name.
*/
wxPropertyGridPage* GetPage( const wxString& name ) const
{
return GetPage(GetPageByName(name));
}
wxPropertyGridPage* GetPage( const wxString& name ) const;
/**
Returns index for a page name. If no match is found, wxNOT_FOUND is
@@ -341,7 +323,9 @@ public:
*/
size_t GetPageCount() const;
/** Returns name of given page. */
/**
Returns name of given page.
*/
const wxString& GetPageName( int index ) const;
/**
@@ -351,24 +335,22 @@ public:
wxPGProperty* GetPageRoot( int index ) const;
/** Returns index to currently selected page. */
int GetSelectedPage() const { return m_selPage; }
int GetSelectedPage() const;
/** Shortcut for GetGrid()->GetSelection(). */
wxPGProperty* GetSelectedProperty() const
{
return m_pPropGrid->GetSelection();
}
wxPGProperty* GetSelectedProperty() const;
/** Synonyme for GetSelectedPage. */
int GetSelection() const { return m_selPage; }
int GetSelection() const;
/**
Returns a pointer to the toolbar currently associated with the
wxPropertyGridManager (if any).
*/
wxToolBar* GetToolBar() const { return m_pToolbar; }
wxToolBar* GetToolBar() const;
/** 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 index
@@ -397,8 +379,7 @@ public:
bool IsAnyModified() const;
/**
Returns @true if updating is frozen (ie. Freeze() called but not yet
Thaw() ).
Returns @true if updating is frozen (ie. Freeze() called but not yet Thaw() ).
*/
bool IsFrozen() const;
@@ -407,13 +388,15 @@ public:
*/
bool IsPageModified( size_t index ) const;
/** Removes a page.
/**
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.
/**
Select and displays a given page.
@param index
Index of page being seleced. Can be -1 to select nothing.
@@ -436,14 +419,16 @@ public:
*/
void SetColumnCount( int colCount, int page = -1 );
/** Sets label and text in description box.
/**
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
/**
Moves splitter as left as possible, while still allowing all
labels to be shown in full.
@param subProps
@@ -456,10 +441,7 @@ public:
void SetSplitterLeft( bool subProps = false, bool allPages = true );
/** Sets splitter position on individual page. */
void SetPageSplitterPosition( int page, int pos, int column = 0 )
{
GetPage(page)->DoSetSplitterPosition( pos, column );
}
void SetPageSplitterPosition( int page, int pos, int column = 0 );
/**
Sets splitter position for all pages.
@@ -472,10 +454,7 @@ public:
void SetSplitterPosition( int pos, int column = 0 );
/** Synonyme for SelectPage(name). */
void SetStringSelection( const wxChar* name )
{
SelectPage( GetPageByName(name) );
}
void SetStringSelection( const wxChar* name );
protected:
@@ -484,10 +463,8 @@ protected:
//
/**
Creates property grid for the manager. Override to use subclassed
wxPropertyGrid.
Creates property grid for the manager.
Override to use subclassed wxPropertyGrid.
*/
virtual wxPropertyGrid* CreatePropertyGrid() const;
};
// -----------------------------------------------------------------------

233
interface/wx/propgrid/property.h
View File

@@ -10,15 +10,15 @@
#define wxNullProperty ((wxPGProperty*)NULL)
/** @section propgrid_property_attributes wxPropertyGrid Property Attribute Identifiers
/**
@section propgrid_property_attributes wxPropertyGrid Property Attribute Identifiers
wxPGProperty::SetAttribute() and
wxPropertyGridInterface::SetPropertyAttribute()
accept one of these as attribute name argument .
wxPGProperty::SetAttribute() and wxPropertyGridInterface::SetPropertyAttribute()
accept one of these as attribute name argument.
You can use strings instead of constants. However, some of these
constants are redefined to use cached strings which may reduce
your binary size by some amount.
You can use strings instead of constants.
However, some of these constants are redefined to use cached strings which
may reduce your binary size by some amount.
@{
*/
@@ -124,7 +124,7 @@
*/
#define wxPG_ATTR_SPINCTRL_STEP wxS("Step")
/** SpinCtrl editor, bool. If true, value wraps at Min/Max.
/** SpinCtrl editor, bool. If @true, value wraps at Min/Max.
*/
#define wxPG_ATTR_SPINCTRL_WRAP wxS("Wrap")
@@ -141,9 +141,10 @@
/** @}
*/
// -----------------------------------------------------------------------
/** @class wxPGProperty
/**
@class wxPGProperty
wxPGProperty is base class for all wxPropertyGrid properties. In
sections below we cover few related topics.
@@ -275,7 +276,7 @@
Like wxLongStringProperty, but the button triggers file selector instead.
Default wildcard is "All files..." but this can be changed by setting
wxPG_FILE_WILDCARD attribute (see wxFileDialog for format details).
Attribute wxPG_FILE_SHOW_FULL_PATH can be set to false inorder to show
Attribute wxPG_FILE_SHOW_FULL_PATH can be set to @false inorder to show
only the filename, not the entire path.
@subsection wxEnumProperty
@@ -517,15 +518,15 @@ public:
/**
Override this to return something else than m_value as the value.
*/
virtual wxVariant DoGetValue() const { return m_value; }
virtual wxVariant DoGetValue() const;
/**
Implement this function in derived class to check the value.
Return true if it is ok. Returning false prevents property change events
Return @true if it is ok. Returning @false prevents property change events
from occurring.
@remarks
- Default implementation always returns true.
- Default implementation always returns @true.
*/
virtual bool ValidateValue( wxVariant& value, wxPGValidationInfo& validationInfo ) const;
@@ -564,10 +565,8 @@ public:
@param variant
On function entry this is the old value (should not be wxNullVariant
in normal cases). Translated value must be assigned back to it.
@param number
Integer to be translated into variant.
@param argFlags
If wxPG_FULL_VALUE is set, returns complete, storable value instead
of displayable one.
@@ -581,26 +580,24 @@ public:
- If property uses choice control, and displays a dialog on some choice
items, then it is preferred to display that dialog in IntToValue
instead of OnEvent.
- You might want to take into account that m_value is Null variant if
- You might want to take into account that m_value is Mull variant if
property value is unspecified (which is usually only case if you
explicitly enabled that sort behavior).
*/
virtual bool IntToValue( wxVariant& value, int number, int argFlags = 0 ) const;
virtual bool IntToValue( wxVariant& variant, int number, int argFlags = 0 ) const;
/**
Converts property value into a text representation.
@param value
Value to be converted.
@param argFlags
If 0 (default value), then displayed string is returned.
If wxPG_FULL_VALUE is set, returns complete, storable string value
instead of displayable. If wxPG_EDITABLE_VALUE is set, returns
string value that must be editable in textctrl. If
wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to
display as a part of string property's composite text
representation.
string value that must be editable in textctrl.
If wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to
display as a part of string property's composite text representation.
@remarks Default implementation calls GenerateComposedValue().
*/
@@ -609,22 +606,26 @@ public:
/**
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.
@retval
true if value was changed.
String to get the value from.
@param flags
@todo docme
@return @true if value was changed.
*/
bool SetValueFromString( const wxString& text, int flags = 0 );
/**
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.
Int to get the value from.
@param flags
If has wxPG_FULL_VALUE, then the value given is a actual value and not an index.
@retval
True if value was changed.
If has wxPG_FULL_VALUE, then the value given is a actual value and not an index.
@return @true if value was changed.
*/
bool SetValueFromInt( long value, int flags = 0 );
@@ -632,8 +633,10 @@ public:
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
Normally -1, but can be an index to the property's list of items.
Normally -1, but can be an index to the property's list of items.
@remarks
- Default behavior is to return wxSize(0,0), which means no image.
- Default image width or height is indicated with dimension -1.
@@ -649,13 +652,14 @@ public:
wxSystemColourProperty custom handles wxEVT_COMMAND_CHOICE_SELECTED
to display colour picker dialog when 'custom' selection is made).
If the event causes value to be changed, SetValueInEvent()
should be called to set the new value.
If the event causes value to be changed, SetValueInEvent() should be called
to set the new value.
The parameter @a event is the associated wxEvent.
@param event
Associated wxEvent.
@retval
Should return true if any changes in value should be reported.
Should return @true if any changes in value should be reported.
@remarks
- If property uses choice control, and displays a dialog on some choice items,
then it is preferred to display that dialog in IntToValue instead of OnEvent.
@@ -692,11 +696,11 @@ public:
@endcode
@param thisValue
Value of this property, that should be altered.
Value of this property, that should be altered.
@param childIndex
Index of child changed (you can use Item(childIndex) to get).
Index of child changed (you can use Item(childIndex) to get).
@param childValue
Value of the child property.
Value of the child property.
*/
virtual void ChildChanged( wxVariant& thisValue, int childIndex, wxVariant& childValue ) const;
@@ -707,7 +711,7 @@ public:
/**
Returns pointer to the wxValidator that should be used
with the editor of this property (NULL for no validator).
with the editor of this property (@NULL for no validator).
Setting validator explicitly via SetPropertyValidator
will override this.
@@ -818,10 +822,10 @@ public:
/**
Special handling for attributes of this property.
If returns false, then the attribute will be automatically stored in
If returns @false, then the attribute will be automatically stored in
m_attributes.
Default implementation simply returns false.
Default implementation simply returns @false.
*/
virtual bool DoSetAttribute( const wxString& name, wxVariant& value );
@@ -830,7 +834,7 @@ public:
Override if custom handling of attributes is needed.
Default implementation simply return NULL variant.
Default implementation simply return @NULL variant.
*/
virtual wxVariant DoGetAttribute( const wxString& name ) const;
@@ -838,24 +842,16 @@ public:
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
Default implementation returns @NULL (ie. no action is generated when
button is pressed).
*/
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 )
{
if ( column >= m_cells.size() )
return NULL;
wxPGCell* cell = (wxPGCell*) m_cells[column];
m_cells[column] = NULL;
return cell;
}
wxPGCell* AcquireCell( unsigned int column );
/**
Append a new choice to property's list of choices.
@@ -907,16 +903,10 @@ public:
bool AreAllChildrenSpecified( wxVariant* pendingList = NULL ) const;
/**
Returns true if children of this property are component values (for instance,
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
{
if ( m_flags & (wxPG_PROP_COMPOSED_VALUE|wxPG_PROP_AGGREGATE) )
return true;
return false;
}
bool AreChildrenComponents() const;
/**
Removes entry from property's wxPGChoices and editor control (if it is active).
@@ -956,30 +946,18 @@ public:
wxVariant GetAttributesAsList() const;
/**
Returns editor used for given column. NULL for no editor.
Returns editor used for given column. @NULL for no editor.
*/
const wxPGEditor* GetColumnEditor( int column ) const
{
if ( column == 1 )
return GetEditorClass();
return NULL;
}
const wxPGEditor* GetColumnEditor( int column ) const;
/** Returns property's base name (ie. parent's name is not added in any case) */
const wxString& GetBaseName() const { return m_name; }
const wxString& GetBaseName() const;
/**
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
{
if ( column >= m_cells.size() )
return NULL;
return (wxPGCell*) m_cells[column];
}
wxPGCell* GetCell( unsigned int column ) const;
/**
Returns number of child properties.
@@ -1021,10 +999,7 @@ public:
/** Returns property's displayed text.
*/
wxString GetDisplayedString() const
{
return GetValueString(0);
}
wxString GetDisplayedString() const;
/**
Returns wxPGEditor that will be used and created when
@@ -1055,7 +1030,7 @@ public:
unsigned int GetIndexInParent() const;
/** Returns property's label. */
const wxString& GetLabel() const { return m_label; }
const wxString& GetLabel() const;
/**
Returns last visible child property, recursively.
@@ -1073,19 +1048,16 @@ public:
/** Returns maximum allowed length of property's text value.
*/
int GetMaxLength() const
{
return (int) m_maxLen;
}
int GetMaxLength() const;
/** Returns property's name with all (non-category, non-root) parents. */
wxString GetName() const;
/** Return parent of property */
wxPGProperty* GetParent() const { return m_parent; }
wxPGProperty* GetParent() const;
/**
Returns (direct) child property with given name (or NULL if not found).
Returns (direct) child property with given name (or @NULL if not found).
*/
wxPGProperty* GetPropertyByName( const wxString& name ) const;
@@ -1095,13 +1067,10 @@ public:
/**
Returns property's value.
*/
wxVariant GetValue() const
{
return DoGetValue();
}
wxVariant GetValue() const;
/**
Returns bitmap that appears next to value text. Only returns non-NULL
Returns bitmap that appears next to value text. Only returns non-@NULL
bitmap if one was set with SetValueImage().
*/
wxBitmap* GetValueImage() const;
@@ -1135,10 +1104,7 @@ public:
/**
Returns value type used by this property.
*/
wxString GetValueType() const
{
return m_value.GetType();
}
wxString GetValueType() const;
/**
Returns coordinate to the top y of the property. Note that the
@@ -1147,7 +1113,7 @@ public:
int GetY() const;
/**
Returns true if property has even one visible child.
Returns @true if property has even one visible child.
*/
bool HasVisibleChildren() const;
@@ -1201,7 +1167,7 @@ public:
/**
Returns @true if this property is actually a wxRootProperty.
*/
bool IsRoot() const { return (m_parent == NULL); }
bool IsRoot() const;
/**
Returns @true if candidateParent is some parent of this property.
@@ -1319,7 +1285,7 @@ public:
@remarks Properties under same parent may have same labels. However,
property names must still remain unique.
*/
void SetLabel( const wxString& label ) { m_label = label; }
void SetLabel( const wxString& label );
/**
Set max length of text in text editor.
@@ -1367,10 +1333,11 @@ public:
If you need to change property value in event, based on user input, use
SetValueInEvent() instead.
@param value
The value to set.
@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.
which children should be marked as modified. Usually you just use @NULL.
@param flags
Use wxPG_SETVAL_REFRESH_EDITOR to update editor control, if it
was selected.
@@ -1410,13 +1377,14 @@ public:
wxPGProperty* UpdateParentValues();
/**
Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
Returns @true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
*/
bool UsesAutoUnspecified() const;
};
/** @class wxPGChoices
/**
@class wxPGChoices
Helper class for managing choices of wxPropertyGrid properties.
Each entry can have label, value, bitmap, text colour, and background colour.
@@ -1469,10 +1437,7 @@ public:
int value = wxPG_INVALID_VALUE );
/** Adds a single item with full entry information. */
wxPGChoiceEntry& Add( const wxPGChoiceEntry& entry )
{
return Insert(entry, -1);
}
wxPGChoiceEntry& Add( const wxPGChoiceEntry& entry );
/** Adds single item, sorted. */
wxPGChoiceEntry& AddAsSorted( const wxString& label, int value = wxPG_INVALID_VALUE );
@@ -1480,10 +1445,7 @@ public:
/**
Assigns data from another set of choices.
*/
void Assign( const wxPGChoices& a )
{
AssignData(a.m_data);
}
void Assign( const wxPGChoices& a );
/**
Assigns data from another set of choices.
@@ -1493,11 +1455,7 @@ public:
/**
Deletes all items.
*/
void Clear()
{
if ( m_data != wxPGChoicesEmptyData )
m_data->Clear();
}
void Clear();
/**
Returns labe of item.
@@ -1522,7 +1480,7 @@ public:
/**
Returns array of indices matching given strings. Unmatching strings
are added to 'unmatched', if not NULL.
are added to 'unmatched', if not @NULL.
*/
wxArrayInt GetIndicesForStrings( const wxArrayString& strings,
wxArrayString* unmatched = NULL ) const;
@@ -1553,31 +1511,20 @@ public:
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
{
return ( m_data != wxPGChoicesEmptyData );
}
bool IsOk() const;
/**
Returns item at given index.
*/
const wxPGChoiceEntry& Item( unsigned int i ) const
{
wxASSERT( IsOk() );
return *m_data->Item(i);
}
const wxPGChoiceEntry& Item( unsigned int i ) const;
/**
Returns item at given index.
*/
wxPGChoiceEntry& Item( unsigned int i )
{
wxASSERT( IsOk() );
return *m_data->Item(i);
}
wxPGChoiceEntry& Item( unsigned int i );
/**
Removes count items starting at position nIndex.
@@ -1604,20 +1551,10 @@ public:
*/
wxArrayString GetLabels() const;
void operator= (const wxPGChoices& a)
{
AssignData(a.m_data);
}
void operator= (const wxPGChoices& a);
wxPGChoiceEntry& operator[](unsigned int i)
{
return Item(i);
}
const wxPGChoiceEntry& operator[](unsigned int i) const
{
return Item(i);
}
wxPGChoiceEntry& operator[](unsigned int i);
const wxPGChoiceEntry& operator[](unsigned int i) const;
};
// -----------------------------------------------------------------------

86
interface/wx/propgrid/propgrid.h
View File

@@ -32,7 +32,7 @@ wxPG_AUTO_SORT = 0x00000010,
*/
wxPG_HIDE_CATEGORIES = 0x00000020,
/*
/**
This style combines non-categoric mode and automatic sorting.
*/
wxPG_ALPHABETIC_MODE = (wxPG_HIDE_CATEGORIES|wxPG_AUTO_SORT),
@@ -213,15 +213,14 @@ typedef wxByte wxPGVFBFlags;
wxPGValidationInfo
Used to convey validation information to and from functions that
actually perform validation. Mostly used in custom property
classes.
actually perform validation. Mostly used in custom property classes.
*/
class wxPGValidationInfo
{
public:
/**
@return Returns failure behavior which is a combination of
@ref propgrid_vfbflags.
@ref propgrid_vfbflags.
*/
wxPGVFBFlags GetFailureBehavior();
@@ -252,6 +251,7 @@ public:
/**
@section propgrid_keyboard_actions wxPropertyGrid Action Identifiers
These are used with wxPropertyGrid::AddActionTrigger() and
wxPropertyGrid::ClearActionTriggers().
@{
@@ -273,9 +273,10 @@ enum wxPG_KEYBOARD_ACTIONS
// -----------------------------------------------------------------------
/** @class wxPropertyGrid
/**
@class wxPropertyGrid
wxPropertyGrid is a specialized grid for editing properties - in other
wxPropertyGrid is a specialized grid for editing properties - in other
words name = value pairs. List of ready-to-use property classes include
strings, numbers, flag sets, fonts, colours and many others. It is possible,
for example, to categorize properties, set up a complete tree-hierarchy,
@@ -324,37 +325,34 @@ enum wxPG_KEYBOARD_ACTIONS
@endEventTable
@remarks
- Use Freeze() and Thaw() respectively to disable and enable drawing. This
will also delay sorting etc. miscellaneous calculations to the last
possible moment.
Use Freeze() and Thaw() respectively to disable and enable drawing.
This will also delay sorting etc. miscellaneous calculations to the last
possible moment.
@library{wxpropgrid}
@category{propgrid}
@appearance{propertygrid.png}
*/
class wxPropertyGrid : public wxScrolledWindow, public wxPropertyGridInterface
{
public:
/**
Two step constructor. Call Create when this constructor is called to
build up the wxPropertyGrid
*/
/**
Two step constructor.
Call Create() when this constructor is called to build up the wxPropertyGrid
*/
wxPropertyGrid();
/**
Constructor. The styles to be used are styles valid for
the wxWindow and wxScrolledWindow.
Constructor.
The styles to be used are styles valid for the wxWindow and wxScrolledWindow.
@see @ref propgrid_window_styles.
*/
wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxPG_DEFAULT_STYLE,
const wxChar* name = wxPropertyGridNameStr );
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxPG_DEFAULT_STYLE,
const wxChar* name = wxPropertyGridNameStr );
/** Destructor */
virtual ~wxPropertyGrid();
@@ -364,10 +362,8 @@ public:
@param action
Which action to trigger. See @ref propgrid_keyboard_actions.
@param keycode
Which keycode triggers the action.
@param modifiers
Which key event modifiers, in addition to keycode, are needed to
trigger the action.
@@ -429,10 +425,10 @@ public:
@see @ref propgrid_window_styles.
*/
bool Create( wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxPG_DEFAULT_STYLE,
const wxChar* name = wxPropertyGridNameStr );
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxPG_DEFAULT_STYLE,
const wxChar* name = wxPropertyGridNameStr );
/**
Call when editor widget's contents is modified. For example, this is
@@ -443,17 +439,14 @@ public:
@see wxPGProperty::OnEvent()
*/
void EditorsValueWasModified() { m_iFlags |= wxPG_FL_VALUE_MODIFIED; }
void EditorsValueWasModified();
/**
Reverse of EditorsValueWasModified().
@remarks This function should only be called by custom properties.
*/
void EditorsValueWasNotModified()
{
m_iFlags &= ~(wxPG_FL_VALUE_MODIFIED);
}
void EditorsValueWasNotModified();
/**
Enables or disables (shows/hides) categories according to parameter
@@ -648,7 +641,7 @@ public:
/**
Returns current vertical spacing.
*/
int GetVerticalSpacing() const { return (int)m_vspacing; }
int GetVerticalSpacing() const;
/**
Returns true if editor's value was marked modified.
@@ -677,8 +670,8 @@ public:
@code
control->Connect(control->GetId(), wxEVT_COMMAND_TEXT_UPDATED,
wxEventHandler(wxPropertyGrid::OnCustomEditorEvent),
NULL, propgrid);
wxEventHandler(wxPropertyGrid::OnCustomEditorEvent),
NULL, propgrid);
@endcode
@remarks You should never need to call this function directly!
@@ -803,15 +796,19 @@ public:
void SetPropertyTextColour( wxPGPropArg id, const wxColour& col,
bool recursively = true );
/** Sets selection background colour - applies to selected property name
background. */
/**
Sets selection background colour - applies to selected property name
background.
*/
void SetSelectionBackgroundColour(const wxColour& col);
/** Sets selection foreground colour - applies to selected property name
text. */
/**
Sets selection foreground colour - applies to selected property name text.
*/
void SetSelectionTextColour(const wxColour& col);
/** Sets x coordinate of the splitter.
/**
Sets x coordinate of the splitter.
@remarks Splitter position cannot exceed grid size, and therefore setting
it during form creation may fail as initial grid size is often
@@ -827,10 +824,7 @@ public:
@param privateChildrenToo
If @false, will still allow private children to be cropped.
*/
void SetSplitterLeft( bool privateChildrenToo = false )
{
m_pState->SetSplitterLeft(subProps);
}
void SetSplitterLeft( bool privateChildrenToo = false );
/**
Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font
@@ -880,7 +874,7 @@ public:
/**
Returns true if you can veto the action that the event is signaling.
*/
bool CanVeto() const { return m_canVeto; }
bool CanVeto() const;
/** Copyer. */
virtual wxEvent* Clone() const;

130
interface/wx/propgrid/propgridiface.h
View File

@@ -62,8 +62,8 @@ public:
/**
In order to add new items into a property with private children (for
instance, wxFlagsProperty), you need to call this method. After
populating has been finished, you need to call EndAddChildren().
instance, wxFlagsProperty), you need to call this method.
After populating has been finished, you need to call EndAddChildren().
@see EndAddChildren()
*/
@@ -121,8 +121,8 @@ public:
bool DisableProperty( wxPGPropArg id );
/**
Returns true if all property grid data changes have been committed. Usually
only returns false if value in active editor has been invalidated by a
Returns @true if all property grid data changes have been committed. Usually
only returns @false if value in active editor has been invalidated by a
wxValidator.
*/
bool EditorValidate();
@@ -132,7 +132,6 @@ public:
@param id
Name or pointer to a property.
@param enable
If @false, property is disabled instead.
*/
@@ -165,28 +164,44 @@ public:
wxPGProperty* GetFirstChild( wxPGPropArg id );
//@{
/** Returns iterator class instance.
/**
Returns iterator class instance.
@param flags
See @ref propgrid_iterator_flags. Value wxPG_ITERATE_DEFAULT causes
iteration over everything except private child properties.
@param firstProp
Property to start iteration from. If NULL, then first child of root
Property to start iteration from. If @NULL, then first child of root
is used.
@param startPos
Either wxTOP or wxBOTTOM. wxTOP will indicate that iterations start
from the first property from the top, and wxBOTTOM means that the
iteration will instead begin from bottommost valid item.
@beginWxPythonOnly
<b>wxPython Note:</b> Instead of ++ operator, use Next() method, and
instead of * operator, use GetProperty() method.
@endWxPythonOnly
*/
wxPropertyGridIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT,
wxPGProperty* firstProp = NULL );
wxPropertyGridConstIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT,
wxPGProperty* firstProp = NULL ) const;
//@}
//@{
/**
Returns iterator class instance.
@param flags
See @ref propgrid_iterator_flags. Value wxPG_ITERATE_DEFAULT causes
iteration over everything except private child properties.
@param startPos
Either wxTOP or wxBOTTOM. wxTOP will indicate that iterations start
from the first property from the top, and wxBOTTOM means that the
iteration will instead begin from bottommost valid item.
@beginWxPythonOnly
<b>wxPython Note:</b> Instead of ++ operator, use Next() method, and
instead of * operator, use GetProperty() method.
@endWxPythonOnly
*/
wxPropertyGridIterator GetIterator( int flags, int startPos );
wxPropertyGridConstIterator GetIterator( int flags, int startPos ) const;
//@}
@@ -202,19 +217,19 @@ public:
/**
Returns id of property with given name (case-sensitive).
*/
wxPGProperty* GetProperty( const wxString& name ) const
{
return GetPropertyByName(name);
}
wxPGProperty* GetProperty( const wxString& name ) const;
/**
Adds to 'targetArr' pointers to properties that have given
flags 'flags' set. However, if 'inverse' is set to true, then
only properties without given flags are stored.
Adds to 'targetArr' pointers to properties that have given flags 'flags' set.
However, if @a 'inverse' is set to @true, then only properties without
given flags are stored.
@param targetArr
@todo docme
@param flags
Property flags to use.
@param inverse
@todo docme
@param iterFlags
Iterator flags to use. Default is everything expect private children.
See @ref propgrid_iterator_flags.
@@ -231,7 +246,7 @@ public:
/**
Returns pointer of property's nearest parent category. If no category
found, returns NULL.
found, returns @NULL.
*/
wxPropertyCategory* GetPropertyCategory( wxPGPropArg id ) const;
@@ -239,14 +254,14 @@ public:
void* GetPropertyClientData( wxPGPropArg id ) const;
/**
Returns first property which label matches given string. NULL if none
Returns first property which label matches given string. @NULL if none
found. Note that this operation is very slow when compared to
GetPropertyByName().
*/
wxPGProperty* GetPropertyByLabel( const wxString& label ) const;
/**
Returns property with given name. NULL if none found.
Returns property with given name. @NULL if none found.
*/
wxPGProperty* GetPropertyByName( const wxString& name ) const;
@@ -268,7 +283,7 @@ public:
wxString GetPropertyHelpString( wxPGPropArg id ) const;
/**
Returns property's custom value image (NULL of none).
Returns property's custom value image (@NULL of none).
*/
wxBitmap* GetPropertyImage( wxPGPropArg id ) const;
@@ -332,6 +347,10 @@ public:
Returns a wxVariant list containing wxVariant versions of all
property values. Order is not guaranteed.
@param listname
@todo docme
@param baseparent
@todo docme
@param flags
Use wxPG_KEEP_STRUCTURE to retain category structure; each sub
category will be its own wxVariantList of wxVariant.
@@ -341,7 +360,7 @@ public:
"@@<propname>@@attr."
*/
wxVariant GetPropertyValues( const wxString& listname = wxEmptyString,
wxPGProperty* baseparent = NULL, long flags = 0 ) const;
wxPGProperty* baseparent = NULL, long flags = 0 ) const;
/** Returns currently selected property. */
wxPGProperty* GetSelection() const;
@@ -362,9 +381,10 @@ public:
/**
Hides or reveals a property.
@param id
@todo docme
@param hide
If @true, hides property, otherwise reveals it.
@param flags
By default changes are applied recursively. Set this parameter
wxPG_DONT_RECURSE to prevent this.
@@ -378,29 +398,18 @@ public:
*/
static void InitAllTypeHandlers();
//@{
/** Inserts property to the property container.
/**
Inserts property to the property container.
@param priorThis
New property is inserted just prior to this. Available only
in the first variant. There are two versions of this function
to allow this parameter to be either an id or name to
a property.
@param newProperty
Pointer to the inserted property. wxPropertyGrid will take
ownership of this object.
@param parent
New property is inserted under this category. Available only
in the second variant. There are two versions of this function
to allow this parameter to be either an id or name to
a property.
@param index
Index under category. Available only in the second variant.
If index is < 0, property is appended in category.
@return Returns newProperty.
@remarks
@@ -428,11 +437,28 @@ public:
wxPGProperty* my_item_id_2 = propertygrid->Insert( my_item_id, new wxStringProperty("My String 2") );
@endcode
*/
wxPGProperty* Insert( wxPGPropArg priorThis, wxPGProperty* newProperty );
/**
Inserts property to the property container.
See the other overload for more details.
@param parent
New property is inserted under this category. Available only
in the second variant. There are two versions of this function
to allow this parameter to be either an id or name to
a property.
@param index
Index under category. Available only in the second variant.
If index is < 0, property is appended in category.
@param newProperty
Pointer to the inserted property. wxPropertyGrid will take
ownership of this object.
@return Returns newProperty.
*/
wxPGProperty* Insert( wxPGPropArg parent, int index, wxPGProperty* newProperty );
//@}
/** Returns @true if property is a category. */
bool IsPropertyCategory( wxPGPropArg id ) const;
@@ -441,7 +467,7 @@ public:
bool IsPropertyEnabled( wxPGPropArg id ) const;
/**
Returns true if given property is expanded. Naturally, always returns
Returns @true if given property is expanded. Naturally, always returns
@false for properties that cannot be expanded.
*/
bool IsPropertyExpanded( wxPGPropArg id ) const;
@@ -453,13 +479,13 @@ public:
bool IsPropertyModified( wxPGPropArg id ) const;
/**
Returns true if property is shown (ie. HideProperty() with @true not
Returns @true if property is shown (ie. HideProperty() with @true not
called for it).
*/
bool IsPropertyShown( wxPGPropArg id ) const;
/**
Returns true if property value is set to unspecified.
Returns @true if property value is set to unspecified.
*/
bool IsPropertyValueUnspecified( wxPGPropArg id ) const;
@@ -567,18 +593,18 @@ public:
/**
Sets an attribute for this property.
@param name
@param id
@todo docme
@param attrName
Text identifier of attribute. See @ref propgrid_property_attributes.
@param value
Value of attribute.
@param argFlags
Optional. Use wxPG_RECURSE to set the attribute to child properties
recursively.
Optional.
Use wxPG_RECURSE to set the attribute to child properties recursively.
@remarks Setting attribute's value to Null variant will simply remove it
from property's set of attributes.
from property's set of attributes.
*/
void SetPropertyAttribute( wxPGPropArg id, const wxString& attrName,
wxVariant value, long argFlags = 0 );
@@ -615,6 +641,8 @@ public:
/**
Sets editor for a property.
@param id
@todo docme
@param editor
For builtin editors, use wxPGEditor_X, where X is builtin editor's
name (TextCtrl, Choice, etc. see wxPGEditor documentation for full

18
interface/wx/propgrid/propgridpagestate.h
View File

@@ -7,7 +7,8 @@
/////////////////////////////////////////////////////////////////////////////
/** @section propgrid_hittestresult wxPropertyGridHitTestResult
/**
@section propgrid_hittestresult wxPropertyGridHitTestResult
A return value from wxPropertyGrid::HitTest(),
contains all you need to know about an arbitrary location on the grid.
@@ -99,7 +100,8 @@ wxPG_ITERATE_DEFAULT = wxPG_ITERATE_NORMAL
*/
/** @section propgrid_iterator_class wxPropertyGridIterator
/**
@section propgrid_iterator_class wxPropertyGridIterator
Preferable way to iterate through contents of wxPropertyGrid,
wxPropertyGridManager, and wxPropertyGridPage.
@@ -117,15 +119,18 @@ public:
bool AtEnd() const { return m_property == NULL; }
/** Get current property.
/**
Get current property.
*/
wxPGProperty* GetProperty() const { return m_property; }
/** Iterate to the next property.
/**
Iterate to the next property.
*/
void Next( bool iterateChildren = true );
/** Iterate to the previous property.
/**
Iterate to the previous property.
*/
void Prev();
@@ -134,7 +139,8 @@ protected:
// -----------------------------------------------------------------------
/** @section propgrid_viterator_class wxPGVIterator
/**
@section propgrid_viterator_class wxPGVIterator
Abstract implementation of a simple iterator. Can only be used
to iterate in forward order, and only through the entire container.