From 0599486175c95fd5576c2c60687c5b58db2f4619 Mon Sep 17 00:00:00 2001
From: Kevin Hock <hockkn@yahoo.com>
Date: Tue, 18 Jan 2005 15:13:34 +0000
Subject: [PATCH] Removed m_ variables from the documentation, since they are
 now protected and should not be used directly

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31456 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/activevt.tex |  6 ------
 docs/latex/wx/eraseevt.tex | 12 +++--------
 docs/latex/wx/event.tex    | 37 ++------------------------------
 docs/latex/wx/menuevt.tex  |  7 -------
 docs/latex/wx/tchanges.tex |  7 +++++++
 docs/latex/wx/upduievt.tex | 43 +++-----------------------------------
 6 files changed, 15 insertions(+), 97 deletions(-)

diff --git a/docs/latex/wx/activevt.tex b/docs/latex/wx/activevt.tex
index 3b877c7da8..285ac8fbb0 100644
--- a/docs/latex/wx/activevt.tex
+++ b/docs/latex/wx/activevt.tex
@@ -49,12 +49,6 @@ especially on Mac platform.
 
 Constructor.
 
-\membersection{wxActivateEvent::m\_active}\label{wxactivateeventmactive}
-
-\member{bool}{m\_active}
-
-true if the window or application was activated.
-
 \membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive}
 
 \constfunc{bool}{GetActive}{\void}
diff --git a/docs/latex/wx/eraseevt.tex b/docs/latex/wx/eraseevt.tex
index 46fa06ebca..18dfe5c574 100644
--- a/docs/latex/wx/eraseevt.tex
+++ b/docs/latex/wx/eraseevt.tex
@@ -33,8 +33,8 @@ function that takes a wxEraseEvent argument.
 
 \wxheading{Remarks}
 
-Use the {\bf m\_DC} device context to draw into, don't create wxPaintDC in 
-the event handler.
+Use the device context returned by \helpref{GetDC}{wxeraseeventgetdc} to draw on,
+don't create a wxPaintDC in the event handler.
 
 \wxheading{See also}
 
@@ -49,15 +49,9 @@ the event handler.
 
 Constructor.
 
-\membersection{wxEraseEvent::m\_dc}\label{wxeraseeventmdc}
-
-\member{wxDC*}{m\_dc}
-
-The device context associated with the erase event.
-
 \membersection{wxEraseEvent::GetDC}\label{wxeraseeventgetdc}
 
 \constfunc{wxDC*}{GetDC}{\void}
 
-Returns the device context to draw into.
+Returns the device context associated with the erase event to draw on.
 
diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index f75d0de957..b5e7be46d0 100644
--- a/docs/latex/wx/event.tex
+++ b/docs/latex/wx/event.tex
@@ -6,7 +6,7 @@ event object, and is an abstract base class for other event classes (see below).
 
 For more information about events, see the \helpref{Event handling overview}{eventhandlingoverview}.
 
-\perlnote{In wxPerl custome event classes should be derived from
+\perlnote{In wxPerl custom event classes should be derived from
 \texttt{Wx::PlEvent} and \texttt{Wx::PlCommandEvent}.}
 
 \wxheading{Derived from}
@@ -30,25 +30,6 @@ For more information about events, see the \helpref{Event handling overview}{eve
 
 Constructor. Should not need to be used directly by an application.
 
-\membersection{wxEvent::m\_eventObject}\label{wxeventmeventobject}
-
-\member{wxObject*}{m\_eventObject}
-
-The object (usually a window) that the event was generated from,
-or should be sent to.
-
-\membersection{wxEvent::m\_eventType}\label{wxeventmeventtype}
-
-\member{WXTYPE}{m\_eventType}
-
-The type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
-
-\membersection{wxEvent::m\_id}\label{wxeventmid}
-
-\member{int}{m\_id}
-
-Identifier for the window.
-
 \membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel}
 
 \member{int}{m\_propagationLevel}
@@ -68,18 +49,6 @@ Any positive number means that the event should be propagated but no more than
 the given number of times. E.g. the propagation level may be set to $1$ to
 propagate the event to its parent only, but not to its grandparent.
 
-\membersection{wxEvent::m\_skipped}\label{wxeventmskipped}
-
-\member{bool}{m\_skipped}
-
-Set to true by {\bf Skip} if this event should be skipped.
-
-\membersection{wxEvent::m\_timeStamp}\label{wxeventmtimestamp}
-
-\member{long}{m\_timeStamp}
-
-Timestamp for this event.
-
 \membersection{wxEvent::Clone}\label{wxeventclone}
 
 \constfunc{virtual wxEvent*}{Clone}{\void}
@@ -105,7 +74,7 @@ a new event (call it MyEvent) and then define the Clone function like this:
 
 \func{wxObject*}{GetEventObject}{\void}
 
-Returns the object associated with the
+Returns the object (usually a window) associated with the
 event, if any.
 
 \membersection{wxEvent::GetEventType}\label{wxeventgeteventtype}
@@ -174,8 +143,6 @@ Sets the identifier associated with this event, such as a button command id.
 
 Sets the timestamp for the event.
 
-Sets the originating object.
-
 \membersection{wxEvent::ShouldPropagate}\label{wxeventshouldpropagate}
 
 \constfunc{bool}{ShouldPropagate}{\void}
diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex
index d2c262e3bf..0f9a238647 100644
--- a/docs/latex/wx/menuevt.tex
+++ b/docs/latex/wx/menuevt.tex
@@ -48,13 +48,6 @@ highlighted, i.e. the currently selected menu item has changed.}
 Constructor.
 
 
