Plugin Development - Revision history

LeonBambrick: /* What is a TimeSnapper Plugin? */

2009-11-07T13:58:36Z

What is a TimeSnapper Plugin?

LeonBambrick: /* What plugins are available? */

2009-11-07T12:23:40Z

What plugins are available?

LeonBambrick: /* I have a great idea for a plugin. What do you think about this... ? */

2009-11-07T12:12:56Z

I have a great idea for a plugin. What do you think about this... ?

LeonBambrick: link to plugin ideas and contact page

2009-11-07T12:11:55Z

link to plugin ideas and contact page

Atlioddsson: /* What services does TimeSnapper provide to developers? */

2009-09-19T12:18:40Z

What services does TimeSnapper provide to developers?

Atlioddsson: /* What events can a plugin subscribe to? */

2009-09-19T12:17:06Z

What events can a plugin subscribe to?

Atlioddsson: /* How do I handle a TimeSnapper event? */

2009-09-19T12:08:14Z

How do I handle a TimeSnapper event?

LeonBambrick: /* Why do some of the events have 'Cancel' on the end of their name? */

2009-03-26T13:10:51Z

Why do some of the events have 'Cancel' on the end of their name?

Atlioddsson at 11:22, 21 March 2009

2009-03-21T11:22:35Z

Atlioddsson: /* How do I write a TimeSnapper Plugin? */

2009-03-21T11:20:13Z

How do I write a TimeSnapper Plugin?

@@ Line 1: / Line 1: @@
 == What is a TimeSnapper Plugin? ==
-A plugin is a way of extending and customizing the way TimeSnapper behaves.
+A plugin is a way of extending and customizing the way [http://timesnapper.com TimeSnapper] behaves.
 At the code level, it is a .net class that implements an interface (ITimeSnapperPlugin) that TimeSnapper will seek out talk to.

@@ Line 311: / Line 311: @@
 == What plugins are available? ==
+There are (at least) four plugins available currently. See [[Plugins]] for more information.
 == I have a great idea for a plugin. What do you think about this... ? ==

@@ Line 316: / Line 316: @@
 == I have a great idea for a plugin. What do you think about this... ? ==
-See [[Plugin_Ideas]] for some of the ideas we've developed or received so far. Add your own, or [[contact us:http://timesnapper.com/contact.aspx]] and tell us.
+See [[Plugin_Ideas]] for some of the ideas we've developed or received so far. Add your own, or [http://timesnapper.com/contact.aspx contact us] and tell us.
 [[Category:Plugins]]

@@ Line 300: / Line 300: @@
 You are most welcome to share your plugins!
-We intend to provide a gallery of plugins from on TimeSnapper.com, to encourage their usage, and I would like to further promote them on my blog at secretGeek.net.
+We intend to provide a gallery of plugins from TimeSnapper.com, to encourage their usage, and I would like to further promote them on my blog at secretGeek.net.
 It is still very early days, but we are hoping for some activity here.
@@ Line 313: / Line 313: @@
 See [[Plugins]] for more information.
 [[Category:Plugins]]

@@ Line 43: / Line 43: @@
 ** ShowNewFlagForm
 ** ShowForm(main | reports | timesheet | options | popup config | activitysearch)
 == Where can a plugin extend TimeSnapper's menus? ==

@@ Line 24: / Line 24: @@
 * When a snapshot has been deleted.
 * When the computer is idle.
 == Where can a plugin extend TimeSnapper's menus? ==

@@ Line 128: / Line 128: @@
 <source lang="csharp">
          object ITimeSnapperPlugin.HandleEvent
-                 (TimeSnapperEvent TimeSnapperEvent, EventArgs args)
+                 (ByVal timeSnapperEvent As TimeSnapperEvent, ByVal services As IServices, ByVal args As EventArgs)
+         {
              switch (TimeSnapperEvent)

@@ Line 178: / Line 178: @@
      public enum TimeSnapperEvent
+     {
-         SnapshotTaking'''Cancel''' = 0,
+         SnapshotTakingCancel = 0,
-         SnapshotTakenSaving'''Cancel''' = 1,
+         SnapshotTakenSavingCancel = 1,
          SnapshotSaved = 2,
-         AutoPoppingUp'''Cancel''' = 3,
+         AutoPoppingUpCancel = 3,
-         FlagSaving'''Cancel''' = 4,
+         FlagSavingCancel = 4,
          FlagSaved = 5,
          PluginsLoaded = 6,
          Closing = 7,
-         Archiving'''Cancel''' = 8,
+         ArchivingCancel = 8,
          Archived = 9,
-         SnapshotDeleting'''Cancel''' = 10,
+         SnapshotDeletingCancel = 10,
          SnapshotDeleted = 11,
+     }

@@ Line 97: / Line 97: @@
 So, if you want your plugin to subscribe to the "Flag Saved" event and the "Snapshot Saved" event, you would write this code:
          TimeSnapperEvent[] ITimeSnapperPlugin.SubscribesTo()
+         {
@@ Line 103: / Line 104: @@
                        TimeSnapperEvent.SnapshotSaved };
+         }
 == How do I add menu items to TimeSnapper? ==
@@ Line 116: / Line 118: @@
 In 'HandleEvent' you write a switch statement, (a Select case, in Visual Basic speak), with one case for each event you want to handle.
          Select Case TimeSnapperEvent
              Case TimeSnapperEvent.SnapshotSaved
                  MessageBox.Show("A snap shot saved!")
 Here's one for our example:
          object ITimeSnapperPlugin.HandleEvent
                  (TimeSnapperEvent TimeSnapperEvent, EventArgs args)
@@ Line 140: / Line 146: @@
              return null;
+         }
 == How can I let the end user configure my plugin? ==
