-rw-r--r-- | libopie2/README | 57 |
1 files changed, 17 insertions, 40 deletions
diff --git a/libopie2/README b/libopie2/README index daf6b27..5643d25 100644 --- a/libopie2/README +++ b/libopie2/README | |||
@@ -1,188 +1,165 @@ | |||
1 | /******************************************************************** | 1 | /******************************************************************** |
2 | /* This is an overview of the opielibs2 project | 2 | /* This is an overview of the opielibs2 project |
3 | /********************************************************************/ | 3 | /********************************************************************/ |
4 | 4 | ||
5 | Origin: opielibs is about creating classes to | 5 | Origin: opielibs is about creating classes to |
6 | * optimize Qt classes for the embedded environment | 6 | * optimize Qt classes for the embedded environment |
7 | * provide sophisticated abstractions for developers | 7 | * provide sophisticated abstractions for developers |
8 | * provide complete documentation and working examples | 8 | * provide complete documentation and working examples |
9 | * provide end users with a common look and feel | 9 | * provide end users with a common look and feel |
10 | * reduce memory footprint through sharing code | 10 | * reduce memory footprint through sharing code |
11 | * reduce possible bugs through reusing tested code | 11 | * reduce possible bugs through reusing tested code |
12 | * improve the architecture of applications with design patterns | ||
12 | 13 | ||
13 | -------------------------------------------------------- | 14 | -------------------------------------------------------- |
14 | 0. Building | 15 | 0. Building |
15 | -------------------------------------------------------- | 16 | -------------------------------------------------------- |
16 | 17 | ||
17 | * for QPE run: | 18 | * for QPE run: |
18 | qmake libopie2.pro | 19 | qmake libopie2.pro |
19 | make | 20 | make |
20 | 21 | ||
21 | OR (even better) | 22 | OR (even better) |
22 | cd $OPIEDIR | 23 | cd $OPIEDIR |
23 | make menuconfig | 24 | make menuconfig |
24 | make -k | 25 | make -k |
25 | 26 | ||
26 | * for QT/X11 run: | 27 | * for QT/X11 run: |
27 | qmake "platform=x11" libopie2.pro | 28 | qmake "platform=x11" libopie2.pro |
28 | make | 29 | make |
29 | 30 | ||
30 | Make sure you have set $PLATFORM=x86-linux | 31 | Make sure you have set $PLATFORM=x86-linux |
31 | 32 | ||
32 | -------------------------------------------------------- | 33 | -------------------------------------------------------- |
33 | 1. General Overview | 34 | 1. General Overview |
34 | -------------------------------------------------------- | 35 | -------------------------------------------------------- |
35 | 36 | ||
36 | libopie is functionally seperated into the following libraries: | 37 | libopie is functionally seperated into the following libraries: |
37 | - libopiecore | 38 | - libopiecore |
38 | - libopieui | 39 | - libopieui |
39 | - libopiepim | 40 | - libopiepim |
40 | - libopiedb | 41 | - libopiedb |
41 | - libopienet | 42 | - libopienet |
42 | - libopiemm | 43 | - libopiemm |
43 | 44 | ||
44 | 1.1 Contents of libopiecore [ opiecore ] | 45 | 1.1 Contents of libopiecore [ opiecore ] |
45 | -------------------------------------------------------- | 46 | -------------------------------------------------------- |
46 | 47 | ||
48 | - oapplication | ||
49 | - ostorage | ||
50 | |||
47 | - odbgstream | 51 | - odbgstream |
48 | - ondbgstream | 52 | - ondbgstream |
49 | 53 | ||
50 | - oprocctrl | 54 | - oprocctrl |
51 | - oprocess | 55 | - oprocess |
52 | - odevice | 56 | - odevice |
53 | - odevicebutton | 57 | - odevicebutton |
54 | 58 | ||
55 | - oconfig | 59 | - oconfig |
56 | - oconfiggroupsaver | 60 | - oconfiggroupsaver |
57 | 61 | ||
58 | - ocompletionbase | ||
59 | - ocompletion | ||
60 | - ocomptreenodelist | ||
61 | - ocomptreenode | ||
62 | - ocompletionwrapper | ||
63 | |||
64 | - oglobal | 62 | - oglobal |
65 | - oglobalsettings | 63 | - oglobalsettings |
66 | 64 | ||
67 | - osortableitem | ||
68 | - osortablevaluelist | ||
69 | |||
70 | 1.2 Contents of libopieui [ opieui ] | 65 | 1.2 Contents of libopieui [ opieui ] |
71 | -------------------------------------------------------- | 66 | -------------------------------------------------------- |
72 | 67 | ||
73 | - oapplication | ||
74 | |||
75 | - ofiledialog | 68 | - ofiledialog |
76 | - colordialog | ||
77 | - oclickablelabel | 69 | - oclickablelabel |
78 | - ocolorbutton | 70 | - ocolorbutton |
79 | - colorpopupmenu | ||
80 | - otabinfo | 71 | - otabinfo |
81 | - otabbar | 72 | - otabbar |
82 | - otabwidget | 73 | - otabwidget |
83 | - ofontmenu | 74 | - ofontmenu |
84 | - ofontselector | 75 | - ofontselector |
85 | - ofileview | 76 | - ofileview |
86 | - oticker | 77 | - oticker |
87 | 78 | ||
88 | - olistview | 79 | - olistview |
89 | - olistviewitem | 80 | - olistviewitem |
90 | - oversatileview | 81 | - oversatileview |
91 | - oversatileviewitem | 82 | - oversatileviewitem |
92 | - ocompletionbox | ||
93 | - olineedit | ||
94 | - ocombobox | ||
95 | - ohistorycombo | ||
96 | 83 | ||
97 | - omessagebox | 84 | - omessagebox |
98 | - odialogbase | 85 | - odialogbase |
99 | 86 | ||
100 | - todayconfigwidget (rather into opiepim?) | 87 | - okeyconfigwidget |
101 | - orecurrancewidget (rather into opiepim?) | 88 | - otaskbarapplet |
102 | - otimepicker (rather into opiepim?) | 89 | - otimepicker |
103 | 90 | ||
104 | 1.3 Contents of libopiepim [ opiepim ] | 91 | 1.3 Contents of libopiepim [ opiepim ] |
105 | -------------------------------------------------------- | 92 | -------------------------------------------------------- |
106 | 93 | ||
107 | - ocheckitem | 94 | ... |
108 | - todayplugininterface | ||
109 | |||
110 | THIS STUFF IS OUTDATED/DEPRICATED AND SCHOULD NOT | ||
111 | BE MOVED IN THE NEW LIBRARY !! | ||
112 | USE THE CLASSES IN libopie/pim INSTEAD !(eilers) | ||
113 | |||
114 | - todoresource | ||
115 | - todoevent | ||
116 | - todovcalresource | ||
117 | 95 | ||
118 | 1.4 Contents of libopiedb [ opiedb ] | 96 | 1.4 Contents of libopiedb [ opiedb ] |
119 | -------------------------------------------------------- | 97 | -------------------------------------------------------- |
120 | 98 | ||
121 | - xmltree | 99 | ... |
122 | |||
123 | THIS STUFF IS OUTDATED/DEPRICATED AND SCHOULD NOT | ||
124 | BE MOVED IN THE NEW LIBRARY !! | ||
125 | USE THE CLASSES IN libopie/pim INSTEAD !(eilers) | ||
126 | - tododb | ||
127 | 100 | ||
128 | 1.5 Contents of libopienet [ opienet ] | 101 | 1.5 Contents of libopienet [ opienet ] |
129 | -------------------------------------------------------- | 102 | -------------------------------------------------------- |
130 | 103 | ||
131 | - onetwork | 104 | - onetwork |
132 | - onetworkinterface | 105 | - onetworkinterface |
133 | - owirelessnetworkinterface | 106 | - owirelessnetworkinterface |
134 | - ochannelhopper | 107 | - ochannelhopper |
135 | 108 | ||
136 | - omonitoring | 109 | - omonitoring |
137 | - ociscomonitoring | 110 | - ociscomonitoring |
138 | - owlanngmonitoring | 111 | - owlanngmonitoring |
139 | - ohostapmonitoring | 112 | - ohostapmonitoring |
140 | - oorinocomonitoring | 113 | - oorinocomonitoring |
141 | 114 | ||
142 | - opacketcapturer | 115 | - opacketcapturer |
143 | - opacket | 116 | - opacket |
144 | - oethernetpacket | 117 | - oethernetpacket |
145 | - owavelanpacket | 118 | - owavelanpacket |
146 | - ollcpacket | 119 | - ollcpacket |
147 | - oippacket | 120 | - oippacket |
148 | - oudppacket | 121 | - oudppacket |
149 | - otcppacket | 122 | - otcppacket |
150 | 123 | ||
151 | <libmail stuff> | ||
152 | <libbend stuff> | ||
153 | <libftp stuff> | ||
154 | |||
155 | 1.6 Contents of libopiemm [ opiemm ] | 124 | 1.6 Contents of libopiemm [ opiemm ] |
156 | -------------------------------------------------------- | 125 | -------------------------------------------------------- |
157 | 126 | ||
158 | - osoundsystem | 127 | - osoundsystem |
159 | - oaudiointerface | 128 | - oaudiointerface |
160 | - osoundserver | 129 | - osoundserver |
161 | 130 | ||
162 | -------------------------------------------------------- | 131 | -------------------------------------------------------- |
163 | 2.0 Feature Description | 132 | 2.0 Feature Description |
164 | -------------------------------------------------------- | 133 | -------------------------------------------------------- |
165 | 134 | ||
166 | 2.1 libopiecore | 135 | 2.1 libopiecore |
167 | 136 | ||
168 | ... | 137 | ... |
169 | 138 | ||
170 | 2.2 libopieui | 139 | 2.2 libopieui |
171 | 140 | ||
172 | ... | 141 | ... |
173 | 142 | ||
174 | 2.3 libopiepim | 143 | 2.3 libopiepim |
175 | 144 | ||
176 | ... | 145 | ... |
177 | 146 | ||
178 | 2.4 libopiedb | 147 | 2.4 libopiedb |
179 | 148 | ||
180 | ... | 149 | ... |
181 | 150 | ||
182 | 2.5 libopienet | 151 | 2.5 libopienet |
183 | 152 | ||
184 | ... | 153 | ... |
185 | 154 | ||
186 | 2.6 libopiemm | 155 | 2.6 libopiemm |
187 | 156 | ||
188 | ... | 157 | ... |
158 | |||
159 | -------------------------------------------------------- | ||
160 | 3.0 Usage | ||
161 | -------------------------------------------------------- | ||
162 | |||
163 | 3.1 Namespaces | ||
164 | |||
165 | |||