summaryrefslogtreecommitdiff
path: root/libopie2/README
blob: 5643d25b47d02266ce10c2c01c539441f8e339ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/********************************************************************
/*     This is an overview of the opielibs2 project
/********************************************************************/

  Origin: opielibs is about creating classes to
          * optimize Qt classes for the embedded environment
          * provide sophisticated abstractions for developers
          * provide complete documentation and working examples
          * provide end users with a common look and feel
          * reduce memory footprint through sharing code
          * reduce possible bugs through reusing tested code
          * improve the architecture of applications with design patterns

--------------------------------------------------------
0. Building 
--------------------------------------------------------

* for QPE run:
	qmake libopie2.pro
	make

OR (even better)
	cd $OPIEDIR
	make menuconfig
	make -k

* for QT/X11 run:
	qmake "platform=x11" libopie2.pro
	make

Make sure you have set $PLATFORM=x86-linux

--------------------------------------------------------
1. General Overview
--------------------------------------------------------

libopie is functionally seperated into the following libraries:
 - libopiecore
 - libopieui
 - libopiepim
 - libopiedb
 - libopienet
 - libopiemm

1.1 Contents of libopiecore [ opiecore ]
--------------------------------------------------------

 - oapplication
 - ostorage

 - odbgstream
 - ondbgstream

 - oprocctrl
 - oprocess
 - odevice
 - odevicebutton

 - oconfig
 - oconfiggroupsaver

 - oglobal
 - oglobalsettings

1.2 Contents of libopieui [ opieui ]
--------------------------------------------------------

 - ofiledialog
 - oclickablelabel
 - ocolorbutton
 - otabinfo
 - otabbar
 - otabwidget
 - ofontmenu
 - ofontselector
 - ofileview
 - oticker

 - olistview
 - olistviewitem
 - oversatileview
 - oversatileviewitem

 - omessagebox
 - odialogbase

 - okeyconfigwidget
 - otaskbarapplet
 - otimepicker

1.3 Contents of libopiepim [ opiepim ]
--------------------------------------------------------

...

1.4 Contents of libopiedb [ opiedb ]
--------------------------------------------------------

...

1.5 Contents of libopienet [ opienet ]
--------------------------------------------------------

 - onetwork
 - onetworkinterface
 - owirelessnetworkinterface
 - ochannelhopper

 - omonitoring
 - ociscomonitoring
 - owlanngmonitoring
 - ohostapmonitoring
 - oorinocomonitoring

 - opacketcapturer
 - opacket
 - oethernetpacket
 - owavelanpacket
 - ollcpacket
 - oippacket
 - oudppacket
 - otcppacket

1.6 Contents of libopiemm [ opiemm ]
--------------------------------------------------------

 - osoundsystem
 - oaudiointerface
 - osoundserver

--------------------------------------------------------
2.0 Feature Description
--------------------------------------------------------

2.1 libopiecore

...

2.2 libopieui

...

2.3 libopiepim

...

2.4 libopiedb

...

2.5 libopienet

...

2.6 libopiemm

...

--------------------------------------------------------
3.0 Usage
--------------------------------------------------------

3.1 Namespaces