kdeconnect-kde/plugins
Alexander Lohnau 2e67f95017 Add explicit moc includes to cpp files
The rationale is explained in https://planet.kde.org/friedrich-kossebau-2023-06-28-include-also-moc-files-of-headers/

In case of KDEConnect, it impressively speeds up compilation. Before it
took 390 seconds on a clean build and with this change it took 330 seconds.
This is due to the mocs_compilation having to include the header files
and thus all their headers. Due to the lots of small plugins we have,
this means that the same headers must be compiled plenty of times.
When we include the moc files directly in the C++ file, they are already
available.
2023-07-30 07:27:45 +00:00
..
battery Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
bigscreen Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
clipboard Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
connectivity-report Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
contacts Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
findmyphone Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
findthisdevice Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
lockdevice Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
mmtelephony Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
mousepad Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
mpriscontrol Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
mprisremote Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
notifications Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
pausemusic Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
photo Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
ping Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
presenter Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
remotecommands Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
remotecontrol Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
remotekeyboard Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
remotesystemvolume Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
runcommand Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
screensaver-inhibit Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
sendnotifications Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
sftp Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
share Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
sms Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
systemvolume Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
telephony Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
virtualmonitor Add explicit moc includes to cpp files 2023-07-30 07:27:45 +00:00
CMakeLists.txt Use versionless cmake variable for KF requirements 2023-07-25 18:29:38 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2023-07-30 01:37:54 +00:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Fix file name on plugin's readme. 2022-11-27 01:40:51 +00:00

Writing a plugin for KDE Connect
=================================

For the desktop client (this project):
--------------------------------------

1. Enter the "plugins" directory.
2. Copy the "ping" under a different name ("findmyphone" in this example).
3. Add "add_subdirectory(findmyphone)" to CMakeLists.txt after the others "add_subdirectory".
4. Enter the new "findmyphone" directory.
5. Edit CMakeLists.txt by replacing "ping" with "findmyphone".
6. Rename other files in this directory by replacing "ping" with "findmyphone"
7. Write a description of your plugin into "README"
8. Edit findmyphoneplugin.cpp and findmyphoneplugin.h.
  A. Change license header.
  B. Replace (case sensitive) "ping" with "findmyphone", "PingPlugin" with "FindMyPhonePlugin" and "PING" with "FINDMYPHONE".
9. Edit kdeconnect_findmyphone.json file:
  A. Replace "ping" with "findmyphone".
  B. Change name, description, icon, author, email, version, website, license info.
  C. Remove all the translations
  D. Set X-KDEConnect-SupportedPacketType and X-KDEConnect-OutgoingPacketType to the packet type your plugin will receive
     and send, respectively. In this example this is "kdeconnect.findmyphone". Make sure that this matches what is defined in
     the findmyphoneplugin.h file (in the line "#define PACKET_TYPE_..."), and also in Android.
10. Now you have an empty skeleton to implement your new plugin logic.

For Android (project kdeconnect-android):
-----------------------------------------

1. Change directory to src/org/kde/kdeconnect/Plugins.
2. Copy "PingPlugin" under a different name ("FindMyPhonePlugin" in this example).
3. Enter the new "FindMyPhonePlugin" directory.
4. Rename "PingPlugin.java" to "FindMyPhonePlugin.java"
5. Edit it. Replace (case sensitive) "Ping" with "FindMyPhone", "ping" with "findmyphone", "PING" with "FINDMYPHONE"
   and "plugin_ping" with "plugin_findmyphone".
6. Open res/values/strings.xml. Find and copy the lines "pref_plugin_ping_desc" and "pref_plugin_ping" replacing "ping"
   with "findmyphone" and edit the plugin name and description between <string> </string>).
7. Now you have an empty skeleton to implement your new plugin logic.