~neon/pykde4/master

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#KTE_INTERNAL_setupIntialValues">KTE_INTERNAL_setupIntialValues</a> (self, QString templateString, {QString:QString} initialValues)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertTemplateText">insertTemplateText</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> insertPosition, QString templateString, {QString:QString} initialValues)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertTemplateTextImplementation">insertTemplateTextImplementation</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> insertPosition, QString templateString, {QString:QString} initialValues)</td></tr>

<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#expandMacros">expandMacros</a> ({QString:QString} initialValues, QWidget parentWindow)</td></tr>

</table>

<hr><h2>Method Documentation</h2><a class="anchor" name="TemplateInterface"></a>

</tr>

</table>

</div>

<td class="memname">bool KTE_INTERNAL_setupIntialValues</td>

</tr><tr>

<td class="paramtype">QString </td>

<td class="paramname"><em>templateString</em>, </td>

</tr>

<tr>

<td class="paramtype">{QString:QString} </td>

<td class="paramname"><em>initialValues</em></td>

</tr>

<tr>

100

101

102

103

104

105

</tr></table>

106

</div>

107

<div class="memdoc"><p>DO NOT USE !!!! THIS IS USED INTERNALLY by the interface only !!!!!!

108

Behaviour might change !!!!!!!

109

</p></div></div><a class="anchor" name="insertTemplateText"></a>

110

111

112

113

<td class="memname">bool insertTemplateText</td>

114

115

116

117

</tr><tr>

118

119

120

<td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td>

121

<td class="paramname"><em>insertPosition</em>, </td>

122

</tr>

123

<tr>

124

125

126

<td class="paramtype">QString </td>

127

<td class="paramname"><em>templateString</em>, </td>

128

</tr>

129

<tr>

130

131

132

<td class="paramtype">{QString:QString} </td>

133

<td class="paramname"><em>initialValues</em></td>

134

</tr>

135

<tr>

136

137

138

139

140

141

</tr></table>

142

</div>

143

<div class="memdoc"><p>Inserts an interactive ediable template text at line "line", column "col".

144

<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if inserting the string succeeded

145

</dd></dl> </p>

146

<p>

147

Use insertTemplateText(lines(), ...) to append text at end of document

148

Template strings look like

149

"for( int ${index}=0;${index}<10;${index}++) { ${cursor} };"

150

or "%{date}"

151

</p>

152

<p>

153

This syntax is somewhat similar to the one found in the Eclipse editor or textmate.

154

</p>

155

<p>

156

There are certain common placeholders (macros), which get assigned a

157

default initialValue, If the second parameter does not a given value.

158

For all others the initial value is the name of the placeholder.

159

</p>

160

<p>

161

Placeholder names may only consist of a-zA-Z0-9_

162

</p>

163

<p>

164

<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5

165

if a placeholder is a mirror, the place holder name may contain additional information

166

${something/regexp/replacement/} takes the value of the placeholder something and replaces the match with the replacement before inserting the mirrored value

167

${something/regexp/replacement/g} like above, but for all occurences

168

The syntax of the regexp and the replacement are the ones from kateparts regexp search/replace

169

${something/regexp/replacement/i} like above, but case insensitive

170

The syntax of the regexp and the replacement are the ones from kateparts regexp search/replace

171

Possible flags: g and i. Those flags can be combined too

172

If a literal / should appear in the regexp, it has to be escaped \/,

173

literal \ has to be escaped too

174

</dd></dl> </p>

175

<p>

176

If you have mirrored ranges and want another occurence than the first one as the master

177

you can add @directly after the placeholder name.

178

</p>

179

<p>

180

The interface2 version invokes the function specified by functionName within the script specified

181

by the scriptToken, if a placeholder is specified with backticks like

182

${placeholder`functionName`}

183

The function has a global environment containing "view", "document" and "debug", at

184

least in the katepart implementation. The function invokation is not allowed to be mixed with other replacements

185

</p>

186

<p>

187

