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

Some doc corrections

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@7247 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2000-04-23 15:53:30 +00:00
parent 4f0a1b07e6
commit 3049cbeb6a
9 changed files with 130 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/latex/wx/encconv.tex
View File

@@ -49,14 +49,14 @@ cannot be converted because it does not exist in output encoding:
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxCONVERT\_STRICT}}{follow behaviour of GNU Recode -
just copy unconvertable characters to output and don't change them
just copy unconvertible characters to output and don't change them
(its integer value will stay the same)}
\twocolitem{{\bf wxCONVERT\_SUBSTITUTE}}{try some (lossy) substitutions
- e.g. replace unconvertable latin capitals with acute by ordinary
- e.g. replace unconvertible latin capitals with acute by ordinary
capitals, replace en-dash or em-dash by '-' etc.}
\end{twocollist}
Both modes gurantee that output string will have same length
Both modes guarantee that output string will have same length
as input string.
\wxheading{Return value}
@@ -108,10 +108,10 @@ unix CP1252 {ISO8859_1,ISO8859_15}
\end{verbatim}
Equivalence is defined in terms of convertibility:
2 encodings are equivalent if you can convert text between
then without loosing information (it may - and will - happen
that you loose special chars like quotation marks or em-dashes
but you shouldn't loose any diacritics and language-specific
two encodings are equivalent if you can convert text between
then without losing information (it may - and will - happen
that you lose special chars like quotation marks or em-dashes
but you shouldn't lose any diacritics and language-specific
characters when converting between equivalent encodings).
Remember that this function does {\bf NOT} check for presence of
@@ -122,14 +122,14 @@ encodings. (It usually returns only one encoding.)
\begin{itemize}\itemsep=0pt
\item Note that argument {\it enc} itself may be present in the returned array,
so that you can - as a side effect - detect whether the
so that you can, as a side-effect, detect whether the
encoding is native for this platform or not.
\item helpref{Convert}{wxencodingconverterconvert} is not limited to
converting between equivalent encodings, it can convert between arbitrary
two encodings.
\item If {\it enc} is present in returned array, then it is {\bf always} first
\item \helpref{Convert}{wxencodingconverterconvert} is not limited to
converting between equivalent encodings, it can convert between two arbitrary
encodings.
\item If {\it enc} is present in the returned array, then it is {\bf always} the first
item of it.
\item Please note that the returned array may not contain any items at all.
\item Please note that the returned array may contain no items at all.
\end{itemize}
\membersection{wxEncodingConverter::GetAllEquivalents}\label{wxencodingconvertergetallequivalents}
@@ -139,7 +139,7 @@ item of it.
Similar to
\helpref{GetPlatformEquivalents}{wxencodingconvertergetplatformequivalents},
but this one will return ALL
equivalent encodings, regardless the platform, and including itself.
equivalent encodings, regardless of the platform, and including itself.
This platform's encodings are before others in the array. And again, if {\it enc} is in the array,
it is the very first item in it.

20
docs/latex/wx/fs.tex
View File

@@ -3,8 +3,8 @@
The wxHTML library uses a {\bf virtual file systems} mechanism
similar to the one used in Midnight Commander, Dos Navigator,
FAR or almost any modern file manager. (Do you remember? You can
press enter on ZIP file and its contents is displayed as if it
were a local directory...)
press enter on a ZIP file and its contents are displayed as if it
were a local directory.)
\wxheading{Classes}
@@ -17,14 +17,14 @@ on opened file (name, input stream, mime type and anchor).
Its main methods are ChangePathTo() and OpenFile(). This class
is most often used by the end user.
\item The \helpref{wxFileSystemHandler}{wxfilesystemhandler} is the core
if VFS mechanism. You can derive your own handler and pass it to
of the VFS mechanism. You can derive your own handler and pass it to
wxFileSystem's AddHandler() method. In the new handler you only need to
overwrite OpenFile() and CanOpen() methods.
override the OpenFile() and CanOpen() methods.
\end{itemize}
\wxheading{Locations}
Locations (aka filenames aka addresses) are constructed from 4 parts:
Locations (aka filenames aka addresses) are constructed from four parts:
\begin{itemize}\itemsep=0pt
\item {\bf protocol} - handler can recognize if it is able to open a
@@ -40,8 +40,8 @@ See Combined Protocols paragraph for details.
\wxheading{Combined Protocols}
Left location pretends protocol in URL string.
It's not used by global protocols like HTTP but it's used
The left location pretends the protocol in the URL string.
It is not used by global protocols like HTTP but it is used
by local ones - for example you can see this address:
file:archives/cpp\_doc.zip\#zip:reference/fopen.htm\#syntax
@@ -61,7 +61,7 @@ which is at WWW.
\wxheading{File Systems Included in wxHTML}
Following VFS handlers are part of wxWindows so far:
The following VFS handlers are part of wxWindows so far:
\begin{twocollist}
\twocolitem{{\bf wxInternetFSHandler}}{Handler for accessing documents
@@ -77,7 +77,6 @@ Include file is <wx/fs_mem.h>. UURL is prefixed with memory:, e.g.
In addition, wxFileSystem can access local files.
Use \helpref{wxFileSystem::AddHandler}{wxfilesystemaddhandler} to initialize
a handler, for example:
@@ -90,7 +89,6 @@ bool MyApp::OnInit()
{
wxFileSystem::AddHandler(new wxMemoryFSHandler);
...
}
\end{verbatim}

2
docs/latex/wx/htmlhlpf.tex
View File

@@ -6,7 +6,7 @@ your tex2rtf.ini file.
(See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} for help controller description.)
A {\bf book} consists of three files : header file, contents file and index file.
A {\bf book} consists of three files: header file, contents file and index file.
You can make a regular zip archive of these files, plus the HTML and any image files,
for wxHTML (or helpview) to read; and the .zip file can optionally be renamed to .htb.

