Some changes in a vain attempt to make Salford C++ work; added FAQ files;

started wxTime documentation.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-01-19 11:00:22 +00:00
parent 15d5ab6757
commit ce3ed50dbe
82 changed files with 951 additions and 205 deletions

43
docs/html/faq.htm Normal file
View File

@@ -0,0 +1,43 @@
<HTML>
<HEAD>
<TITLE>wxWindows 2 FAQ</TITLE>
</HEAD>
<BODY BGCOLOR=#FFFFFF TEXT=#000000 LINK=#FF0000 VLINK=#000000>
<font face="Arial, Lucida Sans, Helvetica">
<table width=100% border=4 cellpadding=5 cellspacing=0>
<tr>
<td bgcolor="#660000">
<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
wxWindows 2 FAQ
</font>
</td>
</tr>
</table>
<P>
Welcome to the wxWindows FAQ. Please select a category:<P>
<ul>
<li><a href="faqgen.htm">General questions</a>
<li><a href="faqgtk.htm">wxWindows 2 for GTK</a>
<li><a href="faqmsw.htm">wxWindows 2 for Windows</a>
<li><a href="faqmot.htm">wxWindows 2 for Motif</a>
<li><a href="faqmac.htm">wxWindows 2 for Mac</a>
</ul>
<P>
For further information, please see the <a href="http://wxwin.home.ml.org" target=_top>wxWindows Web site</a>,
plus install.txt (per port), todo.txt (per port), and bugs.txt (all ports).
<P>
</font>
</BODY>
</HTML>

68
docs/html/faqgen.htm Normal file
View File

@@ -0,0 +1,68 @@
<HTML>
<HEAD>
<TITLE>wxWindows 2 FAQ: General</TITLE>
</HEAD>
<BODY BGCOLOR=#FFFFFF TEXT=#000000 LINK=#FF0000 VLINK=#000000>
<font face="Arial, Lucida Sans, Helvetica">
<table width=100% border=4 cellpadding=5 cellspacing=0>
<tr>
<td bgcolor="#660000">
<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
wxWindows 2 FAQ: General
</font>
</td>
</tr>
</table>
<P>
See also <a href="faq.htm">top-level FAQ page</a>.
<hr>
<H3><a name="whatis">What is wxWindows?</a></H3>
wxWindows is a class library that allows you to compile graphical C++ programs on a range of
different platforms. wxWindows defines a common API across platforms, but uses the native graphical user interface (GUI) on each platform,
so your program will take on the native 'look and feel' that users are familiar with.<P>
Although GUI applications are mostly built programmatically, there is a dialog editor to help
build attractive dialogs and panels.<P>
You don't have to use C++ to use wxWindows: wxWindows 1 has been interfaced to several interpreted languages,
such as CLIPS, Python, Scheme, XLisp and Perl, and there is a Python interface for wxWindows 2.
<P>
<h3>Can I use wxWindows 2 for both proprietary (commercial) projects, and GPL'ed projects?</h3>
Yes. Please see the <a href="newlicen.htm">licence</a> for details, but basically
you can distribute proprietary binaries without distributing any source code, and neither will wxWindows
conflict with GPL code you may be using or developing with it.
<P>
The conditions for using wxWindows 2 are the same whether you are a personal, academic
or commercial developer.
<P>
<h3>Is there support?</h3>
No official support, but the mailing list is very helpful and some people say that
wxWindows support is better than for much commercial software. The developers are
keen to fix bugs as soon as possible, though obviously there are no guarantees.
<P>
<H3><a name="users">Who uses wxWindows?</a></H3>
Many organisations - commercial, government, and academic - across the
world. It's impossible to estimate the true number of users, since
wxWindows is obtained by many different means, and we cannot monitor
distribution. The mailing list contains around 300-400 entries which is
quite large for a list of this type.<P>
</font>
</BODY>
</HTML>

47
docs/html/faqgtk.htm Normal file
View File

