Context Navigation

Changes between Version 7 and Version 8 of DbusHowto

Timestamp:: Nov 3, 2013, 3:12:42 AM (10 years ago)
Author:: MarkDoliner
Comment:: Make inter-wiki links relative (and especially don't link to http, since we always redirect http to https).

Legend:

: Unmodified
: Added
: Removed
: Modified

DbusHowto

-                      v7
+                      v8
 [Note that the signal is called "received-im-msg" in the Pidgin documentation but the D-Bus signal is called "!ReceivedImMsg"; do this simple transformation for all signals you see.]
 This registers a function, called `my_func`, which will be called when the signal is emitted. Now you look up the documentation to see what parameters come with the signal, and you define `my_func` to work on those parameters. In this case, the [http://developer.pidgin.im/doxygen/dev2.x.y/html/conversation-signals.html#received-im-msg documentation] tells you that the parameters are (account, sender, message, conversation, flags), so you define `my_func` accordingly:
+This registers a function, called `my_func`, which will be called when the signal is emitted. Now you look up the documentation to see what parameters come with the signal, and you define `my_func` to work on those parameters. In this case, the [/doxygen/dev2.x.y/html/conversation-signals.html#received-im-msg documentation] tells you that the parameters are (account, sender, message, conversation, flags), so you define `my_func` accordingly:
 {{{
 #!python
 …
 But you get the idea.
 Here's a sample list of signals you can receive. For the full list, look in pages named "Signals" in the [http://developer.pidgin.im/doxygen/dev2.x.y/html/pages.html list of documentation pages].
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/account-signals.html Account signals]:
+Here's a sample list of signals you can receive. For the full list, look in pages named "Signals" in the [/doxygen/dev2.x.y/html/pages.html list of documentation pages].
+ * [/doxygen/dev2.x.y/html/account-signals.html Account signals]:
     * account-status-changed, account-connecting, account-error-changed, account-authorization-requested
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/blist-signals.html Buddy list signals]:
+ * [/doxygen/dev2.x.y/html/blist-signals.html Buddy list signals]:
     * buddy-status-changed, buddy-idle-changed, buddy-signed-on, buddy-signed-off, buddy-icon-changed
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/connection-signals.html Connection signals]:
+ * [/doxygen/dev2.x.y/html/connection-signals.html Connection signals]:
     * signing-on, signed-on, signing-off, signed-off, connection-error
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/conversation-signals.html Conversation signals]:
+ * [/doxygen/dev2.x.y/html/conversation-signals.html Conversation signals]:
     * These are emitted for events related to conversations you are having. Note that in Pidgin, "im" means a conversation with one person, and "chat" means a conversation with several people.
     *  writing-im-msg, wrote-im-msg,
 …
     *  conversation-created, conversation-updated, deleting-conversation,
     *  conversation-extended-menu
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/core-signals.html Core signals]:
+ * [/doxygen/dev2.x.y/html/core-signals.html Core signals]:
     * quitting
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/gtkconv-signals.html GtkConv signals]:
+ * [/doxygen/dev2.x.y/html/gtkconv-signals.html GtkConv signals]:
     *  displaying-im-msg, displayed-im-msg,
     *  displaying-chat-msg, displayed-chat-msg,
     *  conversation-switched,
     *  conversation-hiding, conversation-displayed
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/gtkimhtml-signals.html GtkIMHTML signals]:
+ * [/doxygen/dev2.x.y/html/gtkimhtml-signals.html GtkIMHTML signals]:
     * GtkIMHTML is the widget used for the input area in Pidgin
     * url_clicked, format_buttons_update, format_function_clear, format_function_toggle, format_function_update
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/notify-signals.html Notification signals]:
+ * [/doxygen/dev2.x.y/html/notify-signals.html Notification signals]:
     * displaying-userinfo, displaying-email-notification, displaying-emails-notification
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/plugin-signals.html Plugin signals]:
+ * [/doxygen/dev2.x.y/html/plugin-signals.html Plugin signals]:
     * plugin-load, plugin-unload
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/savedstatus-signals.html Saved status signals]:
+ * [/doxygen/dev2.x.y/html/savedstatus-signals.html Saved status signals]:
     * savedstatus-changed
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/sound-signals.html Sound signals]:
+ * [/doxygen/dev2.x.y/html/sound-signals.html Sound signals]:
     * playing-sound-event
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/xfer-signals.html File transfer signals]:
+ * [/doxygen/dev2.x.y/html/xfer-signals.html File transfer signals]:
     * file-recv-complete, file-recv-request, file-send-accept, file-send-start, file-send-cancel, file-send-complete
 …
 Your registered callback function in a plugin might also have an effect on Pidgin by changing the values of parameters it gets.
 You can't do any of this in a D-Bus script. Look at [http://developer.pidgin.im/doxygen/dev2.x.y/html/signal-howto.html Signals HOWTO] to see how to use signals in plugins.