4
docs/latex/wx/manual.tex
View File

@@ -25,13 +25,13 @@
%\special{!/@scaleunit 1 def}
\parskip=10pt
\parindent=0pt
\title{wxWindows 2.1.14: A portable C++ and Python GUI toolkit}
\title{wxWindows 2.1.16: A portable C++ and Python GUI toolkit}
\winhelponly{\author{by Julian Smart et al
%\winhelponly{\\$$\image{1cm;0cm}{wxwin.wmf}$$}
}}
\winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin,
Robin Dunn, et al}
\date{March 19th 2000}
\date{May 23rd 2000}
}
\makeindex
\begin{document}

134
docs/latex/wx/sizer.tex
View File

@@ -101,52 +101,20 @@ wxALIGN\_CENTER\_VERTICAL (same as wxALIGN\_CENTRE\_VERTICAL) and wxALIGN\_CENTE
item, for use in derived classes when sizing information is more
complex than what {\it option} and {\it flag} will allow for.}
\membersection{wxSizer::Prepend}\label{wxsizerprepend}
\membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
\func{wxSize}{CalcMin}{\void}
\func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
This method is abstract and has to be overwritten by any derived class.
Here, the sizer will do the actual calculation of its children minimal sizes.
\func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border= 0}, \param{wxObject* }{userData = NULL}}
\membersection{wxSizer::Fit}\label{wxsizerfit}
Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
list of items (windows, subsizers or spaces) owned by this sizer.
\func{void}{Fit}{\param{wxWindow* }{window}}
\membersection{wxSizer::Remove}\label{wxsizerremove}
\func{bool}{Remove}{\param{wxWindow* }{window}}
\func{bool}{Remove}{\param{wxSizer* }{sizer}}
\func{bool}{Remove}{\param{int }{nth}}
Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} the
equivalent sizer and {\it nth} is the position of the child in the sizer, typically 0 for
the first item. This method does not cause any layout or resizing to take place and does
not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} for updating
the layout "on screen" after removing a child fom the sizer.
Returns TRUE if the child item was found and removed, FALSE otherwise.
\membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}
\func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
\func{void}{SetMinSize}{\param{wxSize }{size}}
Call this to give the sizer a minimal size. Normally, the sizer will calculate its
minimal size based purely on how much space its children need. After calling this
method \helpref{GetMinSize}{wxsizergetminsize} will return either the minimal size
as requested by its children or the minimal size set here, depending on what is
bigger.
\membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
\func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
Call this to force the sizer to take the given dimension and thus force the items owned
by the sizer to resize themselves according to the rules defined by the paramater in the
\helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
Tell the sizer to resize the {\it window} to match the sizer's minimal size. This
is commonly done in the constructor of the window itself, see sample in the description
of \helpref{wxBoxSizer}{wxboxsizer}.
\membersection{wxSizer::GetSize}\label{wxsizergetsize}
@@ -168,21 +136,6 @@ Returns the minimal size of the sizer. This is either the combined minimal
size of all the children and their borders or the minimal size set by
\helpref{SetMinSize}{wxsizersetminsize}, depending on what is bigger.
\membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
\func{void}{RecalcSizes}{\void}
This method is abstract and has to be overwritten by any derived class.
Here, the sizer will do the actual calculation of its children's positions
and sizes.
\membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
\func{wxSize}{CalcMin}{\void}
This method is abstract and has to be overwritten by any derived class.
Here, the sizer will do the actual calculation of its children minimal sizes.
\membersection{wxSizer::Layout}\label{wxsizerlayout}
\func{void}{Layout}{\void}
@@ -191,13 +144,72 @@ Call this to force laying out the children anew, e.g. after having added a child
to or removed a child (window, other sizer or space) from the sizer while keeping
the current dimension.
\membersection{wxSizer::Fit}\label{wxsizerfit}
\membersection{wxSizer::Prepend}\label{wxsizerprepend}
\func{void}{Fit}{\param{wxWindow* }{window}}
\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
Tell the sizer to resize the {\it window} to match the sizer's minimal size. This
is commonly done in the constructor of the window itself, see sample in the description
of \helpref{wxBoxSizer}{wxboxsizer}.
\func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
\func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border= 0}, \param{wxObject* }{userData = NULL}}
Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
list of items (windows, subsizers or spaces) owned by this sizer.
\membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
\func{void}{RecalcSizes}{\void}
This method is abstract and has to be overwritten by any derived class.
Here, the sizer will do the actual calculation of its children's positions
and sizes.
\membersection{wxSizer::Remove}\label{wxsizerremove}
\func{bool}{Remove}{\param{wxWindow* }{window}}
\func{bool}{Remove}{\param{wxSizer* }{sizer}}
\func{bool}{Remove}{\param{int }{nth}}
Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} the
equivalent sizer and {\it nth} is the position of the child in the sizer, typically 0 for
the first item. This method does not cause any layout or resizing to take place and does
not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} for updating
the layout "on screen" after removing a child fom the sizer.
Returns TRUE if the child item was found and removed, FALSE otherwise.
\membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
\func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
Call this to force the sizer to take the given dimension and thus force the items owned
by the sizer to resize themselves according to the rules defined by the paramater in the
\helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
\membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}
\func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
\func{void}{SetMinSize}{\param{wxSize }{size}}
Call this to give the sizer a minimal size. Normally, the sizer will calculate its
minimal size based purely on how much space its children need. After calling this
method \helpref{GetMinSize}{wxsizergetminsize} will return either the minimal size
as requested by its children or the minimal size set here, depending on what is
bigger.
\membersection{wxSizer::SetItemMinSize}\label{wxsizersetitemminsize}
\func{void}{SetItemMinSize}{\param{wxWindow* }{window}, \param{int}{ width}, \param{int}{ height}}
\func{void}{SetItemMinSize}{\param{wxSizer* }{sizer}, \param{int}{ width}, \param{int}{ height}}
\func{void}{SetItemMinSize}{\param{int}{ pos}, \param{int}{ width}, \param{int}{ height}}
Set an item's minimum size by window, sizer, or position. The item will be found recursively
in the sizer's descendants. This function enables an application to set the size of an item
after initial creation.
\membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints}

8
docs/latex/wx/tfile.tex
View File

@@ -10,11 +10,11 @@ As usual, the accent is put on cross-platform features which explains, for
example, the \helpref{wxTextFile}{wxtextfile} class which may be used to convert
between different types of text files (DOS/Unix/Mac).
wxFile may be used for low-level IO. It contains all usual functions to work
with files (opening/closing, reading/writing, seeking...) but, compared to
using standard C functions, brings error checking (in case of an error a message
wxFile may be used for low-level IO. It contains all the usual functions to work
with files (opening/closing, reading/writing, seeking, and so on) but compared with
using standard C functions, has error checking (in case of an error a message
is logged using \helpref{wxLog}{wxlog} facilities) and closes the file
automatically in destructor which may be quite convenient.
automatically in the destructor which may be quite convenient.
wxTempFile is a very small file designed to make replacing the files contents
safer - see its \helpref{documentation}{wxtempfile} for more details.

8
docs/latex/wx/ti18n.tex
View File

@@ -1,11 +1,11 @@
\section{Internationalization}\label{internationalization}
Although internationalization (i18n for short) of an application involves far
more than just translating its text messages to another message (date, time and
Although internationalization of an application (i18n for short) involves far
more than just translating its text messages to another message -- date, time and
currency formats need changing too, some languages are written left to right
and others right to left, character encoding may differ and many other things
may need changing too), it is a necessary first step. wxWindows provides
facilities for the messages translation with its
may need changing too -- it is a necessary first step. wxWindows provides
facilities for message translation with its
\helpref{wxLocale}{wxlocale} class and is itself fully translated into several
languages. Please consult wxWindows home page for the most up-to-date
translations - and if you translate it into one of the languages not done

6
docs/latex/wx/tmbconv.tex
View File

@@ -21,7 +21,7 @@ in use.
\subsection{Background: The need for conversion}
As programs are becoming more and more globalized, and user exchange documents
As programs are becoming more and more globalized, and users exchange documents
across country boundaries as never before, applications increasingly need to
take into account all the different character sets in use around the world. It
is no longer enough to just depend on the default byte-sized character set that
@@ -33,7 +33,7 @@ it would resolve the character set problems once and for all.
But it hasn't happened yet, and the migration towards Unicode has created new
challenges, resulting in "compatibility encodings" such as UTF-8. A large
amount of systems out there still depends on the old 8-bit encodings, hampered
number of systems out there still depends on the old 8-bit encodings, hampered
by the huge amounts of legacy code still widely deployed. Even sending
Unicode data from one Unicode-aware system to another may need encoding to an
8-bit multibyte encoding (UTF-7 or UTF-8 is typically used for this purpose), to
@@ -51,7 +51,7 @@ literals).
But often, your environment doesn't want Unicode strings. You could be sending
data over a network, or processing a text file for some other application. You
need a way to quickly convert your easily-handled Unicode data to and from a
traditional 8-bit-encoding. And this is what the wxMBConv classes does.
traditional 8-bit-encoding. And this is what the wxMBConv classes do.
\subsection{wxMBConv classes}