@@ -0,0 +1,47 @@
<HTML>
<HEAD>
<TITLE>wxWindows 2 for GTK FAQ</TITLE>
</HEAD>
<BODY BGCOLOR=#FFFFFF TEXT=#000000 LINK=#FF0000 VLINK=#000000>
<font face="Arial, Lucida Sans, Helvetica">
<table width=100% border=4 cellpadding=5 cellspacing=0>
<tr>
<td bgcolor="#660000">
<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
wxWindows 2 for GTK FAQ
</font>
</td>
</tr>
</table>
<P>
See also <a href="faq.htm">top-level FAQ page</a>.
<hr>
<h3>What is wxWindows 2 for GTK?</h3>
wxWindows 2 for GTK is a port of wxWindows to the <a href="http://www.gimp.org/gtk" target=_top>GTK+ toolkit</a>,
which is freely available for most flavours of Unix with X. wxWindows 2 for GTK is
often abbreviated to wxGTK. wxGTK has a separate home page <a href="http://www.freiburg.linux.de/~wxxt" target=_top>here</a>.
<P>
<h3>Does wxGTK have GNOME support?</h3>
Currently wxGTK does not have any features that would involve dependence on any desktop
environment's libraries, so it can work on GNOME, KDE and with other window managers
without installation hassles. Some GNOME and KDE integration features are file based, and
so may be added without dependence on libraries. Other features may be supported in the
future, probably as a separate library.
<P>
</font>
</BODY>
</HTML>

37
docs/html/faqmac.htm Normal file
View File

@@ -0,0 +1,37 @@
<HTML>
<HEAD>
<TITLE>wxWindows 2 for Mac FAQ</TITLE>
</HEAD>
<BODY BGCOLOR=#FFFFFF TEXT=#000000 LINK=#FF0000 VLINK=#000000>
<font face="Arial, Lucida Sans, Helvetica">
<table width=100% border=4 cellpadding=5 cellspacing=0>
<tr>
<td bgcolor="#660000">
<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
wxWindows 2 for Mac FAQ
</font>
</td>
</tr>
</table>
<P>
See also <a href="faq.htm">top-level FAQ page</a>.
<hr>
<h3>When is wxMac 2 due to be released?</h3>
There is a <a href="http://wxwin.home.ml.org/wxwin/dl_mac2.htm">preview</a> available.
A beta release can be expected by early Q2 1999. The author of this port
is Stefan Csomor (csomor@advancedconcepts.ch).
<P>
</font>
</BODY>
</HTML>

96
docs/html/faqmot.htm Normal file
View File

@@ -0,0 +1,96 @@
<HTML>
<HEAD>
<TITLE>wxWindows 2 for Motif FAQ</TITLE>
</HEAD>
<BODY BGCOLOR=#FFFFFF TEXT=#000000 LINK=#FF0000 VLINK=#000000>
<font face="Arial, Lucida Sans, Helvetica">
<table width=100% border=4 cellpadding=5 cellspacing=0>
<tr>
<td bgcolor="#660000">
<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
wxWindows 2 for Motif FAQ
</font>
</td>
</tr>
</table>
<P>
See also <a href="faq.htm">top-level FAQ page</a>.
<hr>
<h3>What version of Motif do I need?</h3>
You will need version 1.2 or above. Version 2 should also be fine. Some people
have had a positive experience with <a href="www.lesstif.org" target=_top>Lesstif</a>,
a free Motif clone. (Note from Julian Smart - I use the Linux version of MetroLink Motif).
<P>
<h3>What features are missing or partially implemented?</h3>
The following classes are not yet implemented: wxSpinButton, wxCheckListBox, wxJoyStick,
wxGLCanvas.<P>
The following classes are not likely to be implemented because there is no sensible
equivalent on Motif: wxMiniFrame, wxTaskBar.<P>
wxNotebook works for smaller dialogs (see notebook sample) but has some problems
with a more complex situation (see the controls sample: initial resizing is very apparent).
<P>
These features are not yet implemented:<P>
<ul>
<li>Clipboard and drag and drop support are currently under development. Motif clipboard support
should work, but currently for text only.
<li>Support for selection of specific visuals.
<li>Wide character support (but when Unicode is supported under Windows, this support will
be relatively easy to add).
<li>Configurable colour/font settings (they are currently hard-wired in wxSystemSettings).
<li>OnEraseBackground.
<li>OnPaint optimization and backing pixmap.
<li>A help system (please use wxHelpController and Netscape instead).
</ul>
<p>
<h3>Does Dialog Editor work with wxWindows for Motif?</h3>
Suport for Dialog Editor is almost there, but there are some wrinkles to iron
out. You may find it's useful though: compile it and see.
<P>
<h3>How do I switch between debugging and release compilation modes?</h3>
Unfortunately the makefile system doesn't currently allow you to compile
for both simultaneously: you need
to recompile wxWindows and your application having adjusted make.env. However,
you could rename the binary and release library archives, and adjust your makefiles
to use the appropriate one (or change a symbolic link).
<P>
<h3>Why are windows are not refreshed properly until I resize them?</h3>
Very occasionally you can experience this glitch, probably because sometimes the
window tries to resize and repaint itself before the final size is known. The workaround
is to add code like this after window creation and initialization:<P>
<PRE>
#ifdef __WXMOTIF__
wxNoOptimize noOptimize;
window->SetSize(-1, -1, w, h);
#endif
</PRE>
<P>
</font>
</BODY>
</HTML>

