Debian Codegraph @

templates/kioworker6/README.md

raw
1 KIO Worker Template
2 ----------------------
3
4 ### Build instructions
5
6 ```
7 cd /where/your/project/is/created
8 mkdir build
9 cd build
10 cmake \
11 -DKDE_INSTALL_PLUGINDIR=`kf5-config --qt-plugins` \
12 -DKDE_INSTALL_KSERVICESDIR=`kf5-config --install services` \
13 -DKDE_INSTALL_LOGGINGCATEGORIESDIR=`kf5-config --install data`qlogging-categories5 \
14 -DCMAKE_BUILD_TYPE=Release ..
15 make
16 make install
17 ```
18
19 After this you can test the new protocol with:
20 `kioclient 'ls' 'myproto:///'`
21 `kioclient 'cat' 'myproto:///Item A'`
22
23 You can also explore the new protocol with dolphin or konqueror:
24 `dolphin myproto:///`
25
26
27 ### Adaption instructions
28
29 Because the KAppTemplate format does not yet allow custom variables,
30 the template uses "myproto" in the generated sources as the initial name of the scheme.
31 Grep for all instances of that string in all files and replace it with the name of your scheme,
32 and rename the `myproto.protocol` file accordingly.
33
34 The class `MyDataSystem` just serves as a starting point to see something working right
35 after creating the project. Replace that class and the calls to it with code as needed to map
36 the KIO system to the actual data service/system your KIO worker is wrapping.
37
38
39 ### Related documentation
40
41 Find the documentation of `KIO::WorkerBase` for the API to implement at
42 https://api.kde.org/frameworks/kio/html/classKIO_1_1WorkerBase.html
43
44 Learn about debugging your new KIO worker at
45 https://community.kde.org/Guidelines_and_HOWTOs/Debugging/Debugging_KIO_Workers