@@ Line 147: / Line 154: @@
 Most simple plugins do not need any configuration by the end user, so their authors would simply return 'false' from this property, like so:
          bool ITimeSnapperPlugin.Configurable
+         {
              get { return false; }
+         }
 But if your Plugin is a little more complex, and requires the end user to configure it, you will want to return "true" from this property.
@@ Line 166: / Line 175: @@
 The full list of events you can subscribe to is provided in the enumeration TimeSnapperPluginAPI.TimeSnapperEvent and it looks like this:
      public enum TimeSnapperEvent
+     {
@@ Line 181: / Line 191: @@
          SnapshotDeleted = 11,
+     }
 Some events have the word 'Cancel' on the end of their name, because they are events that give you the opportunity to Cancel an activity from occuring.
@@ Line 196: / Line 208: @@
 Make sure the event is one of the ones that end in 'Cancel'. Cast it to a System.ComponentModel.CancelEventArgs, and set it's cancel property to true.
-−
          object ITimeSnapperPlugin.HandleEvent
                   (TimeSnapperEvent TimeSnapperEvent, EventArgs args)
@@ Line 206: / Line 219: @@
                      ((System.ComponentModel.CancelEventArgs)EventArgs).Cancel = true;
                      break;
 Here's a similar example in VB.net, where we stop a snap shot from being taken...
      Public Function HandleEvent(ByVal TimeSnapperEvent As TimeSnapperEvent, _
                        ByVal args As EventArgs) _
@@ Line 217: / Line 233: @@
                  realargs = CType(args, System.ComponentModel.CancelEventArgs)
                  realargs.Cancel = True 'Stop it from happening!
 == Can I download some sample code, in C#? ==

@@ Line 55: / Line 55: @@
 Give a suitable name to your class, and then implement "ITimeSnapperPlugin"
      using System;
      using TimeSnapperPluginAPI;
@@ Line 62: / Line 63: @@
          class AnotherPluginSample : ITimeSnapperPlugin
+         {
 Create a new guid. We'll use this to make sure our plugin doesn't clash with any other plugins.
@@ Line 68: / Line 70: @@
 Return the name of your plugin from the "Friendly Name" property getter:
          string ITimeSnapperPlugin.FriendlyName
+         {
              get { return "My Sample Plugin"; }
+         }
 Next, you should return a paragraph describing your plugin from the "Description" property getter.
+<source lang="csharp">
          string ITimeSnapperPlugin.Description
+         {
              get { return "This plugin demonstrates some of the ways that plugins work."; }
+         }
 The two properties above are used by TimeSnapper for providing information about the plugin, inside the 'Options' dialog: