add IsOk() to all classes having Ok() method (patch 1570985)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41751 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2006-10-08 21:56:55 +00:00
parent dd61e8ed01
commit b7cacb43db
161 changed files with 316 additions and 203 deletions

View File

@@ -151,9 +151,9 @@ and cmd values like you would construct wxAcceleratorEntry objects with.}
Destroys the wxAcceleratorTable object.
\membersection{wxAcceleratorTable::Ok}\label{wxacceleratortableok}
\membersection{wxAcceleratorTable::IsOk}\label{wxacceleratortableisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the accelerator table is valid.

View File

@@ -449,9 +449,9 @@ if one has been created by using the \helpref{GetPalette}{wxbitmapgetpalette} me
\helpref{wxBitmap::SaveFile}{wxbitmapsavefile}
\membersection{wxBitmap::Ok}\label{wxbitmapok}
\membersection{wxBitmap::IsOk}\label{wxbitmapisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if bitmap data is present.

View File

@@ -78,7 +78,7 @@ data using the reference counting, are not affected.
\func{}{wxBrush}{\void}
Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will
Default constructor. The brush will be uninitialised, and \helpref{wxBrush:IsOk}{wxbrushisok} will
return false.
\func{}{wxBrush}{\param{const wxColour\&}{ colour}, \param{int}{ style = {\tt wxSOLID}}}
@@ -163,7 +163,7 @@ Returns a reference to the brush colour.
\constfunc{wxBitmap *}{GetStipple}{\void}
Gets a pointer to the stipple bitmap. If the brush does not have a wxSTIPPLE style,
this bitmap may be non-NULL but uninitialised (\helpref{wxBitmap::Ok}{wxbitmapok} returns false).
this bitmap may be non-NULL but uninitialised (\helpref{wxBitmap:IsOk}{wxbitmapisok} returns false).
\wxheading{See also}
@@ -206,9 +206,9 @@ Returns true if the style of the brush is any of hatched fills.
\helpref{wxBrush::GetStyle}{wxbrushgetstyle}
\membersection{wxBrush::Ok}\label{wxbrushok}
\membersection{wxBrush::IsOk}\label{wxbrushisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the brush is initialised. It will return false if the default
constructor has been used (for example, the brush is a member of a class, or

View File

@@ -146,9 +146,9 @@ On X, an allocated pixel value is returned.
Returns the green intensity.
\membersection{wxColour::Ok}\label{wxcolourok}
\membersection{wxColour::IsOk}\label{wxcolourisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns \true if the colour object is valid (the colour has been initialised with RGB values).
@@ -378,7 +378,7 @@ removed in the next wxWidgets version, please don't use it.
\func{wxColour}{Find}{\param{const wxString\& }{colourName}}
Finds a colour given the name. Returns an invalid colour object (that is, such
that its \helpref{Ok()}{wxcolourok} method returns \false) if the colour wasn't
that its \helpref{Ok()}{wxcolourisok} method returns \false) if the colour wasn't
found in the database.

View File

@@ -234,9 +234,9 @@ than one window, and does not get destroyed when the window is
destroyed. wxWidgets destroys all cursors on application exit, although
it is best to clean them up explicitly.
\membersection{wxCursor::Ok}\label{wxcursorok}
\membersection{wxCursor::IsOk}\label{wxcursorisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if cursor data is present.

View File

@@ -883,7 +883,7 @@ Gets the minimum horizontal extent used in drawing commands so far.
Gets the minimum vertical extent used in drawing commands so far.
\membersection{wxDC::Ok}\label{wxdcok}
\membersection{wxDC::IsOk}\label{wxdcisok}
\func{bool}{Ok}{\void}

View File

@@ -49,9 +49,9 @@ Initializes a file stream in read-only mode using the specified file pointer {\i
Destructor.
\membersection{wxFFileInputStream::Ok}\label{wxffileinputstreamok}
\membersection{wxFFileInputStream::IsOk}\label{wxffileinputstreamisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the stream is initialized and ready.
@@ -106,9 +106,9 @@ Initializes a file stream in write-only mode using the file descriptor {\it fp}.
Destructor.
\membersection{wxFFileOutputStream::Ok}\label{wxffileoutputstreamok}
\membersection{wxFFileOutputStream::IsOk}\label{wxffileoutputstreamisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the stream is initialized and ready.

View File

@@ -46,9 +46,9 @@ Initializes a file stream in read-only mode using the specified file descriptor.
Destructor.
\membersection{wxFileInputStream::Ok}\label{wxfileinputstreamok}
\membersection{wxFileInputStream::IsOk}\label{wxfileinputstreamisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the stream is initialized and ready.

View File

@@ -50,9 +50,9 @@ Initializes a file stream in write-only mode using the file descriptor {\it fd}.
Destructor.
\membersection{wxFileOutputStream::Ok}\label{wxfileoutputstreamok}
\membersection{wxFileOutputStream::IsOk}\label{wxfileoutputstreamisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the stream is initialized and ready.

View File

@@ -397,9 +397,9 @@ Using \texttt{New()} is currently the only way to directly create a font with
the given size in pixels on platforms other than wxMSW.
\membersection{wxFont::Ok}\label{wxfontok}
\membersection{wxFont::IsOk}\label{wxfontisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns {\tt true} if this object is a valid font, {\tt false} otherwise.

View File

@@ -2004,7 +2004,7 @@ customization.
\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}}
Shows the colour selection dialog and returns the colour selected by user or
invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
invalid colour (use \helpref{wxColour:IsOk}{wxcolourisok} to test whether a colour
is valid) if the dialog was cancelled.
\wxheading{Parameters}
@@ -2025,7 +2025,7 @@ is valid) if the dialog was cancelled.
\func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}, \param{const wxString\& }{caption = wxEmptyString}}
Shows the font selection dialog and returns the font selected by user or
invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font
invalid font (use \helpref{wxFont:IsOk}{wxfontisok} to test whether a font
is valid) if the dialog was cancelled.
\wxheading{Parameters}

View File

@@ -277,9 +277,9 @@ true if the operation succeeded, false otherwise.
\helpref{wxIcon::wxIcon}{wxiconctor}
\membersection{wxIcon::Ok}\label{wxiconok}
\membersection{wxIcon::IsOk}\label{wxiconisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if icon data is present.

View File

@@ -884,9 +884,9 @@ mimetype from a file}
\membersection{wxImage::Ok}\label{wximageok}
\membersection{wxImage::IsOk}\label{wximageisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if image data is present.

View File

@@ -26,7 +26,7 @@ is to use a wxMetafileDC.
Constructor. If a filename is given, the Windows disk metafile is
read in. Check whether this was performed successfully by
using the \helpref{wxMetafile::Ok}{wxmetafileok} member.
using the \helpref{wxMetafile:IsOk}{wxmetafileisok} member.
\membersection{wxMetafile::\destruct{wxMetafile}}\label{wxmetafiledtor}
@@ -34,7 +34,7 @@ using the \helpref{wxMetafile::Ok}{wxmetafileok} member.
Destructor.
\membersection{wxMetafile::Ok}\label{wxmetafileok}
\membersection{wxMetafile::IsOk}\label{wxmetafileisok}
\func{bool}{Ok}{\void}

View File

@@ -50,9 +50,9 @@ Destructor.
Returns the \helpref{page setup data}{wxpagesetupdialogdata} associated with the dialog.
%\membersection{wxPageSetupDialog::Ok}\label{wxpagesetupdialogok}
%\membersection{wxPageSetupDialog::IsOk}\label{wxpagesetupdialogisok}
%
%\constfunc{bool}{Ok}{\void}
%\constfunc{bool}{IsOk}{\void}
%
%Returns true if the print data associated with the dialog data is valid.
%This can return false on Windows if the current printer is not set, for example.
@@ -226,9 +226,9 @@ Returns the paper size in millimetres.
Returns a reference to the \helpref{print data}{wxprintdata} associated with this object.
\membersection{wxPageSetupDialogData::Ok}\label{wxpagesetupdialogdataok}
\membersection{wxPageSetupDialogData::IsOk}\label{wxpagesetupdialogdataisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the print data associated with the dialog data is valid.
This can return false on Windows if the current printer is not set, for example.

View File

@@ -170,9 +170,9 @@ true if the operation was successful.
\perlnote{In wxPerl this method takes only the {\tt pixel} parameter and
returns a 3-element list ( or the empty list upon failure ).}
\membersection{wxPalette::Ok}\label{wxpaletteok}
\membersection{wxPalette::IsOk}\label{wxpaletteisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if palette data is present.

View File

@@ -76,7 +76,7 @@ data using the reference counting, are not affected.
\func{}{wxPen}{\void}
Default constructor. The pen will be uninitialised, and \helpref{wxPen::Ok}{wxpenok} will
Default constructor. The pen will be uninitialised, and \helpref{wxPen:IsOk}{wxpenisok} will
return false.
\func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{int}{ width = $1$}, \param{int}{ style = {\tt wxSOLID}}}
@@ -239,9 +239,9 @@ Returns the pen width.
\helpref{wxPen::SetWidth}{wxpensetwidth}
\membersection{wxPen::Ok}\label{wxpenok}
\membersection{wxPen::IsOk}\label{wxpenisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the pen is initialised.

View File

@@ -155,9 +155,9 @@ On input you should pass one of these identifiers, but on return you may get bac
indicating the current resolution setting.
\membersection{wxPrintData::Ok}\label{wxprintdataok}
\membersection{wxPrintData::IsOk}\label{wxprintdataisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the print data is valid for using in print dialogs.
This can return false on Windows if the current printer is not set, for example.
@@ -562,9 +562,9 @@ a concept specific to the application).
Returns the {\it to} page number, as entered by the user.
\membersection{wxPrintDialogData::Ok}\label{wxprintdialogdataok}
\membersection{wxPrintDialogData::IsOk}\label{wxprintdialogdataisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the print data is valid for using in print dialogs.
This can return false on Windows if the current printer is not set, for example.
@@ -1135,7 +1135,7 @@ Gets the printout object to be used for printing from within the preview interfa
or NULL if none exists.
\membersection{wxPrintPreview::Ok}\label{wxprintpreviewok}
\membersection{wxPrintPreview::IsOk}\label{wxprintpreviewisok}
\func{bool}{Ok}{\void}

View File

@@ -127,7 +127,7 @@ Functions to retrieve current state and miscellaneous info.
\helpref{IsDisconnected}{wxsocketbaseisdisconnected}\\
\helpref{LastCount}{wxsocketbaselastcount}\\
\helpref{LastError}{wxsocketbaselasterror}\\
\helpref{Ok}{wxsocketbaseok}\\
\helpref{IsOk}{wxsocketbaseisok}\\
\helpref{SaveState}{wxsocketbasesavestate}\\
\helpref{RestoreState}{wxsocketbaserestorestate}
@@ -414,11 +414,11 @@ be sent to the application. If {\it notify} is false; no events
will be sent.
%
% Ok
% IsOk
%
\membersection{wxSocketBase::Ok}\label{wxsocketbaseok}
\membersection{wxSocketBase::IsOk}\label{wxsocketbaseisok}
\constfunc{bool}{Ok}{\void}
\constfunc{bool}{IsOk}{\void}
Returns true if the socket is initialized and ready and false in other
cases.

View File

@@ -36,7 +36,7 @@
Constructs a new server and tries to bind to the specified {\it address}.
Before trying to accept new connections, test whether it succeeded with
\helpref{wxSocketBase::Ok}{wxsocketbaseok}.
\helpref{wxSocketBase:IsOk}{wxsocketbaseisok}.
\wxheading{Parameters}