~ubuntu-branches/ubuntu/utopic/kde-workspace/utopic-proposed

<desc>Emitted whenever a client's 'Keep Above' property is changed. setabove_client holds the client object of the client whose property was modified and the parameter 'set' is '1' if the 'Keep Above' was set, or '0' otherwise.</desc>

</event>

<param name="desktop_no" type="integer">The desktop number belonging to which the clients are to be fetched.</param>

<desc>Gets all clients on the virtual desktop desktop_no. If no desktop number is specified then it fetches all the clients. To specifically isolate clients which are on 'All desktops', set the desktop_no parameter to -1.</desc>

</method>

<param name="moved_client" type="client">The client which was moved from desktop old_desk to the new one</param>

<param name="old_desk" type="integer">The previous desktop on which the client was present</param>

<desc>Emitted whenever a client is moved across virtual desktops. The client's previous desktop is available through the old_desk parameter, whereas the current desktop can be fetched using moved_client.desktop</desc>

</event>

<desc>Returns the current desktop number of the workspace.</desc>

</property>

<param name="added_client" type="client">The client which was added.</param>

<desc>Emitted whenever a new client is added to the workspace. This generally occurs when a new window is opened which includes dialog boxes, windows etc. However, it is NOT emitted for unmanaged clients like the Alt+Tab switcher.</desc>

</event>

<param name="managing_client" type="client">The client which is being managed.</param>

<desc>Emitted whenever a client is being managed by the KWin subsystem. The difference between workspace.clientManaging and workspace.clientAdded is that clientManaging is emitted BEFORE clientAdded. Also, if KWin is restarted with a list of clients C, then the clientManaging event will be emitted for every client in C, but clientAdded will not.</desc>

</event>

<param name="minimized_client" type="client">The client which was minimized.</param>

<desc>Emitted whenever a client is minimized.</desc>

</event>

<param name="maximized_client" type="client">The client which was maximized (in a certain orientation).</param>

<param name="horizontally" type="boolean">(true) if the client was maximized horizontally, (false) otherwise.</param>

<param name="vertically" type="boolean">(true) if the client was maximized vertically, (false) otherwise.</param>

<desc>Emitted whenever a client is maximized in a particular orientation. The orientation i.e. the rectangular direction in which the client was specified to occupy the entire available space is specified by the two parameters horizontally and vertically. If both are true, the client was maximized fully i.e. asked to occupy the entire workspace are available.</desc>

</event>

<param name="killwindow_client" type="client">The client handle to the kill window that was called.</param>

<desc>Emitted whenever the user requests a Kill Window [generally using the Ctrl+Esc combination]. The parameter killwindow_client is not completely safe and may return kill windows out of order of invocation. This is just a fancy function, avoid using. Instead, use workspace.clientAdded and filter for incoming Kill Windows.</desc>

</event>

<param name="activated_client" type="client">The client which was activated (or received focus).</param>

<desc>Emitted whenever a client is given focus or 'activated'.</desc>

</event>

<desc>Returns the dimensions of the workspace in pixels.</desc>

</method>

<desc>Returns the desktop size in grid units. In essence, it returns the order of a rectangular matrix, where each element is a virtual desktop and the rows and columns specify the number of virtual desktops and the way of arrangement.</desc>

</method>

<param name="fss_set" type="boolean">(true) if the client was switched to full screen mode, (false) if it was switched from full screen mode.</param>

<param name="fss_client" type="client">The client which was set/unset to fullscreen.</param>

<desc>Emitted whenever a client is set to full screen or unset. The fss_set parameter can be used to determine whether the client was set or unset.</desc>

</event>

<desc>Returns the client which currently has focus.</desc>

</method>

<desc>Returns an array of all the ClientGroups from the current workspace.</desc>

</method>

<param name="unm_client" type="client">The client which was unminimzed.</param>

<desc>Emitted whenever a client is Unminimized (or restored).</desc>

</event>

</class>

100

<desc>Returns the x co-ordinate of the toplevel client (or the client).</desc>

101

</method>

102

103

104

105

<desc>Returns the y co-ordinate of the toplevel client (or the client).</desc>

106

</method>

107

108

109

110

<desc>Returns the width of the toplevel client (or the client).</desc>

111

</method>

112

113

114

115

<desc>Returns the height of the toplevel client (or the client).</desc>

116

</method>

117

118

119

120

<desc>Returns the size of the toplevel client (or the client).</desc>

121

</method>

122

123

124

125

<desc>Returns the position of the toplevel client (or the client).</desc>

126

</method>

127

128

129

130

<desc>Returns the opacity (or 1 - transperency) of the toplevel client (or the client).</desc>

131

</method>

132

133

134

135

