ReadMe updates
[wxWidgets.git] / docs / microwin / readme.txt
1 wxMicroWindows port
2 ===================
3
4 Julian Smart 2001-07-02
5
6 This is a port of wxWindows to MicroWindows, under Linux.
7 Widgets are supplied by the wxUniversal project, while the
8 underlying port uses the Windows ports with small modifications
9 for the MicroWindows API.
10
11 There are many things missing from MicroWindows that will
12 make the port quite limited for the time being. I haven't
13 worked out how to create bitmaps, though there is a BMP to C
14 converter. There are no common dialogs (we will use generic ones),
15 and only one WIN32 app may be run at a time.
16
17 Note that you can gain confidence in the WIN32/wxUniversal
18 combination by compiling wxUniversal under Windows using VC++,
19 using src/wxvc_universal.dsp. You can compile the minimal
20 and widgets samples in wxUniversal mode using the
21 UnivDebug and UnivRelease targets. Most of the code is shared
22 between this combination, and the wxMicroWindows port.
23
24 Installation
25 ============
26
27 MicroWindows:
28
29 - unarchive MicroWindows 0.89pre7
30
31 - change 'config' to use X11 and any other options you feel fit.
32   Suggestions for changes to the defaults:
33
34   ERASEMOVE=N (otherwise moving windows will look messy)
35   X11=Y
36   OPTIMIZE=N
37   DEBUG=Y
38   VERBOSE=Y
39
40 - apply microwindows.patches (from wxWindows:
41   docs/microwin/microwindows.patches) to fix PeekMessage
42   and other issues
43
44 - compile by typing 'make' from within the MicroWindows src directory
45
46 wxMicroWindows:
47
48 - untar the wxMicroWindows port/download from CVS
49
50 - change the TOP variable at the top of src/msw/makefile.mic
51   to reflect where MicroWindows is installed
52
53 - type 'make all' from src/msw. To clean, use cleanwx and NOT clean
54   since that will clean MicroWindows itself
55
56 - to make the sample, cd into samples/minimal, edit the TOP variable,
57   and type 'make all'
58
59 Running 'minimal' runs the virtual MicroWindows desktop
60 and the minimal sample, since in a MicroWindows WIN32 application
61 they are one and the same binary.
62
63 Status
64 ======
65
66 The minimal sample is almost fully-functional, apart from minor
67 menu presentation issues (no borders, for example).
68
69 Implementation Notes
70 ====================
71
72 wxMicroWindows is essentially the wxMSW port + wxUniversal
73 widgets. Lots of things in include/wx/univ/setup.h are switched
74 off to allow the port to compile. There are also #ifdefs
75 switching off further functionality, such as most wxBitmap
76 functions, pending proper implementation.
77
78 There are some WIN32 API functions not implemented by MicroWindows
79 that are instead stubbed out in include/wx/msw/microwin.c,
80 and 'implemented' in src/msw/microwin.c. Some of these functions
81 are important, some less so. They will need to be implemented
82 in due course. But implementing missing functionality in this way
83 is preferably to proliferating many #ifdefs in the
84 wxMSW/wxMicroWindows port itself.
85
86 Things missing from MicroWindows that need to be worked around
87 ==============================================================
88
89 No ::GetKeyState (see include/wx/msw/private.h). Should probably use
90 GdOpenKeyboard/GdCloseKeyboard/GdReadKeyboard. Could perhaps emulate
91 GetKeyState this way.
92
93 No ::CreateBitmap or BITMAPINFO. But BMPs can be converted
94 to C using convbmp, then need to use Gr... functions.
95 We MUST implement creation from XPMs, since wxUniversal
96 makes use of XPMs, or else create our own bitmaps for
97 drawing radioboxes, checkboxes etc.: see renderers
98 in src/univ.
99
100 No ::DestroyIcon, ::DestroyCursor - use ::DestroyObject instead?
101 Also no LoadCursor, LoadImage. So how do we make cursors? No ::SetCursor.
102
103 wxDC: no ::GetTextColor, ::GetBkColor, ::IntersectClipRect,
104 ::GetClipBox
105
106 No ::SetMenu, so no menus or menubars (now implemented by
107 wxUniversal).
108
109 No ::GetObject so we can't get LOGFONT from an HFONT
110 in wxSystemSettings (worked around by passing HFONT to
111 the wxFont constructor).
112