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