<desc>Returns (true) if the client can be made translucent i.e. opacity can be set to values other than 0 or 1, (false) otherwise. NOTE: If compositing is OFF, then clients may still show that translucency is possible, but translucency is not possible without compositing being ON.</desc>

136

</method>

137

138

139

<param name="opacity_v" type="decimal">The opacity to be set (on a scale of 0-1).</param>

140

<desc>Sets the opacity of the client to opacity_v or sets transperency to (1 - opacity_v). NOTE: If compositing is OFF, this function has no effect for any values between 0 and 1 (exclusive).</desc>

141

</method>

142

</class>

143

144

145

146

147

<desc>Returns the caption of the caption (or the title) of the window.</desc>

148

</method>

149

150

151

<desc>Emitted whenever the client is moved or it's geometry changed. This includes when a client is resized.</desc>

152

</event>

153

154

155

<param name="set" type="boolean">Specifies whether the 'Keep Above' property was set or cleared.</param>

156

<desc>Emitted whenever the client's 'Keep Above' property is set or cleared. 'set' is 1 if the client was set to 'Keep Above', 0 otherwise. Equivalent to workspace.clientSetKeepAbove, but for a specific client. Use wherever possible instead of workspace.clientSetKeepAbove to improve performance.</desc>

157

</event>

158

159

160

<desc>Closes the given client using killClient.</desc>

161

</method>

162

163

164

<desc>Emitted whenever a client is minimized. Equivalent to workspace.clientMinimized, but for a specific client. Use wherever possible instead of workspace.clientMinimzed to improve performance.</desc>

165

</event>

166

167

168

<param name="horizontally" type="boolean">(true) if the client was maximized horizontally, (false) otherwise.</param>

169

<param name="vertically" type="boolean">(true) if the client was maximized vertically, (false) otherwise.</param>

170

<desc>Emitted when the client is maximized in a particular orientation. The orientation i.e. the rectangular direction in which the client was specified to occupy the entire available space is specified by the two parameters horizontally and vertically. If both are true, the client was maximized fully i.e. asked to occupy the entire workspace are available. Equivalent to workspace.clientMaximizeSet, but for a specific client. Use wherever possible instead of workspace.clientMaximizeSet to improve performance.</desc>

171

</event>

172

173

174

<desc>Emitted whenever the client is activated (or gets focus). Equivalent to workspace.clientActivated but for a specific client. Use wherever possible instead of workspace.clientActivated to improve performance.</desc>

175

</event>

176

177

178

179

<param name="location" type="qpoint">The (x, y) point to where the top left corner of the client must be moved to keeping the current height and width same.</param>

180

<param name="emitjs" type="boolean">EmitJS value (defaults to true).</param>

181

</paramset>

182

183

184

<param name="x" type="integer">The x co-ordinate value of the point to where the top left corner of the client must be moved to keeping the current height and width same.</param>

185

<param name="x" type="integer">The y co-ordinate value of the point to where the top left corner of the client must be moved to keeping the current height and width same.</param>

186

<param name="emitjs" type="boolean">EmitJS value (defaults to true).</param>

187

</paramset>

188

189

<desc>Moves the client to the specified location keeping the height and width of the client same.</desc>

190

</method>

191

192

193

194

<param name="size" type="qsize">The size to which the client is to be resized.</param>

195

<param name="emitJS" type="boolean">EmitJS value (defaults to true).</param>

196

</paramset>

197

198

199

<param name="w" type="integer">New width for the client.</param>

200

<param name="h" type="integer">New height for the client.</param>

201

<param name="emitJS" type="boolean">EmitJS value (defaults to true).</param>

202

</paramset>

203

204

<desc>Resizes the client to the specified size without changing its position.</desc>

205

</method>

206

207

208

209

<param name="geometry" type="qrect">The new geometry which is to be set for the client.</param>

210

<param name="emitJS" type="boolean">EmitJS value (defaults to true).</param>

211

</paramset>

212

213

214

<param name="x" type="integer">The x co-ordinate of the new geometry.</param>

215

<param name="y" type="integer">The y co-ordinate of the new geometry.</param>

216

<param name="w" type="integer">The width of the new geometry.</param>

217

<param name="h" type="integer">The height of the new geometry.</param>

218

</paramset>

219

220

<desc>Sets the geometry of the client i.e. sets is size and location according to the provided parameters.</desc>

221

</method>

222

223

224

225

<desc>Returns a windowinfo object which can be used to get further information about the client. Wherever possible, directly use the client properties than calling for a windowinfo object. NOTE: The windowinfo object is a 'snapshot' object and hence the data provided by it is not modified when the properties of the client are changed.</desc>

226

</method>

227

228

229

230

<desc>Returns (true) is 'client' is transient, (false) otherwise.</desc>

231

</method>

232

233

234

235

<desc>If the given client is transient, returns it's parent client, otherwise returns an undefined scriptvalue.</desc>

