spelling fixes and other minor corrections to the docs (patch 1273930 by Andreas Mohr)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@35352 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -24,17 +24,17 @@ function that takes a wxActivateEvent argument.
|
|||||||
\twocolitem{{\bf EVT\_HIBERNATE(func)}}{Process a hibernate event, supplying the member function.
|
\twocolitem{{\bf EVT\_HIBERNATE(func)}}{Process a hibernate event, supplying the member function.
|
||||||
This event applies to wxApp only, and only on Windows SmartPhone and PocketPC. It is generated when the
|
This event applies to wxApp only, and only on Windows SmartPhone and PocketPC. It is generated when the
|
||||||
system is low on memory; the application should free up as much memory as possible, and restore
|
system is low on memory; the application should free up as much memory as possible, and restore
|
||||||
full working when it receives a wxEVT\_ACTIVATE or wxEVT\_ACTIVATE\_APP event.}
|
full working state when it receives a wxEVT\_ACTIVATE or wxEVT\_ACTIVATE\_APP event.}
|
||||||
\end{twocollist}%
|
\end{twocollist}%
|
||||||
|
|
||||||
\wxheading{Remarks}
|
\wxheading{Remarks}
|
||||||
|
|
||||||
A top-level window (a dialog or frame) receives an activate event when is
|
A top-level window (a dialog or frame) receives an activate event when it is
|
||||||
being activated or deactivated. This is indicated visually by the title
|
being activated or deactivated. This is indicated visually by the title
|
||||||
bar changing colour, and a subwindow gaining the keyboard focus.
|
bar changing colour, and a subwindow gaining the keyboard focus.
|
||||||
|
|
||||||
An application is activated or deactivated when one of its frames becomes activated,
|
An application is activated or deactivated when one of its frames becomes activated,
|
||||||
or a frame becomes inactivate resulting in all application frames being inactive. (Windows only)
|
or a frame becomes inactivated resulting in all application frames being inactive. (Windows only)
|
||||||
|
|
||||||
Please note that usually you should call \helpref{event.Skip()}{wxeventskip} in
|
Please note that usually you should call \helpref{event.Skip()}{wxeventskip} in
|
||||||
your handlers for these events as not doing so can result in strange effects.
|
your handlers for these events as not doing so can result in strange effects.
|
||||||
|
@@ -45,7 +45,7 @@ Constructor. Second form calls \helpref{Load}{wxdynamiclibraryload}.
|
|||||||
|
|
||||||
\membersection{wxDynamicLibrary::CanonicalizeName}\label{wxdynamiclibrarycanonicalizename}
|
\membersection{wxDynamicLibrary::CanonicalizeName}\label{wxdynamiclibrarycanonicalizename}
|
||||||
|
|
||||||
\func{wxString}{CanonicalizeName}{\param{const wxString\& }{name}, \param{wxDynamicLibraryCategory}{ cat = wxDL\_LIBRARY}}
|
\func{static wxString}{CanonicalizeName}{\param{const wxString\& }{name}, \param{wxDynamicLibraryCategory}{ cat = wxDL\_LIBRARY}}
|
||||||
|
|
||||||
Returns the platform-specific full name for the library called \arg{name}. E.g.
|
Returns the platform-specific full name for the library called \arg{name}. E.g.
|
||||||
it adds a {\tt ".dll"} extension under Windows and {\tt "lib"} prefix and
|
it adds a {\tt ".dll"} extension under Windows and {\tt "lib"} prefix and
|
||||||
@@ -66,7 +66,7 @@ The possible values for \arg{cat} are:
|
|||||||
|
|
||||||
\membersection{wxDynamicLibrary::CanonicalizePluginName}\label{wxdynamiclibrarycanonicalizepluginname}
|
\membersection{wxDynamicLibrary::CanonicalizePluginName}\label{wxdynamiclibrarycanonicalizepluginname}
|
||||||
|
|
||||||
\func{wxString}{CanonicalizePluginName}{\param{const wxString\& }{name}, \param{wxPluginCategory}{ cat = wxDL\_PLUGIN\_GUI}}
|
\func{static wxString}{CanonicalizePluginName}{\param{const wxString\& }{name}, \param{wxPluginCategory}{ cat = wxDL\_PLUGIN\_GUI}}
|
||||||
|
|
||||||
This function does the same thing as
|
This function does the same thing as
|
||||||
\helpref{CanonicalizeName}{wxdynamiclibrarycanonicalizename} but for wxWidgets
|
\helpref{CanonicalizeName}{wxdynamiclibrarycanonicalizename} but for wxWidgets
|
||||||
@@ -91,6 +91,14 @@ the library any longer in its destructor but it is now the callers
|
|||||||
responsibility to do this using \helpref{Unload}{wxdynamiclibraryunload}.
|
responsibility to do this using \helpref{Unload}{wxdynamiclibraryunload}.
|
||||||
|
|
||||||
|
|
||||||
|
\membersection{wxDynamicLibrary::GetProgramHandle}\label{wxdynamiclibrarygetprogramhandle}
|
||||||
|
|
||||||
|
\func{static wxDllType}{GetProgramHandle}{\void}
|
||||||
|
|
||||||
|
Return a valid handle for the main program itself or \texttt{NULL} if symbols
|
||||||
|
from the main program can't be loaded on this platform.
|
||||||
|
|
||||||
|
|
||||||
\membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol}
|
\membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol}
|
||||||
|
|
||||||
\constfunc{void *}{GetSymbol}{\param{const wxString\& }{name}}
|
\constfunc{void *}{GetSymbol}{\param{const wxString\& }{name}}
|
||||||
|
@@ -698,7 +698,7 @@ any or-combination of the following constants:
|
|||||||
\twocolitem{{\bf wxPATH\_NORM\_ENV\_VARS}}{replace env vars with their values}
|
\twocolitem{{\bf wxPATH\_NORM\_ENV\_VARS}}{replace env vars with their values}
|
||||||
\twocolitem{{\bf wxPATH\_NORM\_DOTS}}{squeeze all .. and . and prepend cwd}
|
\twocolitem{{\bf wxPATH\_NORM\_DOTS}}{squeeze all .. and . and prepend cwd}
|
||||||
\twocolitem{{\bf wxPATH\_NORM\_TILDE}}{Unix only: replace ~ and ~user}
|
\twocolitem{{\bf wxPATH\_NORM\_TILDE}}{Unix only: replace ~ and ~user}
|
||||||
\twocolitem{{\bf wxPATH\_NORM\_CASE}}{if filesystem is case insensitive, transform to tolower case}
|
\twocolitem{{\bf wxPATH\_NORM\_CASE}}{if filesystem is case insensitive, transform to lower case}
|
||||||
\twocolitem{{\bf wxPATH\_NORM\_ABSOLUTE}}{make the path absolute}
|
\twocolitem{{\bf wxPATH\_NORM\_ABSOLUTE}}{make the path absolute}
|
||||||
\twocolitem{{\bf wxPATH\_NORM\_LONG}}{make the path the long form}
|
\twocolitem{{\bf wxPATH\_NORM\_LONG}}{make the path the long form}
|
||||||
\twocolitem{{\bf wxPATH\_NORM\_SHORTCUT}}{resolve if it is a shortcut (Windows only)}
|
\twocolitem{{\bf wxPATH\_NORM\_SHORTCUT}}{resolve if it is a shortcut (Windows only)}
|
||||||
|
@@ -90,7 +90,7 @@ Now you only need to create an object of this class and pass it to, for example,
|
|||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
wxString command;
|
wxString command;
|
||||||
if ( filetype->GetOpenCommand(&command,
|
if ( filetype->GetOpenCommand(&command,
|
||||||
MailMessageParamaters("foo.txt", "text/plain")) )
|
MailMessageParameters("foo.txt", "text/plain")) )
|
||||||
{
|
{
|
||||||
// the full command for opening the text documents is in 'command'
|
// the full command for opening the text documents is in 'command'
|
||||||
// (it might be "notepad foo.txt" under Windows or "cat foo.txt" under Unix)
|
// (it might be "notepad foo.txt" under Windows or "cat foo.txt" under Unix)
|
||||||
|
@@ -1330,7 +1330,8 @@ Return the (current) user's home directory.
|
|||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxGetUserHome}{wxgetuserhome}
|
\helpref{wxGetUserHome}{wxgetuserhome}\\
|
||||||
|
\helpref{wxStandardPaths}{wxstandardpaths}
|
||||||
|
|
||||||
\wxheading{Include files}
|
\wxheading{Include files}
|
||||||
|
|
||||||
@@ -2842,7 +2843,7 @@ See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient},
|
|||||||
|
|
||||||
\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
|
\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
|
||||||
|
|
||||||
\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}
|
\func{void}{wxEnableTopLevelWindows}{\param{bool}{ enable = true}}
|
||||||
|
|
||||||
This function enables or disables all top level windows. It is used by
|
This function enables or disables all top level windows. It is used by
|
||||||
\helpref{::wxSafeYield}{wxsafeyield}.
|
\helpref{::wxSafeYield}{wxsafeyield}.
|
||||||
|
@@ -35,7 +35,7 @@ wxMimeTypesManager *wxTheMimeTypesManager;
|
|||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
It is recommended to use this instance instead of creating your own because
|
It is recommended to use this instance instead of creating your own because
|
||||||
gathering MIME information may take quite a long on Unix systems.
|
gathering MIME information may take quite a long time on Unix systems.
|
||||||
|
|
||||||
\wxheading{Derived from}
|
\wxheading{Derived from}
|
||||||
|
|
||||||
|
@@ -297,12 +297,12 @@ Gravity tells wxSplitterWindow how much will left/top window grow while resizing
|
|||||||
|
|
||||||
Example values:
|
Example values:
|
||||||
\begin{itemize}\itemsep=0pt
|
\begin{itemize}\itemsep=0pt
|
||||||
\item{ 0.0 - only the bottom/right window is automaticaly resized}
|
\item{ 0.0 - only the bottom/right window is automatically resized}
|
||||||
\item{ 0.5 - both windows grow by equal size}
|
\item{ 0.5 - both windows grow by equal size}
|
||||||
\item{ 1.0 - only left/top window grows}
|
\item{ 1.0 - only left/top window grows}
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
|
||||||
Gravity should be real value betwwen 0.0 and 1.0.
|
Gravity should be a real value between 0.0 and 1.0.
|
||||||
|
|
||||||
Default value of sash gravity is 0.0. That value is compatible with previous
|
Default value of sash gravity is 0.0. That value is compatible with previous
|
||||||
(before gravity was introduced) behaviour of wxSplitterWindow.
|
(before gravity was introduced) behaviour of wxSplitterWindow.
|
||||||
@@ -396,7 +396,7 @@ child windows are shown if they are currently hidden.
|
|||||||
\docparam{window2}{The bottom pane.}
|
\docparam{window2}{The bottom pane.}
|
||||||
|
|
||||||
\docparam{sashPosition}{The initial position of the sash. If this value is
|
\docparam{sashPosition}{The initial position of the sash. If this value is
|
||||||
positive, it specifies the size of the upper pane. If it is negative, it is
|
positive, it specifies the size of the upper pane. If it is negative, its
|
||||||
absolute value gives the size of the lower pane. Finally, specify 0 (default)
|
absolute value gives the size of the lower pane. Finally, specify 0 (default)
|
||||||
to choose the default position (half of the total window height).}
|
to choose the default position (half of the total window height).}
|
||||||
|
|
||||||
|
@@ -26,11 +26,11 @@
|
|||||||
|
|
||||||
Initializes a new read-only memory stream which will use the specified buffer
|
Initializes a new read-only memory stream which will use the specified buffer
|
||||||
{\it data} of length {\it len}. The stream does not take ownership of the
|
{\it data} of length {\it len}. The stream does not take ownership of the
|
||||||
buffer, i.e. that it will not delete in its destructor.
|
buffer, i.e. the buffer will not be deleted in its destructor.
|
||||||
|
|
||||||
\func{}{wxMemoryInputStream}{\param{const wxMemoryOutputStream&}{ stream}}
|
\func{}{wxMemoryInputStream}{\param{const wxMemoryOutputStream&}{ stream}}
|
||||||
|
|
||||||
Creates a new read-only memory stream, initilalizing it with the
|
Creates a new read-only memory stream, initializing it with the
|
||||||
data from the given output stream \arg{stream}.
|
data from the given output stream \arg{stream}.
|
||||||
|
|
||||||
\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}
|
\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}\label{wxmemoryinputstreamdtor}
|
||||||
|
@@ -914,7 +914,7 @@ Same as Truncate. Removes the portion from {\it pos} to the end of the string.
|
|||||||
|
|
||||||
\func{wxString\&}{Remove}{\param{size\_t}{ pos}, \param{size\_t}{ len}}
|
\func{wxString\&}{Remove}{\param{size\_t}{ pos}, \param{size\_t}{ len}}
|
||||||
|
|
||||||
Removes the {\it len} characters from the string, starting at {\it pos}.
|
Removes {\it len} characters from the string, starting at {\it pos}.
|
||||||
|
|
||||||
\membersection{wxString::RemoveLast}\label{wxstringremovelast}
|
\membersection{wxString::RemoveLast}\label{wxstringremovelast}
|
||||||
|
|
||||||
|
@@ -67,7 +67,7 @@ handlers for reading and writing many image types, resizeable panels
|
|||||||
and dialogs on all platforms, document/view, OpenGL support,
|
and dialogs on all platforms, document/view, OpenGL support,
|
||||||
HTML-based and context-sensitive help, wizards, drag and drop,
|
HTML-based and context-sensitive help, wizards, drag and drop,
|
||||||
a grid class, ODBC support, threads, sockets, container classes,
|
a grid class, ODBC support, threads, sockets, container classes,
|
||||||
a styled text control, and much more. A 2,000 page reference manual
|
a styled text control, and much more. A 2,000-page reference manual
|
||||||
is provided in HTML, MS HTML Help, WinHelp, wxWidgets Help and PDF
|
is provided in HTML, MS HTML Help, WinHelp, wxWidgets Help and PDF
|
||||||
formats, and there are over eighty samples and demos.
|
formats, and there are over eighty samples and demos.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user