99
docs/html/faqmsw.htm Normal file
View File

@@ -0,0 +1,99 @@
<HTML>
<HEAD>
<TITLE>wxWindows 2 for Windows FAQ</TITLE>
</HEAD>
<BODY BGCOLOR=#FFFFFF TEXT=#000000 LINK=#FF0000 VLINK=#000000>
<font face="Arial, Lucida Sans, Helvetica">
<table width=100% border=4 cellpadding=5 cellspacing=0>
<tr>
<td bgcolor="#660000">
<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
wxWindows 2 for Windows FAQ
</font>
</td>
</tr>
</table>
<P>
See also <a href="faq.htm">top-level FAQ page</a>.
<hr>
<h3>Is Windows 3.1 supported?</h3>
Yes! Unlike Microsoft, we have not forgotten users of 16-bit Windows. Most features
work under Windows 3.1, including wxTreeCtrl and wxListCtrl using the generic implementation.
However, don't expect Windows 95-specific classes to work, such as wxTaskBar. The wxRegConfig
class doesn't work either because the Windows 3.1 registry is very simplistic. Check out the 16-bit
makefiles to see what other files have been left out.
<P>
16-bit compilation is supported under Visual C++ 1.5, and Borland BC++ 4 to 5.
<P>
<h3>What compilers are supported?</h3>
Please see the wxWindows 2 for Windows install.txt file for up-to-date information, but
currently the following are known to work:<P>
<ul>
<li>Visual C++ 1.5, 4.0, 5.0, 6.0
<li>Borland C++ 4.5, 5.0
<li>Borland C++Builder 1.0, 3.0
<li>Watcom C++ 10.6 (WIN32)
<li>Cygwin b20
<li>Mingw32
<li>MetroWerks CodeWarrior 4
</ul>
<P>
There is a linking problem with Symantec C++ which I hope someone can help solve.
<P>
<h3>Which is the best compiler to use with wxWindows 2?</h3>
It's partly a matter of taste, but I (JACS) prefer Visual C++ since the debugger is very
good, it's very stable, the documentation is extensive, and it generates small executables.
Since project files are plain text, it's easy for me to generate appropriate project files
for wxWindows samples.<P>
Borland C++ is fine - and very fast - but it's hard (impossible?) to use the debugger without using project files, and
the debugger is nowhere near up to VC++'s quality. The IDE isn't great.<P>
C++Builder's power isn't really used with wxWindows since it needs integration with its
own class library (VCL). For wxWindows, I've only used it with makefiles, in which case
it's almost identical to BC++ 5.0 (the same makefiles can be used).<P>
You can't beat Cygwin's price (free), and you can debug adequately using gdb. However, it's
quite slow to compile since it does not use precompiled headers.<P>
CodeWarrior is cross-platform - you can debug and generate Windows executables from a Mac, but not
the other way around I think - but the IDE is, to my mind, a bit primitive.<P>
Watcom C++ is a little slow and the debugger is not really up to today's standards.<P>
<h3>Is Unicode supported?</h3>
No, although there are other internationalisation features.<P>
However, the issues surrounding Unicode support have been looked into so we know
what we need to do, and have some header files ready to use containing appropriate
type definitions. Just about every file in wxWindows will need changes, due to the
pervasive nature of characters and character arrays. Unicode support is needed
for the port to Windows CE (see below).<P>
<h3>What about Windows CE?</h3>
This is under consideration, though we need to get wxWindows Unicode-aware first.
There are other interesting issues, such as how to combine the menubar and toolbar APIs
as Windows CE requires.<P>
</font>
</BODY>
</HTML>

View File