236

</method>

237

238

239

<desc><strong>Attempt</strong> to activate (focus) the client. By attempt, it means that focus stealing prevention still is activated and the rules for activation are in place. Hence, the client actually may nor may not be activated.</desc>

240

</method>

241

242

243

<param name="caption_string" type="string">The caption to be set for the specified.</param>

244

<desc>Sets the caption for the specified client to caption_string.</desc>

245

</method>

246

247

248

<desc>Unminimizes (or restores) the given client.</desc>

249

</method>

250

251

252

253

254

<desc>Emitted whenever the given client is unminimized. Equivalent of workspace.clientUnminimzed but for a specific client. Use wherever possible instead of workspace.clientUnminimized to improve performance.</desc>

255

</event>

256

257

258

259

260

<param type="fss_set">If (true), then the client is set to full screen or else, it is unset from fullscreen mode. If no parameter is provided, it toggles the full screen state.</param>

261

<desc>Sets the client to or from full screen mode.</desc>

262

</method>

263

264

265

266

<desc>Returns (true) if the client is shaded, (false) otherwise.</desc>

267

</method>

268

269

270

271

<desc>Returns (true) if the client is shadeable (can be shaded), (false) otherwise.</desc>

272

</method>

273

274

275

276

<desc>Returns (true) if the client is minimized, (false) otherwise.</desc>

277

</method>

278

279

280

281

<desc>Returns (true) if the client can be minimized, (false) otherwise.</desc>

282

</method>

283

284

285

286

<desc>Returns (true) if the client can be mazimized, (false) otherwise.</desc>

287

</method>

288

289

290

291

<desc>Returns (true) if the client can be resized (changable size), (false) otherwise.</desc>

292

</method>

293

294

295

296

<desc>Returns (true) if the client can be moved (non-fixed location), (false) otherwise.</desc>

297

</method>

298

299

300

301

<desc>Returns (true) if the client can be moved across screens (only valid in a multiple monitor setup), (false) otherwise.</desc>

302

</method>

303

304

305

306

<desc>Returns (true) if the client can be closed by user action (or any other action other than the system or the application itself), (false) otherwise.</desc>

307

</method>

308

309

310

311

<desc>Returns (true) if the client is in fullscreen mode, (false) otherwise.</desc>

312

</method>

313

314

315

316

<desc>Returns (true) if the client can be set to fullscreen mode, (false) otherwise.</desc>

317

</method>

318

319

320

321

<desc>Returns (true) if the window is 'normal', (false) otherwise. A normal window is a window which has a border, can be moved by the user, can be closed, etc.</desc>

322

</method>

323

324

325

326

<desc>Returns (true) if 'Keep Above Others' has been set on the client, (false) otherwise.</desc>

327

</method>

328

329

330

331

<desc>Returns (true) if 'Keep Below Others' has been set on the client, (false) otherwise.</desc>

332

</method>

333

334

335

<param name="keepabove" type="boolean">The 'Keep Above others' parameter to be applied to the client</param>

336

<desc>Sets the 'Keep Above others' parameter value or unsets it according to keepabove.</desc>

337

</method>

338

339

340

<param name="keepbelow">The 'Keep Below others' parameter to be applied to the client</param>

341

<desc>Sets the 'Keep Below others' parameter value or unsets it according to keepbelow.</desc>

342

</method>

343

344

345

346

<desc>Returns the client group the client belongs to. If it belongs to no client, it returns an undefined script value.</desc>

347

</method>

348

349

350

<param name="fss_set" type="boolean">(true) if the client was set to full screen mode, (false) if the client was set from full screen mode.</param>

351

<desc>Emitted whenever the client's fullscreen mode is toggled. fss_set specifies whether the client was set to or from fullscreen mode.</desc>

352

</event>

353

354

355

356

<desc>Returns the desktop number that the client is on. If it is on all desktops, it returns -1.</desc>

357

</method>

358

</class>

359

360

361

362

<param name="seed_client" type="client">The client to be added to the newly formed clientgroup. This is a mandatory argument for the creation of a new clientgroup object.</param>

363

<desc>Creates a new clientgroup object. A clientgroup in essence refers to a group of tabbed clients and an object refers to a specific group of such tabbed clients. It returns a clientgroup object which can be then manipulated using the various accessor functions.</desc>

364

</method>

365

366

367

<param name="new_client" type="client">A client object to be added to the clientgroup.</param>

368

<param name="beforeClient" type="integer">An index as to where the client is to be added to the clientgroup. It is an optional argument and if not specified, it will be added at the last position in the clientgroup.</param>

369

<param name="becomeVisible" type="boolean">If (true), makes the added client visible.</param>

370

371

<desc>Adds new_client to the clientgroup at the index specified by beforeClient and if becomeVisible is true, makes it visible.</desc>

