kdeconnect-kde

History

Jean Vincent 72535ecf48 Make member variable names, & placement and * placement more coherent Summary: Change all member variables to the form m_fooBar because it is the preferred form in Qt (it was half and half between this and mFooBar, and a minority didn't have anything). Place all references and pointers on the side of the type since it is the majority. Basically: - mFoo -> m_foo - foo -> m_foo (if it is a member variable) - Type &ref -> Type& ref - Type ptr -> Type ptr Reviewers: #kde_connect, nicolasfella, albertvaka Reviewed By: #kde_connect, nicolasfella, albertvaka Subscribers: albertvaka, #kde_connect Tags: #kde_connect Differential Revision: https://phabricator.kde.org/D7312		2017-09-03 21:45:08 +02:00
..
battery	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
clipboard	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
findmyphone	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
lockdevice	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
mousepad	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
mousepad_windows	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
mpriscontrol	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
mprisremote	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
notifications	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
pausemusic	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
ping	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
remotecommands	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
remotecontrol	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
remotekeyboard	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
runcommand	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
screensaver-inhibit	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
sendnotifications	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
sftp	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
share	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
telephony	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
CMakeLists.txt	Initial mousepad (remote input) plugin implementation for windows	2017-06-29 01:57:46 +02:00
kdeconnect.notifyrc	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
kdeconnect_plugin.desktop	Make member variable names, & placement and * placement more coherent	2017-09-03 21:45:08 +02:00
Messages.sh	Figure out Messages.sh after code refactoring	2014-06-17 18:45:47 +02:00
README.txt	Added a README about how to create a plugin.	2014-12-21 19:37:41 -08:00

README.txt

Writting 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".
1. 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.desktop 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-SupportedPackageType and X-KDEConnect-OutgoingPackageType to the package 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 findmyplugin.h file (in the line "#define PACKAGE_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).
1. 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. Open src/org/kde/kdeconnect/Plugins/PluginFactory.java.
  A. Copy "import … PingPlugin" line with replacing "PingPlugin" with "FindMyPhonePlugin".
  B. Copy "PluginFactory.registerPlugin(PingPlugin.class);" line with replacing "PingPlugin" with "FindMyPhonePlugin".
8. Open src/org/kde/kdeconnect/NetworkPackage.java. Copy a "public final static String PACKAGE_TYPE_PING = …" line
   replacing "PING" with the package type you will be using (should match the desktop client).
9. Now you have an empty skeleton to implement your new plugin logic.