@@ -45,6 +45,14 @@ from the <a href="http://wxwin.home.ml.org">wxWindows Web site</a>.<P>
<a href="../licendoc.txt">Documentation Licence</a>,
<a href="../lgpl.txt">L-GPL</a>,
<a href="../gpl.txt">GPL</a>
<li><a href="faq.htm"><B>FAQ</B></a>:
<ul>
<li><a href="faqgen.htm">General questions</a>
<li><a href="faqgtk.htm">wxWindows 2 for GTK</a>
<li><a href="faqmsw.htm">wxWindows 2 for Windows</a>
<li><a href="faqmot.htm">wxWindows 2 for Motif</a>
<li><a href="faqmac.htm">wxWindows 2 for Mac</a>
</ul>
<li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
<a href="../gtk/todo.txt">wxGTK</a>,
<a href="../motif/todo.txt">wxMotif</a>,

View File

@@ -1,17 +1,239 @@
\section{\class{wxTime}}\label{wxtime}
A class for manipulating times.
TODO.
Representation of time and date.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Data structures}
{\small \begin{verbatim}
typedef unsigned short hourTy;
\end{verbatim}}
{\small \begin{verbatim}
typedef unsigned short minuteTy;
\end{verbatim}}
{\small \begin{verbatim}
typedef unsigned short secondTy;
\end{verbatim}}
{\small \begin{verbatim}
typedef unsigned long clockTy;
\end{verbatim}}
{\small \begin{verbatim}
enum tFormat { wx12h, wx24h };
\end{verbatim}}
{\small \begin{verbatim}
enum tPrecision { wxStdMinSec, wxStdMin };
\end{verbatim}}
\wxheading{See also}
\helpref{wxDate}{wxDate}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTime::wxTime}\label{wxtimewxtime}
\func{}{wxTime}{\void}
Initialize the object using the current time.
\func{}{wxTime}{\param{clockTy }{s}}
Initialize the object using the number of seconds that have elapsed since ???.
\func{}{wxTime}{\param{const wxTime\&}{ time}}
Copy constructor.
\func{}{wxTime}{\param{hourTy }{h}, \param{minuteTy }{m}, \param{secondTy }{s = 0}, \param{bool }{dst = FALSE}}
Initialize using hours, minutes, seconds, and whether DST time.
\membersection{wxTime::wxTime}\label{wxtimewxtime}
\func{}{wxTime}{\param{const wxDate\&}{ date}, \param{hourTy }{h = 0}, \param{minuteTy }{m = 0}, \param{secondTy }{s = 0}, \param{bool }{dst = FALSE}}
Initialize using a \helpref{wxDate}{wxdate} object, hours, minutes, seconds, and whether DST time.
\membersection{wxTime::GetDay}\label{wxtimegetday}
\constfunc{int}{GetDay}{\void}
Returns the day of the month.
\membersection{wxTime::GetDayOfWeek}\label{wxtimegetdatofweek}
\constfunc{int}{GetDayOfWeek}{\void}
Returns the day of the week, a number from 0 to 6 where 0 is Sunday and 6 is Saturday.
\membersection{wxTime::GetHour}\label{wxtimegethour}
\constfunc{hourTy}{GetHour}{\void}
Returns the hour in local time.
\membersection{wxTime::GetHourGMT}\label{wxtimegethourgmt}
\constfunc{hourTy}{GetHourGMT}{\void}
Returns the hour in GMT.
\membersection{wxTime::GetMinute}\label{wxtimegetminute}
\constfunc{minuteTy}{GetMinute}{\void}
Returns the minute in local time.
\membersection{wxTime::GetMinuteGMT}\label{wxtimegetminutegmt}
\constfunc{minuteTy}{GetMinuteGMT}{\void}
Returns the minute in GMT.
\membersection{wxTime::GetMonth}\label{wxtimegetmonth}
\constfunc{int}{GetMonth}{\void}
Returns the month.
\membersection{wxTime::GetSecond}\label{wxtimegetsecond}
\constfunc{secondTy}{GetSecond}{\void}
Returns the second in local time or GMT.
\membersection{wxTime::GetSecondGMT}\label{wxtimegetsecondgmt}
\constfunc{secondTy}{GetSecondGMT}{\void}
Returns the second in GMT.
\membersection{wxTime::GetSeconds}\label{wxtimegetseconds}
\constfunc{clockTy}{GetSeconds}{\void}
Returns the number of seconds since ???.
\membersection{wxTime::GetYear}\label{wxtimegetyear}
\constfunc{int}{GetYear}{\void}
Returns the year.
\membersection{wxTime::FormatTime}\label{wxtimeformattime}
\constfunc{char*}{FormatTime}{\void}
Formats the time according to the current formatting options: see \helpref{wxTime::SetFormat}{wxtimesetformat}.
\membersection{wxTime::IsBetween}\label{wxtimeisbetween}
\constfunc{bool}{IsBetween}{\param{const wxTime\& }{a}, \param{const wxTime\& }{b}}
Returns TRUE if this time is between the two given times.
\membersection{wxTime::Max}\label{wxtimemax}
\constfunc{wxTime}{Max}{\param{const wxTime\& }{time}}
Returns the maximum of the two times.
\membersection{wxTime::Min}\label{wxtimemin}
\constfunc{wxTime}{Min}{\param{const wxTime\& }{time}}
Returns the minimum of the two times.
\membersection{wxTime::SetFormat}\label{wxtimesetformat}
\func{static void}{SetFormat}{\param{const tFormat}{ format = wx12h},
\param{const tPrecision}{ precision = wxStdMinSec}}
Sets the format and precision.
\membersection{wxTime::operator char*}\label{wxtimestring}
\func{operator}{char*}{\void}
Returns a pointer to a static char* containing the formatted time.
\membersection{wxTime::operator wxDate}\label{wxtimewxdate}
\constfunc{operator}{wxDate}{\void}
Converts the wxTime into a wxDate.
\membersection{wxTime::operator $=$}\label{wxtimeoperator}
\func{void}{operator $=$}{\param{const wxTime\& }{t}}
Assignment operator.
\membersection{wxTime::operator $<$}\label{wxtimeoperatorle}
\constfunc{bool}{operator $<$}{\param{const wxTime\& }{t}}
Less than operator.
\membersection{wxTime::operator $<=$}\label{wxtimeoperatorleq}
\constfunc{bool}{operator $<=$}{\param{const wxTime\& }{t}}
Less than or equal to operator.
\membersection{wxTime::operator $>$}\label{wxtimeoperatorge}
\constfunc{bool}{operator $>$}{\param{const wxTime\& }{t}}
Greater than operator.
\membersection{wxTime::operator $>=$}\label{wxtimeoperatorgeq}
\constfunc{bool}{operator $>=$}{\param{const wxTime\& }{t}}
Greater than or equal to operator.
\membersection{wxTime::operator $==$}\label{wxtimeoperatoreq}
\constfunc{bool}{operator $==$}{\param{const wxTime\& }{t}}
Equality operator.
\membersection{wxTime::operator $!=$}\label{wxtimeoperatorneq}
\constfunc{bool}{operator $!=$}{\param{const wxTime\& }{t}}
Inequality operator.
\membersection{wxTime::operator $+$}\label{wxtimeoperatorplus}
\constfunc{bool}{operator $+$}{\param{long }{sec}}
Addition operator.
\membersection{wxTime::operator $-$}\label{wxtimeoperatorminus}
\constfunc{bool}{operator $-$}{\param{long }{sec}}
Subtraction operator.
\membersection{wxTime::operator $+=$}\label{wxtimeoperatorpluseq}
\constfunc{bool}{operator $+=$}{\param{long }{sec}}
Increment operator.
\membersection{wxTime::operator $-=$}\label{wxtimeoperatorminuseq}
\constfunc{bool}{operator $-=$}{\param{long }{sec}}
Decrement operator.

