Re: Progress on issue tracker COM interface (was: Re: Licensing of COM interface definitions of TortoiseSVN?)

Hi Roger,

There is a summary in here from the viewpoint of the plugin
implementer. It would be worth adding this to the docs in the contrib
folder as there seems to be no general overview of what the plugin is
actually trying to achieve there.

Simon

2008/4/27 Roger Lipscombe <roger_at_differentpla.net>:
>
> In broad strokes, to write an integration plugin, you implement the
> IBugTraqProvider COM interface, and register your object as implementing the
> "TortoiseSVN BugTraq Providers" component category. This registration makes
> it easy for the settings dialog to find a list of available plugins.
>
> The IBugTraqProvider interface is extremely simple. It has three methods:
>
> - GetLinkText(HWND hParentWnd, BSTR parameters, [retval] BSTR *linkText)
> This is called when the commit dialog needs some text to put on the
> hyperlink control. It should assume the current thread locale for l10n
> purposes. It gets passed the parameters in case the URL (e.g.) makes a
> difference to the text to be displayed. It has hParentWnd in case it needs
> to display an error message (although this is not recommended, because it
> will break the user's flow). The text to be displayed is returned in
> linkText.
>
> - GetCommitMessage(HWND hParentWnd, BSTR parameters, BSTR originalMessage,
> [retval] BSTR *newMessage);
> This is called when you click on the hyperlink in the commit dialog. It gets
> passed the HWND of the commit dialog, the arbitrary parameter string, the
> current message that's in the commit dialog. It returns a new string to put
> in the commit dialog. The plugin is responsible for the decision about
> prepending, appending or replacing the text entirely.
>
> - ValidateParameters(HWND hParentWnd, BSTR parameters, [retval] VARIANT_BOOL
> *valid);
> This is called from the settings dialog. This allows the provider to check
> that the parameters are OK. It can do basic syntax checking, it can check
> that the server is reachable, or it can do nothing. Again, it gets an HWND.
> The provider must display its own error message boxes, using this as the
> parent.
>
> And that's it.

Simon

-- 
: ___
: oo // \\ "De Chelonian Mobile"
: (_,\/ \_/ \ TortoiseSVN
: \ \_/_\_/> The coolest Interface to (Sub)Version Control
: /_/ \_\ http://tortoisesvn.net
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe_at_tortoisesvn.tigris.org
For additional commands, e-mail: dev-help_at_tortoisesvn.tigris.org