-\membersection{wxMenuEvent::m\_menuId}\label{wxmenueventmmenuid}
-
-\member{int}{m\_menuId}
-
-The relevant menu identifier.
-
-
 \membersection{wxMenuEvent::GetMenu}\label{wxmenueventgetmenu}
 
 \constfunc{wxMenu *}{GetMenu}{\void}
diff --git a/docs/latex/wx/tchanges.tex b/docs/latex/wx/tchanges.tex
index 31b5acb073..3d47cc2ea5 100644
--- a/docs/latex/wx/tchanges.tex
+++ b/docs/latex/wx/tchanges.tex
@@ -8,6 +8,13 @@ For other changes (such as additional features, bug fixes, etc.) see the changes
 
 \subsection{Incompatible changes since 2.4.x}\label{incompatiblesince24}
 
+\subsubsection{wxEvent and its derivatives loosing public variable members}\label{wxeventpublictoprotected}
+
+\helpref{wxEvent}{wxevent} and its \helpref{derivatives}{eventhandlingoverview} do not have their public variable members public anymore.
+Use the Get/Set accessors as you always should have.
+
+
+
 \subsubsection{New window repainting behaviour}\label{newwindowrepainting}
 
 Windows are no longer fully repainted when resized, use new style \windowstyle{wxFULL\_REPAINT\_ON\_RESIZE} to force this (\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE} still exists but doesn't do anything any more, this behaviour is default now).
diff --git a/docs/latex/wx/upduievt.tex b/docs/latex/wx/upduievt.tex
index d6aabd751a..1032665247 100644
--- a/docs/latex/wx/upduievt.tex
+++ b/docs/latex/wx/upduievt.tex
@@ -81,43 +81,6 @@ to be shown, and not in idle time.
 
 Constructor.
 
-\membersection{wxUpdateUIEvent::m\_checked}\label{wxupdateuieventmchecked}
-
-\member{bool}{m\_checked}
-
-true if the element should be checked, false otherwise.
-
-\membersection{wxUpdateUIEvent::m\_enabled}\label{wxupdateuieventmenabled}
-
-\member{bool}{m\_checked}
-
-true if the element should be enabled, false otherwise.
-
-\membersection{wxUpdateUIEvent::m\_setChecked}\label{wxupdateuieventmsetchecked}
-
-\member{bool}{m\_setChecked}
-
-true if the application has set the {\bf m\_checked} member.
-
-\membersection{wxUpdateUIEvent::m\_setEnabled}\label{wxupdateuieventmsetenabled}
-
-\member{bool}{m\_setEnabled}
-
-true if the application has set the {\bf m\_enabled} member.
-
-\membersection{wxUpdateUIEvent::m\_setText}\label{wxupdateuieventmsettext}
-
-\member{bool}{m\_setText}
-
-true if the application has set the {\bf m\_text} member.
-
-\membersection{wxUpdateUIEvent::m\_text}\label{wxupdateuieventmtext}
-
-\member{wxString}{m\_text}
-
-Holds the text with which the the application wishes to
-update the UI element.
-
 \membersection{wxUpdateUIEvent::CanUpdate}\label{wxupdateuieventcanupdate}
 
 \func{static bool}{CanUpdate}{\param{wxWindow*}{ window}}
@@ -169,19 +132,19 @@ Returns true if the UI element should be enabled.
 
 \constfunc{bool}{GetSetChecked}{\void}
 
-Returns true if the application has called {\bf SetChecked}. For wxWidgets internal use only.
+Returns true if the application has called \helpref{wxUpdateUIEvent::Check}{wxupdateuieventcheck}. For wxWidgets internal use only.
 
 \membersection{wxUpdateUIEvent::GetSetEnabled}\label{wxupdateuieventgetsetenabled}
 
 \constfunc{bool}{GetSetEnabled}{\void}
 
-Returns true if the application has called {\bf SetEnabled}. For wxWidgets internal use only.
+Returns true if the application has called \helpref{wxUpdateUIEvent::Enable}{wxupdateuieventenable}. For wxWidgets internal use only.
 
 \membersection{wxUpdateUIEvent::GetSetText}\label{wxupdateuieventgetsettext}
 
 \constfunc{bool}{GetSetText}{\void}
 
-Returns true if the application has called {\bf SetText}. For wxWidgets internal use only.
+Returns true if the application has called \helpref{wxUpdateUIEvent::SetText}{wxupdateuieventsettext}. For wxWidgets internal use only.
 
 \membersection{wxUpdateUIEvent::GetText}\label{wxupdateuieventgettext}
 
-- 
2.50.0