If a / or ` replacement is done on a master the initial value is modified and therefor

188

also all mirrored placeholders are affected too, later on the replacement is not done anymore on master ranges

189

</p>

190

<p>

191

The parameters for invoked javascript functions will be the following:

192

value of the master (or initial value), //to be done: placeholder name, small wrapper around the template handler (to do more sophisticated things, like adding additional placehlder points, aattaching custom properties for state keeping, ....) you tell

193

</p>

194

<p>

195

Specification of initial values

196

You can specify initial values which are different from the placeholder name

197

this is done via, this makes only sense for $ placeholders, not for %

198

${placeholder:some value} or ${placeholder@:some value}

199

It is not allowed to mix : and /

200

after the first colon, everything is interpreted as default value, } in

201

the default value have to be escaped (backslashes before } have to be escaped themselves) and regexp searches are ignored. The : has to be

202

directly after the placeholder name or after an optional @symbol.

203

</p>

204

<p>

205

Common placeholders and values are

206

</p>

207

<p>

208

- index: "i"

209

- loginname: The current users's loginname

210

- firstname: The current user's first name retrieved from kabc

211

- lastname: The current user's last name retrieved from kabc

212

- fullname: The current user's first and last name retrieved from kabc

213

- email: The current user's primary email address retrieved from kabc

214

- date: current date

215

- time: current time

216

- year: current year

217

- month: current month

218

- day: current day

219

- hostname: hostname of the computer

220

- selection: The implementation should set this to the selected text, if any

221

- cursor: at this position the cursor will be after editing of the

222

template has finished, this has to be taken care of by the actual

223

implementation. The placeholder gets a value of "|" assigned.

224

</p>

225

<p>

226

If a macro is started with a % (persent sign) like "%{date}" it isn't added

227

to the list editable strings ( for example TAB key navigation) if a value

228

differing from the macro name is found.

229

</p>

230

<p>

231

If the editor supports some kind of smart indentation, the inserted code

232

should be layouted by the indenter.

233

<dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd>

234

</dd></dl>

235

</p></div></div><a class="anchor" name="insertTemplateTextImplementation"></a>

236

237

238

239

<td class="memname">bool insertTemplateTextImplementation</td>

240

241

242

243

</tr><tr>

244

245

246

<td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td>

247

<td class="paramname"><em>insertPosition</em>, </td>

248

</tr>

249

<tr>

250

251

252

<td class="paramtype">QString </td>

253

<td class="paramname"><em>templateString</em>, </td>

254

</tr>

255

<tr>

256

257

258

<td class="paramtype">{QString:QString} </td>

259

<td class="paramname"><em>initialValues</em></td>

260

</tr>

261

<tr>

262

263

264

265

266

267

</tr></table>

268

</div>

269

<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>You must implement this, it is called by insertTemplateText, after all

270

default values are inserted. If you are implementing this interface,

271

this method should work as described in the documentation for

272

insertTemplateText above.

273

<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if any text was inserted.

274

</dd></dl> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd>

275

</dd></dl>

276

</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="expandMacros"></a>

277

278

279

280

<td class="memname">bool expandMacros</td>

281

282

<td class="paramtype">{QString:QString} </td>

283

<td class="paramname"><em>initialValues</em>, </td>

284

</tr>

285

<tr>

286

287

288

<td class="paramtype">QWidget </td>

289

<td class="paramname"><em>parentWindow</em></td>

290

</tr>

291

<tr>

292

293

294

295

296

297

</tr></table>

298

</div>

299

<div class="memdoc"><p>Parses <b>templateString</b> for macros in the form [$%]{NAME} and finds

300

the value corresponding to NAME if any. The NAME string may contain

301

any non-whitespace character execpt '}'

302

</p><dl compact><dt><b>Parameters:</b></dt><dd>

303

304

<tr><td></td><td valign="top"><em>initialValues</em> </td><td> a map with the keys for the macros to expand.

305

keys with a value are ignored.

306

</td></tr> </table></dl>

307

<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>

308

309

<tr><td></td><td valign="top"><em>parentWindow</em> </td><td> is used if dialogs have to be shown

310

</td></tr> </table></dl>

311

<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if all macros was successfully expanded

312

</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> insertTemplateText for a list of supported macros

313

</dd></dl>

314

</p></div></div>

315

</div>

316

</div>

317

</div>

318

319

320

321

322

323

<ul>

324

<li><a href="../allclasses.html">Full Index</a></li>

325

</ul>

326

</div>

327

328

329

<h2 id="cp-menu-project">Modules</h2>

330

</div></div>

331

332

<ul><li><a href="../akonadi/index.html">akonadi</a></li>

333

<li><a href="../dnssd/index.html">dnssd</a></li>

334

<li><a href="../kdecore/index.html">kdecore</a></li>

335

<li><a href="../kdeui/index.html">kdeui</a></li>

336

<li><a href="../khtml/index.html">khtml</a></li>

337

338

<li><a href="../knewstuff/index.html">knewstuff</a></li>

339

<li><a href="../kparts/index.html">kparts</a></li>

340

<li><a href="../kutils/index.html">kutils</a></li>

341

<li><a href="../nepomuk/index.html">nepomuk</a></li>

342

<li><a href="../phonon/index.html">phonon</a></li>

343

<li><a href="../plasma/index.html">plasma</a></li>

344

<li><a href="../polkitqt/index.html">polkitqt</a></li>

345

<li><a href="../solid/index.html">solid</a></li>

346

<li><a href="../soprano/index.html">soprano</a></li>

347

</ul></div></div>

348

349

</div>

350

351

</div>

352

353

</div>

354

355

356

</div>

357

358

This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />

359

KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |

360

<a href="http://www.kde.org/contact/impressum.php">Legal</a>

361

</div></div>

362

</body>

363

</html>

Older »