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

Add missing code tag before lots of wxEventTypes in the documentation. Although most of the documentation did this quite a few were missing.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66611 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Steve Lamerton
2011-01-06 19:52:14 +00:00
parent 40fc5b2f71
commit 3a194bda7b
32 changed files with 188 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -401,53 +401,53 @@ typedef int (*wxPGSortCallback)(wxPropertyGrid* propGrid,
@beginEventEmissionTable{wxPropertyGridEvent}
@event{EVT_PG_SELECTED (id, func)}
Respond to wxEVT_PG_SELECTED event, generated when a property selection
Respond to @c wxEVT_PG_SELECTED event, generated when a property selection
has been changed, either by user action or by indirect program
function. For instance, collapsing a parent property programmatically
causes any selected child property to become unselected, and may
therefore cause this event to be generated.
@event{EVT_PG_CHANGED(id, func)}
Respond to wxEVT_PG_CHANGED event, generated when property value
Respond to @c wxEVT_PG_CHANGED event, generated when property value
has been changed by the user.
@event{EVT_PG_CHANGING(id, func)}
Respond to wxEVT_PG_CHANGING event, generated when property value
Respond to @c wxEVT_PG_CHANGING event, generated when property value
is about to be changed by user. Use wxPropertyGridEvent::GetValue()
to take a peek at the pending value, and wxPropertyGridEvent::Veto()
to prevent change from taking place, if necessary.
@event{EVT_PG_HIGHLIGHTED(id, func)}
Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
Respond to @c wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
moves over a property. Event's property is NULL if hovered area does
not belong to any property.
@event{EVT_PG_RIGHT_CLICK(id, func)}
Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is
Respond to @c wxEVT_PG_RIGHT_CLICK event, which occurs when property is
clicked on with right mouse button.
@event{EVT_PG_DOUBLE_CLICK(id, func)}
Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
Respond to @c wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
double-clicked on with left mouse button.
@event{EVT_PG_ITEM_COLLAPSED(id, func)}
Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
Respond to @c wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
a property or category.
@event{EVT_PG_ITEM_EXPANDED(id, func)}
Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands
Respond to @c wxEVT_PG_ITEM_EXPANDED event, generated when user expands
a property or category.
@event{EVT_PG_LABEL_EDIT_BEGIN(id, func)}
Respond to wxEVT_PG_LABEL_EDIT_BEGIN event, generated when user is
Respond to @c wxEVT_PG_LABEL_EDIT_BEGIN event, generated when user is
about to begin editing a property label. You can veto this event to
prevent the action.
@event{EVT_PG_LABEL_EDIT_ENDING(id, func)}
Respond to wxEVT_PG_LABEL_EDIT_ENDING event, generated when user is
Respond to @c wxEVT_PG_LABEL_EDIT_ENDING event, generated when user is
about to end editing of a property label. You can veto this event to
prevent the action.
@event{EVT_PG_COL_BEGIN_DRAG(id, func)}
Respond to wxEVT_PG_COL_BEGIN_DRAG event, generated when user
Respond to @c wxEVT_PG_COL_BEGIN_DRAG event, generated when user
starts resizing a column - can be vetoed.
@event{EVT_PG_COL_DRAGGING,(id, func)}
Respond to wxEVT_PG_COL_DRAGGING, event, generated when a
Respond to @c wxEVT_PG_COL_DRAGGING, event, generated when a
column resize by user is in progress. This event is also generated
when user double-clicks the splitter in order to recenter
it.
@event{EVT_PG_COL_END_DRAG(id, func)}
Respond to wxEVT_PG_COL_END_DRAG event, generated after column
Respond to @c wxEVT_PG_COL_END_DRAG event, generated after column
resize by user has finished.
@endEventTable
@@ -579,7 +579,7 @@ public:
/**
Forces updating the value of property from the editor control.
Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using
Note that @c wxEVT_PG_CHANGING and @c wxEVT_PG_CHANGED are dispatched using
ProcessEvent, meaning your event handlers will be called immediately.
@return Returns @true if anything was changed.
@@ -937,7 +937,7 @@ public:
fails if current value in editor is not valid.
@remarks In wxPropertyGrid 1.4, this member function used to generate
wxEVT_PG_SELECTED. In wxWidgets 2.9 and later, it no longer
@c wxEVT_PG_SELECTED. In wxWidgets 2.9 and later, it no longer
does that.
@remarks This clears any previous selection.
@@ -1236,7 +1236,7 @@ public:
Returns property associated with this event.
@remarks You should assume that this property can always be NULL.
For instance, wxEVT_PG_SELECTED is emitted not only when
For instance, @c wxEVT_PG_SELECTED is emitted not only when
a new property is selected, but also when selection is
cleared by user activity.
*/
@@ -1258,7 +1258,7 @@ public:
/**
Returns value of the associated property. Works for all event
types, but for wxEVT_PG_CHANGING this member function returns
types, but for @c wxEVT_PG_CHANGING this member function returns
the value that is pending, so you can call Veto() if the
value is not satisfactory.
@@ -1283,7 +1283,7 @@ public:
/**
Set override validation failure behavior. Only effective if Veto() was
also called, and only allowed if event type is wxEVT_PG_CHANGING.
also called, and only allowed if event type is @c wxEVT_PG_CHANGING.
*/
void SetValidationFailureBehavior( wxPGVFBFlags flags );
@@ -1298,7 +1298,7 @@ public:
signaling. You can only veto a shutdown if wxPropertyGridEvent::CanVeto()
returns true.
@remarks Currently only wxEVT_PG_CHANGING supports vetoing.
@remarks Currently only @c wxEVT_PG_CHANGING supports vetoing.
*/
void Veto( bool veto = true );