372

</method>

373

374

375

376

<param name="index" type="integer">The client index which is to be removed.</param>

377

<param name="set_geom" type="qrect">The geometry to be set after removeal. This parameter is optional.</param>

378

</paramset>

379

380

381

<param name="rem_client" type="client">The client which is to be removed.</param>

382

<param name="set_geom" type="qrect">The geometry to be set after removal.</param>

383

</paramset>

384

385

<desc>Removes the client from the clientgroup and then sets it's geometry according to set_geom. This parameter is optional.</desc>

386

</method>

387

388

389

390

<desc>Returns an array of all the member clients of the clientgroup.</desc>

391

</method>

392

393

394

395

<param name="needle_client" type="client">The client to be searched for</param>

396

<desc>Returns (true) if needle_client is a member of the clientgroup, (false) otherwise.</desc>

397

</method>

398

399

400

401

<param name="needle_client" type="client">The client whose index is to be found</param>

402

<desc>Searches for needle_client in the clientgroup and returns the position at which it exists. If needle_client is not found, then it returns -1.</desc>

403

</method>

404

405

406

407

<param name="index_a" type="integer">The index of the client to be moved.</param>

408

<param name="index_b" type="integer">The index of the position to move the client to.</param>

409

</paramset>

410

411

412

<param name="move_client" type="integer">The client to be moved.</param>

413

<param name="index" type="integer">The index of the position to move the client to.</param>

414

</paramset>

415

416

417

<param name="move_client" type="integer">The client to be moved.</param>

418

<param name="before_client" type="integer">The client before which the client is to moved.</param>

419

</paramset>

420

421

422

<param name="index_a" type="integer">The index of the client to be moved.</param>

423

<param name="before_client" type="integer">The client before which the client is to moved.</param>

424

</paramset>

425

426

<desc>Move a client within the group. Accepts move(client, client), move(index, index), move(index, client), move(client, index). All calls except move(client, client) are eventually mapped to move(index, index) using indexOf(client)</desc>

427

</method>

428

429

430

<desc>Removes all the clients from the clientgroup i.e. completely disassembles the clientgroup into its proponents.</desc>

431

</method>

432

433

434

<desc>Closes all the clients presents in the clientgroup.</desc>

435

</method>

436

437

438

439

<desc>Returns the minimum size acceptable for the clientgroup computed from the minimum sizes of all its present members.</desc>

440

</method>

441

442

443

444

<desc>Returns the maximum size acceptable for the clientgroup computed from the minimum sizes of all its present members.</desc>

445

</method>

446

</class>

447

448

449

450

451

<desc>Returns (true) if the client is valid, (false) otherwise.</desc>

452

</property>

453

454

455

456

<desc>Returns the visible name of the client.</desc>

457

</property>

458

459

460

461

<desc>Returns (true) if client is minimized. Redundant with client.isMinimized. For client, the subclass property is called, not the toplevel one.</desc>

462

</property>

463

464

465

466

<desc>Returns an integeral state for the client. Prefer other methods like isShaded, isFullScreenSet etc. over this.</desc>

467

</property>

468

469

470

471

<desc>Returns the window role of the toplevel client.</desc>

472

</property>

473

474

475

476

<desc>Returns the windowclass class of the client.</desc>

477

</property>

478

479

480

481

<desc>Returns the windowclass name of the client.</desc>

482

</property>

483

</class>

484

485

486

487

488

<desc>Returns (true) if a configuration file was found and loaded, (false) otherwise.</desc>

489

</property>

490

491

492

<param name="config_key" type="string">The configuration key to be seeked.</param>

493

<desc>Searches for config_key in the configuration array and returns (true) if a corresponding value exists, (false) otherwise.</desc>

494

</method>

495

496

497

498

</paramset>

499

500

501

<param name="key1, key2 ... keyN" type="string">A list of keys to search the values for.</param>

502

</paramset>

503

504

505

<param name="key" type="string">The key to search the value for.</param>

506

</paramset>

507

508

509

<param name="keyArray" type="Array(string)">An array of keys to search the corresponding values for.</param>

510

<param name="showNonAssoc" type="boolean">If (true) causes the function to return an integer-indexed array, otherwise returns an associative array in the form ["key" : "value"]. This parameter is optional, defaults to false</param>

511

</paramset>

512

513

<desc>If called without parameters, returns an associative array in the format ["key" : "value"] of all available key value pairs. If only a single key is requested for (passing 1 string parameter), then the corresponding value is returned and NOT an array. If multiple keys are provided as multiple arguments, an associative array is returned. If multiple keys (or a single) key is provided as an Array, then an associative array is present (if showNonAssoc is false or it is not specified), otherwise returns an integer indexed array.</desc>

514

</method>

515

</class>

516

</root>

Older »