View File

@@ -136,6 +136,25 @@ Some functionality is missing using this compiler (see makefile).
Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
Step (2). 16-bit compilation is left as an excercise for the user!
Salford C++ compilation
-----------------------
1. Make sure your WXWIN variable is set, and uses the FAT (short
name) form.
2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
notes.
3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
make the wxWindows core library.
4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
to make this sample.
Unfortunately, Salford C++ seems to have problems with its code generation for
operations on objects, as seen in wxFrame::OnMenuHighlight
(minimal sample) or wxWindow::SetValidator (mdi sample). Also the
the debugging version of the library is 90MB, with samples coming in
at 40MB :-) However, wxWindows at least makes a good test suite for
improving the compiler.
Gnu-Win32 b19/b20/Mingw32 compilation
-------------------------------------

View File

@@ -8,14 +8,12 @@ HIGH PRIORITY
Add further controls and properties to Dialog Editor.
Update manual.
wxTempFile
wxMsgCatalog etc.
wxRegKey
wxStatusBar95 and wxFrame status bar functions
wxListBox changes (for ownerdraw functionality)
wxThread DONE (except for topic overview)
wxString PARTLY DONE
Drag and drop (change API if required, e.g. const).
wxBaseArray, other arrays
(wxOwnerDrawn)
Document the include file for each class