]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/univ/readme.txt
The mmedia contrib requires sys/soundcard.h on unix, so disable it on unix
[wxWidgets.git] / docs / univ / readme.txt
... / ...
CommitLineData
1 wxUniversal README
2 ==================
3
4Welcome to wxUniversal!
5
6Acknowledgements: wxUniversal wouldn't have been written without the
7generous support of SciTech Software. Many thanks to Kendall Bennett and
8Tom Ryan!
9
100. Introduction
11---------------
12
13wxUniversal is a port of wxWidgets which implements the various GUI controls
14by drawing them itself (using low level wxWidgets classes). Please see
15
16 http://www.wxwidgets.org/wxuniv.htm
17
18for more details about it.
19
20The advantage of wxUniversal is that you have precise control over the
21controls' appearance (it is not always possible to change all aspects of the
22native controls) and the theme support: the same program may be changed to
23look completely differently without changing a single line of its code but
24just changing the theme.
25
26Another advantage is that it makes writing ports of wxWidgets for other
27platforms (such as OS/2, BeOS or QNX) much simpler, so it is of special
28interest to people interested in porting wxWidgets to another platform.
29
30However, wxUniversal doesn't have a 100% native look and feel unlike the
31other wxWidgets ports - this is the price to pay for the extra flexibility.
32
331. Requirements and supported platforms
34---------------------------------------
35
36wxUniversal is used together with another wxWidgets port which provides the
37"low level classes" mentioned above. Currently it can be built with wxMSW,
38wxGTK or wxX11. In any case, you should download the sources for the
39appropriate toolkit in addition to wxUniversal - in fact, you should download
40them first and then unpack wxUniversal in the same directory.
41
42The requirements for wxUniversal are the same as for the underlying low level
43toolkit.
44
452. Installing under Win32
46-------------------------
47
48If compiling from CVS, please copy include/wx/univ/setup0.h
49to include/wx/univ/setup.h before following these steps.
50
51a) Using Visual C++ 6.0/7.x
52
53 Follow wxMSW instructions but make sure to choose one of the "Universal"
54 configurations before building.
55
56b) Cygwin
57
58 Please refer to the Unix section below
59
60** the instructions may be out of date as for wxWidgets 2.5.2+ **
61
62c) Other compilers
63 Borland:
64 in the wxwindows\src\msw directory run
65 'make -f makefile.b32 WXUSINGUNIV=1' to build the library and then run
66 'make -f makefile.b32 WXUSINGUNIV=1' in the sample directory which you wish
67 to build using the wxUniversal widgets. Use 'SET WXTHEME=GTK' [or WIN32 or METAL]
68 to test the existing themes
69
70Unfortunately we don't have makefiles for any other compilers yet.
71Please contact us if you would like to help us with creating one for the
72compiler you use.
73
74Note that you can use the wxUniversal classes, wxMSW and MicroWindows (from
75Century Software) to build a different variant of wxUniversal than that
76documented here. Please see docs/univ/readme.txt for further information.
77Note that this port is not up-to-date and probably needs work
78to compile.
79
80Note that by default, wxUniv under MSW uses PostScript printing,
81not Windows printing. To change to Windows printing, set
82wxUSE_POSTSCRIPT_ARCHITECTURE_IN_MSW to 0 in include/wx/univ/setup.h
83before compiling.
84
853. Installing under Unix
86------------------------
87
88Please refer to the installation instructions for wxGTK or wxX11. The only
89change for wxUniversal is that you must add "--enable-universal" switch to
90the configure command line and for wxX11 even this is unnecessary, i.e. it
91is enabled by default.
92
93If compiling from CVS, please copy include/wx/univ/setup0.h
94to include/wx/univ/setup.h before configuring.
95
964. Running wxUniv programs
97--------------------------
98
99wxUniv programs all honour the standard option "--theme" which allows to
100specify the theme to be used by name. Currently there are the following
101themes:
102
103a) win32 -- Windows 95 look and feel
104b) metal -- based on win32 but with gradient backgrounds
105c) gtk -- GTK+ 1.x standard look and feel
106
107Thus, to launch a program using gtk theme you may do "./program --theme=gtk".
108
109It is also possible to change the default theme for all wxUniv applications
110at once by setting the environment variable WXTHEME to the theme name.
111
1125. Documentation and support
113----------------------------
114
115Please note that wxUniversal is not as mature as the other wxWidgets ports
116and is currently officially in alpha stage. In particular, it is not really
117intended for the end users but rather for developers at the current stage and
118this is why we don't provide any binaries for it.
119
120There is no separate documentation for wxUniversal, please refer to wxWidgets
121documentation instead.
122
123Support for wxUniversal is available from the same places as for wxWidgets
124itself, namely:
125
126* Usenet newsgroup comp.soft-sys.wxwindows
127
128* Mailing lists: see http://lists.wxwindows.org/ for more information
129
130* WWW page: http://www.wxwidgets.org/
131
132
133 Hope you find wxUniversal useful!
134
135 Vadim Zeitlin
136
137
138This file is accurate for the version 2.3.4 of wxUniversal. It was last
139modified on Apr 15, 2002.
140