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

Update wxPG documentation to get rid of doxygen warnings

Browse Source
This commit is contained in:
Artur Wieczorek
2019-05-26 17:21:51 +02:00
parent 58fdf77c9b
commit 1943a9f38d
5 changed files with 175 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -923,9 +923,9 @@ public:
Text to be translated into variant.
@param argFlags
If wxPG_FULL_VALUE is set, returns complete, storable value instead
If ::wxPG_FULL_VALUE is set, returns complete, storable value instead
of displayable one (they may be different).
If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of
If ::wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of
composite property string value (as generated by ValueToString()
called with this same flag).
@@ -950,7 +950,7 @@ public:
@param number
Integer to be translated into variant.
@param argFlags
If wxPG_FULL_VALUE is set, returns complete, storable value instead
If ::wxPG_FULL_VALUE is set, returns complete, storable value instead
of displayable one.
@return Returns @true if resulting wxVariant value was different.
@@ -975,10 +975,10 @@ public:
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
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
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().
@@ -992,12 +992,12 @@ public:
@param text
String to get the value from.
@param flags
If @c wxPG_FULL_VALUE is set, the function sets complete, storable
If ::wxPG_FULL_VALUE is set, the function sets complete, storable
value instead of displayable one (they may be different).
@c wxPG_PROGRAMMATIC_VALUE flag is used to indicate that value is
::wxPG_PROGRAMMATIC_VALUE flag is used to indicate that value is
being set programmatically (i.e. operation is not caused by user
input).
If @c wxPG_REPORT_ERROR is set, a special action should be
If ::wxPG_REPORT_ERROR is set, a special action should be
performed if string couldn't have been successfully converted
to the valid value (e.g. a special value can be set in this case).
@@ -1012,7 +1012,7 @@ public:
@param value
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.
If has ::wxPG_FULL_VALUE, then the value given is a actual value and not an index.
@return @true if value was changed.
*/
@@ -1029,7 +1029,7 @@ public:
@remarks
- Default behaviour is to return wxSize(0,0), which means no image.
- Default image width or height is indicated with dimension -1.
- You can also return wxPG_DEFAULT_IMAGE_SIZE which equals wxDefaultSize.
- You can also return ::wxPG_DEFAULT_IMAGE_SIZE which equals wxDefaultSize.
*/
virtual wxSize OnMeasureImage( int item = -1 ) const;
@@ -1161,7 +1161,7 @@ public:
than row height).
NOTE: Following applies when OnMeasureImage() returns a "flexible" height (
using wxPG_FLEXIBLE_SIZE(W,H) macro), which implies variable height items:
using @c wxPG_FLEXIBLE_SIZE(W,H) macro), which implies variable height items:
If (rect.x+rect.width) is < 0, then this is a measure item call, which
means that dc is invalid and only thing that should be done is to set
paintdata.m_drawnHeight to the height of the image of item at index
@@ -1295,7 +1295,7 @@ public:
Adds a private child property. If you use this instead of
wxPropertyGridInterface::Insert() or
wxPropertyGridInterface::AppendIn(), then property's parental
type will automatically be set up to wxPG_PROP_AGGREGATE. In other
type will automatically be set up to ::wxPG_PROP_AGGREGATE. In other
words, all properties of this property will become private.
*/
void AddPrivateChild( wxPGProperty* prop );
@@ -1340,7 +1340,8 @@ public:
@remarks Setting a property flag never has any side-effect, and is
intended almost exclusively for internal use. So, for
example, if you want to disable a property, call
Enable(false) instead of setting wxPG_PROP_DISABLED flag.
@code Enable(false) @endcode instead of setting
::wxPG_PROP_DISABLED flag.
@see HasFlag(), GetFlags()
*/
@@ -1596,6 +1597,9 @@ public:
/**
Returns (direct) child property with given name (or @NULL if not found).
@param name
Name of the child property to look for.
*/
wxPGProperty* GetPropertyByName( const wxString& name ) const;
@@ -1617,10 +1621,10 @@ public:
@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
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
::wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to
display as a part of string property's composite text
representation.
@@ -1688,7 +1692,8 @@ public:
@true for hide, @false for reveal.
@param flags
By default changes are applied recursively. Set this parameter wxPG_DONT_RECURSE to prevent this.
By default changes are applied recursively. Set this parameter to
::wxPG_DONT_RECURSE to prevent this.
*/
bool Hide( bool hide, int flags = wxPG_RECURSE );
@@ -1759,7 +1764,7 @@ public:
bool IsSomeParent( wxPGProperty* candidateParent ) const;
/**
Returns true if property has editable wxTextCtrl when selected.
Returns @true if property has editable wxTextCtrl when selected.
@remarks Although disabled properties do not displayed editor, they still
return @true here as being disabled is considered a temporary
@@ -1774,12 +1779,12 @@ public:
bool IsValueUnspecified() const;
/**
Returns true if all parents expanded.
Returns @true if all parents expanded.
*/
bool IsVisible() const;
/**
Returns child property at index i.
Returns child property at index @a i.
*/
wxPGProperty* Item( unsigned int i ) const;
@@ -1790,7 +1795,7 @@ public:
/**
If property's editor is created this forces its recreation.
Useful in SetAttribute etc. Returns true if actually did anything.
Useful in SetAttribute etc. Returns @true if actually did anything.
*/
bool RecreateEditor();
@@ -1834,7 +1839,7 @@ public:
Background colour to use.
@param flags
Default is wxPG_RECURSE which causes colour to be set recursively.
Default is ::wxPG_RECURSE which causes colour to be set recursively.
Omit this flag to only set colour for the property in question
and not any of its children.
@@ -1962,9 +1967,9 @@ public:
Changes what sort of parent this property is for its children.
@param flag
Use one of the following values: wxPG_PROP_MISC_PARENT (for generic
parents), wxPG_PROP_CATEGORY (for categories), or
wxPG_PROP_AGGREGATE (for derived property classes with private
Use one of the following values: ::wxPG_PROP_MISC_PARENT (for generic
parents), ::wxPG_PROP_CATEGORY (for categories), or
::wxPG_PROP_AGGREGATE (for derived property classes with private
children).
@remarks You generally do not need to call this function.
@@ -1978,7 +1983,7 @@ public:
Text colour to use.
@param flags
Default is wxPG_RECURSE which causes colour to be set recursively.
Default is ::wxPG_RECURSE which causes colour to be set recursively.
Omit this flag to only set colour for the property in question
and not any of its children.
@@ -1993,7 +1998,7 @@ public:
Sets property's default text and background colours.
@param flags
Default is wxPG_RECURSE which causes colours to be set recursively.
Default is ::wxPG_RECURSE which causes colours to be set recursively.
Omit this flag to only set colours for the property in question
and not any of its children.
@@ -2023,7 +2028,7 @@ public:
Pointer to list variant that contains child values. Used to indicate
which children should be marked as modified. Usually you just use @NULL.
@param flags
wxPG_SETVAL_REFRESH_EDITOR is set by default, to refresh editor
::wxPG_SETVAL_REFRESH_EDITOR is set by default, to refresh editor
and redraw properties.
*/
void SetValue( wxVariant value, wxVariant* pList = NULL,
@@ -2065,7 +2070,7 @@ 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;
@@ -2116,6 +2121,9 @@ protected:
/**
Clear cells associated with property.
@param ignoreWithFlags
Cells will not be cleared for properties having these flags set.
@param recursively
If @true, apply this operation recursively in child properties.
*/
@@ -2129,11 +2137,14 @@ protected:
/** Returns (direct) child property with given name (or @NULL if not found),
with hint index.
@param name
Name of the child property to look for.
@param hintIndex
Start looking for the child at this index.
Start looking for the child at this index.
@remarks
Does not support scope (i.e. Parent.Child notation).
Does not support scope (i.e. Parent.Child notation).
*/
wxPGProperty* GetPropertyByNameWH( const wxString& name,
unsigned int hintIndex ) const;
@@ -2147,7 +2158,7 @@ protected:
void Empty();
/**
Returns true if child property is selected.
Returns @true if child property is selected.
*/
bool IsChildSelected( bool recursive = false ) const;
};
@@ -2219,6 +2230,24 @@ public:
Returns @true if rendered something in the foreground (text or
bitmap).
@param dc
wxDC to paint on.
@param rect
Box reserved for drawing.
@param propertyGrid
Property grid in which property is displayed.
@param property
Property to be rendered.
@param column
Property cell column.
@param item
Index of chosen item if combo popup is drawn, -1 otherwise.
@param flags
See @ref pgcellrenderer_render_flags "list of render flags".
*/
@@ -2261,14 +2290,25 @@ public:
wxPGProperty* property,
const wxPGEditor* editor ) const;
/** Utility to render cell bitmap and set text colour plus bg brush
/**
Utility to render cell bitmap and set text colour plus bg brush
colour.
@param dc
wxDC to paint on.
@param rect
Box reserved for drawing.
@param cell
Cell information.
@param flags
See @ref pgcellrenderer_render_flags "list of render flags".
@return Returns image width, which, for instance, can be passed to
DrawText.
@return
Returns image width, which, for instance, can be passed to
DrawText().
*/
int PreDrawCell( wxDC& dc,
const wxRect& rect,
@@ -2279,6 +2319,15 @@ public:
Utility to be called after drawing is done, to revert whatever
changes PreDrawCell() did.
@param dc
wxDC which was used to paint on.
@param propGrid
Property grid to which the cell belongs.
@param cell
Cell information.
@param flags
Same as those passed to PreDrawCell().
See @ref pgcellrenderer_render_flags "list of render flags".
@@ -2307,6 +2356,24 @@ public:
Returns @true if rendered something in the foreground (text or
bitmap.
@param dc
wxDC to paint on.
@param rect
Box reserved for drawing.
@param propertyGrid
Property grid in which property is displayed.
@param property
Property to be rendered.
@param column
Property cell column.
@param item
Index of chosen item if combo popup is drawn, -1 otherwise.
@param flags
See @ref pgcellrenderer_render_flags "list of render flags".
*/
@@ -2352,7 +2419,7 @@ protected:
wxColour m_bgCol;
wxFont m_font;
/** True if m_text is valid and specified.
/** @true if m_text is valid and specified.
*/
bool m_hasValidText;
};
@@ -2696,7 +2763,7 @@ public:
/**
Returns array of values matching the given strings. Unmatching strings
result in wxPG_INVALID_VALUE entry in array.
result in ::wxPG_INVALID_VALUE entry in array.
*/
wxArrayInt GetValuesForStrings( const wxArrayString& strings ) const;