40
docs/latex/wx/tnoneng.tex
View File

@@ -8,23 +8,23 @@ many characters it is impossible to use same texts under all platforms.
wxWindows provide mechanism that helps you avoid distributing many
identical, only differently encoded, packages with your application
(e.g. help files and menu items in iso8859-13 and windows-1257). Thanks
to this mechanism you can distribute only let's say iso8859-13 data
to this mechanism you can, for example, distribute only iso8859-13 data
and it will be handled transparently under all systems.
Please read \helpref{Internationalization}{internationalization} which
describes locales concept.
describes the locales concept.
Wherever in the following text {\it iso8859-2} and {\it windows-1250} are
In the following text, wherever {\it iso8859-2} and {\it windows-1250} are
used, any encodings are meant and any encodings may be substituted there.
\wxheading{Locales}
The best way how to ensure correctly displayed texts in GUI across platforms
The best way to ensure correctly displayed texts in a GUI across platforms
is to use locales. Write your in-code messages in English or without
diacritics and put real messages into message catalog (see
diacritics and put real messages into the message catalog (see
\helpref{Internationalization}{internationalization}).
Standard .po file begins with a header like this:
A standard .po file begins with a header like this:
\begin{verbatim}
# SOME DESCRIPTIVE TITLE.
@@ -51,11 +51,11 @@ Notice these two lines:
"Content-Type: text/plain; charset=CHARSET\n"
\end{verbatim}
The first tells {\it msgfmt} compiler not to include string "" (empty)
to compiled .mo catalog. Second one informs about charset used to write
The first tells the {\it msgfmt} compiler not to include "" (the empty string)
in compiled .mo catalog. The second one specifies the charset used to write
translated messages.
You have to do 2 things: fill-in proper charset information and delete
You have to do two things: fill in proper charset information and delete
the {\tt fuzzy} line. Your .po file may look like this after doing so:
\begin{verbatim}
@@ -76,24 +76,24 @@ msgstr ""
\end{verbatim}
wxWindows is able to use this catalog under any supported platform
(although iso8859-2 is Unix encoding and is not understood by Windows).
(although iso8859-2 is a Unix encoding and is not understood by Windows).
How is this done? When you tell wxLocale class to load message catalog that
contains the header (msgid "". Normal .mo catalogs do {\bf not} contain it,
How is this done? When you tell the wxLocale class to load a message catalog that
contains the header (msgid ""; normal .mo catalogs do {\bf not} contain it,
you must remove the line with {\it fuzzy}!), it checks the charset. If the
charset is "alien" on the platform the program is currently running (e.g.
any of ISO encodings under Windows or CP12XX under Unix) it uses
\helpref{wxEncodingConverter::GetPlatformEquivalents}{wxencodingconvertergetplatformequivalents}
to obtain encoding that is more common on this platform and converts
to obtain an encoding that is more common on this platform and converts
the message catalog to this encoding. Note that it does {\bf not} check
for presence of this encoding! It only assumes that it is always better to
have strings in platform native encoding than in an encoding that is rarely
(if ever) used.
The behaviour described about is disabled by default.
The behaviour described above is disabled by default.
You must set {\it bConvertEncoding} to TRUE in
\helpref{wxLocale constructor}{wxlocaledefctor} in order to enable
runtime encoding conversion!
runtime encoding conversion.
\wxheading{Font mapping}
@@ -122,26 +122,26 @@ if (!wxTheFontMapper->IsEncodingAvailable(enc, facename))
\wxheading{Converting data}
You may want to store all program data (created documents etc.) in
same encoding, let's say windows1250. Obviously, the best way would
the same encoding, let's say windows1250. Obviously, the best way would
be to use \helpref{wxEncodingConverter}{wxencodingconverter}.
\wxheading{Help files}
If you're using \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} there is
no problem at all. You must only make sure that all HTML files contain
META tag, e.g.
no problem at all. You must only make sure that all the HTML files contain
the META tag, e.g.
\begin{verbatim}
<meta http-equiv="Content-Type" content="iso8859-2">
\end{verbatim}
and that hhp project file contains one additional line in {\tt OPTIONS}
and that the hhp project file contains one additional line in the {\tt OPTIONS}
section:
\begin{verbatim}
Charset=iso8859-2
\end{verbatim}
This additional entry tells HTML help controller what encoding is used
This additional entry tells the HTML help controller what encoding is used
in contents and index tables.