/usr/share/doc/launchy/api.html is in launchy 2.5-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | <html>
<head>
<meta http-equiv=Content-Type content="text/html; charset=windows-1252">
<meta name=Generator content="Microsoft Word 11 (filtered)">
<title>Launchy 2</title>
<style>
<!--
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Times New Roman";}
h1
{margin-top:12.0pt;
margin-right:0in;
margin-bottom:3.0pt;
margin-left:0in;
page-break-after:avoid;
font-size:16.0pt;
font-family:Arial;
font-weight:bold;}
h3
{margin-top:12.0pt;
margin-right:0in;
margin-bottom:3.0pt;
margin-left:0in;
page-break-after:avoid;
font-size:13.0pt;
font-family:Arial;
font-weight:bold;}
a:link, span.MsoHyperlink
{color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{color:purple;
text-decoration:underline;}
p
{margin-right:0in;
margin-left:0in;
font-size:12.0pt;
font-family:"Times New Roman";}
@page Section1
{size:8.5in 11.0in;
margin:1.0in 1.25in 1.0in 1.25in;}
div.Section1
{page:Section1;}
/* List Definitions */
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
-->
</style>
</head>
<body lang=EN-US link=blue vlink=purple>
<div class=Section1>
<h1 align=center style='text-align:center'>Launchy 2.0 Plugin API Documentation</h1>
<h3 align=center style='text-align:center'>Josh Karlin</h3>
<p class=MsoNormal> </p>
<p class=MsoNormal><a href="#_Setting_up_the">Setting up the build environment</a></p>
<p class=MsoNormal><a href="#_Building_your_first">Building your first plugin</a></p>
<p class=MsoNormal><a href="#_Editing_the_plugin">Editing the plugin</a></p>
<p class=MsoNormal><a href="#_Distributing_your_plugin">Distributing your
plugin</a></p>
<p class=MsoNormal> </p>
<p class=MsoNormal><a href="http://www.launchy.net/api2.0/plugin.zip">Skeleton
Plugin</a></p>
<p class=MsoNormal><a href="doxydoc/plugin__interface_8h.html">Doxygen
Documentation</a></p>
<p class=MsoNormal> </p>
<h3>Introduction</h3>
<p class=MsoNormal> </p>
<p class=MsoNormal>By itself, Launchy can only index regular windows files such
as mp3's, documents, links etc. There are infinitely more things that the
simple Launchy interface could be used for, e.g. as a calculator, browser
launcher, directory walker, etc.</p>
<p>Launchy's interface is broken down into a user input window and a program
output window. As the user enters input, the items are matched against
Launchy's index of objects and the best matching object's display name is
displayed in the output window. If the user presses the enter key then the object
is launched by the object's owner. If the user presses the TAB key then the
owner is asked to provide a new set of objects.</p>
<p class=MsoNormal>In this document, I describe how plugins can be developed to
add new types of objects to the catalog and take control of the execution of
existing ones.</p>
<p class=MsoNormal> </p>
<p class=MsoNormal> </p>
<h3><a name="_Setting_up_the"></a>Setting up the build environment</h3>
<p class=MsoNormal>For this setup, we require Visual Studio (preferably 2005 as
that is what I use) and QT 4.3.3.� I will assume that you already have Visual
Studio installed but not the QT developer environment.</p>
<p class=MsoNormal> </p>
<p class=MsoNormal><i>Installing QT</i></p>
<p class=MsoNormal> </p>
<p class=MsoNormal>Download the open source windows version of QT version here:
<a href="http://trolltech.com/developer/downloads/qt/windows">QT download</a>�
Don�t get the mingw build, you just want the source zip file.� I recommend
finding version 4.3.3 as that is compatible with Launchy 2.0+� All Launchy�s
2.1+ are compatible with 4.4.0+.</p>
<p class=MsoNormal> </p>
<p class=MsoNormal>Unzip the file and rename the directory to 4.x.x� (replace
the x�s with your downloaded version number).� Then place 4.x.x into c:\qt\ so
that you have a c:\qt\4.x.x\ directory.</p>
<p class=MsoNormal> </p>
<p class=MsoNormal>Add 2 environment variables (under control
panel->system->advanced->environment variables)</p>
<ol style='margin-top:0in' start=1 type=1>
<li class=MsoNormal>QMAKESPEC = win32-msvc2005</li>
<li class=MsoNormal>QTDIR = c:\qt\4.x.x</li>
</ol>
<p class=MsoNormal> </p>
<p class=MsoNormal>From Launchy or your start menu, run the �Visual Studio 2005
Command Prompt�</p>
<p class=MsoNormal> </p>
<p class=MsoNormal>From the command prompt type the following (this takes
awhile to finish):</p>
<p class=MsoNormal> </p>
<p class=MsoNormal>cd c:\qt\4.x.x</p>
<p class=MsoNormal>configure �debug-and-release �no-stl �no-qt3support</p>
<p class=MsoNormal>nmake</p>
<p class=MsoNormal>Okay, now QT is built.� Note in c:\qt\4.x.x\bin there are a
bunch of useful utilities.� The dll�s that comprise the QT library are in there
as well as the excellent QT documentation in a program called �assistant.exe�.�
</p>
<p class=MsoNormal> </p>
<p class=MsoNormal> </p>
<p class=MsoNormal><i> </i></p>
<h3><a name="_Building_your_first"></a>Building your first plugin</h3>
<p class=MsoNormal>Download the plugin skeleton <a
href="http://www.launchy.net/api2.0/plugin.zip">here</a>.� This includes a
blank plugin, all of the necessary header files, and a visual studio project
designed for compilation with QT�s qmake.� Note that you need to edit
�myplugin.pro� when adding or removing files from your project.</p>
<p class=MsoNormal> </p>
<p class=MsoNormal>Please download and extract the plugin skeleton.� Ensure
that your %QTDIR% variable is properly set and then restart visual studio.� Now
open the plugin project.� It should build with some compile warnings (due to
empty functions).� Your compiled Launchy plugin is in debug\myplugin.dll</p>
<p class=MsoNormal> </p>
<p class=MsoNormal> </p>
<h3><a name="_Editing_the_plugin"></a>Editing the plugin</h3>
<p class=MsoNormal>Launchy deals solely with the plugin�s �msg� function.� Msg
then dispatches incoming events to appropriate event handlers.� The �msg�
function should return true if the event was handled, and false otherwise.</p>
<p class=MsoNormal> </p>
<p class=MsoNormal>The first thing to change about your new plugin is its
name.� In �myplugin.h� there is a line: #define PLUGIN_NAME
"MyPlugin".� You should replace �MyPlugin� with the name that you
desire.� Next, you should proceed to fill out any of the necessary event
functions that you require.� To do this, you need example code and documentation
about the specifics events.</p>
<p class=MsoNormal> </p>
<p class=MsoNormal>For example plugins, please refer to the source code of the
plugins that are shipped with Launchy.� The code can be browsed via the svn
repository <a
href="http://launchy.svn.sourceforge.net/viewvc/launchy/trunk/Launchy_QT/plugins/">here</a>.�
When browsing the code, don�t click on the file name, click on the revision
number.� That will show you all of the file�s contents for the given revision.�
</p>
<p class=MsoNormal> </p>
<p class=MsoNormal>For event documentation, please refer to the doxygen <a
href="doxydoc/plugin__interface_8h.html">documentation</a>.</p>
<p class=MsoNormal> </p>
<h3><a name="_Distributing_your_plugin"></a>Running your plugin</h3>
<p class=MsoNormal>First, make sure your plugin has an icon!� This icon should
go into Launchy\plugins\icons\. �Next, make sure your code points to this icon
in your �getIcon� function.� Finally, copy your plugin�s compiled .dll file to
the Launchy\plugins directory and restart Launchy.� Good luck!</p>
</div>
</body>
</html>
|