+You can't do any of this in a D-Bus script. Look at [/doxygen/dev2.x.y/html/signal-howto.html Signals HOWTO] to see how to use signals in plugins.
 Even with read-only plugins, there is a lot you can do:
 …
 And this still does unexpected things when your current status is a complex one.
 The only reference for the available functions is the [http://developer.pidgin.im/doxygen/dev2.x.y/html/files.html documentation for the header files], so you want to look there to figure out which functions you need to call.
+The only reference for the available functions is the [/doxygen/dev2.x.y/html/files.html documentation for the header files], so you want to look there to figure out which functions you need to call.
 Here are a few of the useful ones:
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/account_8h.html Your accounts]:
+ * [/doxygen/dev2.x.y/html/account_8h.html Your accounts]:
    * Get a particular account: `PurpleAccountsFind(name, protocol)`
    * Get all active accounts: `PurpleAccountsGetAllActive()`
 …
    * Set its icon: `PurpleAccountSetBuddyIconPath(account, path)`
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/blist_8h.html Your buddies]:
+ * [/doxygen/dev2.x.y/html/blist_8h.html Your buddies]:
    * Get list of all buddies: `PurpleFindBuddies(account,screenname)` [Second argument NULL, to search for all]
    * Get a particular buddy: `PurpleFindBuddy(account, screenname)`
 …
    * Get the account a buddy belongs to: `PurpleBuddyGetAccount(buddy)`
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/savedstatuses_8h.html Your own status] ([http://developer.pidgin.im/doxygen/dev2.x.y/html/status_8h.html also]):
+ * [/doxygen/dev2.x.y/html/savedstatuses_8h.html Your own status] ([/doxygen/dev2.x.y/html/status_8h.html also]):
    * Some constants you can't get through the D-Bus interface yet:
 {{{
 …
    * Actually set the status with: `PurpleSavedstatusActivate(status)`
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/conversation_8h.html Your conversations]:
+ * [/doxygen/dev2.x.y/html/conversation_8h.html Your conversations]:
    * Get all conversations: `PurpleGetConversations()`
    * Get all IMs: `PurpleGetIms()`
 …
    * Send an IM message with: `PurpleConvImSend(im, message)`
  * [http://developer.pidgin.im/doxygen/dev2.x.y/html/prefs_8h.html Preferences]:
+ * [/doxygen/dev2.x.y/html/prefs_8h.html Preferences]:
    * Get a preference: `PurplePrefsGetBool`, `PurplePrefsGetString`, etc.
    * Set a preference: `PurplePrefsSetInt`, `PurplePrefsSetPath`, etc.
 There are other things you can do; see the [http://developer.pidgin.im/doxygen/dev2.x.y/html/main.html documentation] and the source files.
+There are other things you can do; see the [/doxygen/dev2.x.y/html/main.html documentation] and the source files.
 == Further reading ==