~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

<indexterm zone="gimp-context-push" role="GIMP 2.2"><primary sortas="gimp_context_push">gimp_context_push</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_push (void);</programlisting>

<para>

Pushes a context to the top of the plug-in's context stack.

</para>

<para>

This procedure creates a new context by copying the current context.

This copy becomes the new current context for the calling plug-in

until it is popped again using <link linkend="gimp-context-pop"><function>gimp_context_pop()</function></link>.</para>

<para>

</para><variablelist role="params">

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

</simpara></listitem></varlistentry>

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

<title>gimp_context_pop ()</title>

<indexterm zone="gimp-context-pop" role="GIMP 2.2"><primary sortas="gimp_context_pop">gimp_context_pop</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_pop (void);</programlisting>

<para>

Pops the topmost context from the plug-in's context stack.

</para>

<para>

This procedure removes the topmost context from the plug-in's

context stack. The context that was active before the corresponding

call to <link linkend="gimp-context-push"><function>gimp_context_push()</function></link> becomes the new current context of the

plug-in.</para>

<para>

</para><variablelist role="params">

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

</simpara></listitem></varlistentry>

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

100

101

<title>gimp_context_get_foreground ()</title>

102

<indexterm zone="gimp-context-get-foreground" role="GIMP 2.2"><primary sortas="gimp_context_get_foreground">gimp_context_get_foreground</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_get_foreground (<link linkend="GimpRGB">GimpRGB</link> *foreground);</programlisting>

103

<para>

104

Get the current GIMP foreground color.

105

</para>

106

<para>

107

This procedure returns the current GIMP foreground color. The

108

foreground color is used in a variety of tools such as paint tools,

109

blending, and bucket fill.</para>

110

<para>

111

</para><variablelist role="params">

112

<varlistentry><term><parameter>foreground</parameter> :</term>

113

<listitem><simpara> The foreground color.

114

</simpara></listitem></varlistentry>

115

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

116

117

</simpara></listitem></varlistentry>

118

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

119

120

<title>gimp_context_set_foreground ()</title>

121

<indexterm zone="gimp-context-set-foreground" role="GIMP 2.2"><primary sortas="gimp_context_set_foreground">gimp_context_set_foreground</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_foreground (const <link linkend="GimpRGB">GimpRGB</link> *foreground);</programlisting>

122

<para>

123

Set the current GIMP foreground color.

124

</para>

125

<para>

126

This procedure sets the current GIMP foreground color. After this is

127

set, operations which use foreground such as paint tools, blending,

128

and bucket fill will use the new value.</para>

129

<para>

130

</para><variablelist role="params">

131

<varlistentry><term><parameter>foreground</parameter> :</term>

132

<listitem><simpara> The foreground color.

133

</simpara></listitem></varlistentry>

134

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

135

136

</simpara></listitem></varlistentry>

137

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

138

139

<title>gimp_context_get_background ()</title>

140

<indexterm zone="gimp-context-get-background" role="GIMP 2.2"><primary sortas="gimp_context_get_background">gimp_context_get_background</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_get_background (<link linkend="GimpRGB">GimpRGB</link> *background);</programlisting>

141

<para>

142

Get the current GIMP background color.

143

</para>

144

<para>

145

This procedure returns the current GIMP background color. The

146

background color is used in a variety of tools such as blending,

147

erasing (with non-alpha images), and image filling.</para>

148

<para>

149

</para><variablelist role="params">

150

<varlistentry><term><parameter>background</parameter> :</term>

151

<listitem><simpara> The background color.

152

</simpara></listitem></varlistentry>

153

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

154

155

</simpara></listitem></varlistentry>

156

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

157

158

<title>gimp_context_set_background ()</title>

159

<indexterm zone="gimp-context-set-background" role="GIMP 2.2"><primary sortas="gimp_context_set_background">gimp_context_set_background</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_background (const <link linkend="GimpRGB">GimpRGB</link> *background);</programlisting>

160

<para>

161

Set the current GIMP background color.

162

</para>

163

<para>

164

This procedure sets the current GIMP background color. After this is

165

set, operations which use background such as blending, filling

166

images, clearing, and erasing (in non-alpha images) will use the new

167

value.</para>

168

<para>

169

</para><variablelist role="params">

170

<varlistentry><term><parameter>background</parameter> :</term>

171

<listitem><simpara> The background color.

172

</simpara></listitem></varlistentry>

173

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

174

175

</simpara></listitem></varlistentry>

176

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

177

178

<title>gimp_context_set_default_colors ()</title>

179

<indexterm zone="gimp-context-set-default-colors" role="GIMP 2.2"><primary sortas="gimp_context_set_default_colors">gimp_context_set_default_colors</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_default_colors (void);</programlisting>

180

<para>

181

Set the current GIMP foreground and background colors to black and

182

white.

183

</para>

184

<para>

185

This procedure sets the current GIMP foreground and background

186

colors to their initial default values, black and white.</para>

187

<para>

188

</para><variablelist role="params">

189

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

190

191

</simpara></listitem></varlistentry>

192

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

193

194

<title>gimp_context_swap_colors ()</title>

195

<indexterm zone="gimp-context-swap-colors" role="GIMP 2.2"><primary sortas="gimp_context_swap_colors">gimp_context_swap_colors</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_swap_colors (void);</programlisting>

196

<para>

197

Swap the current GIMP foreground and background colors.

198

</para>

199

<para>

200

This procedure swaps the current GIMP foreground and background

201

colors, so that the new foreground color becomes the old background

202

color and vice versa.</para>

203

<para>

204

</para><variablelist role="params">

205

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

206

207

</simpara></listitem></varlistentry>

208

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

209

210

<title>gimp_context_get_opacity ()</title>

211

<indexterm zone="gimp-context-get-opacity" role="GIMP 2.2"><primary sortas="gimp_context_get_opacity">gimp_context_get_opacity</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_context_get_opacity (void);</programlisting>

212

<para>

213

Get the opacity.

214

</para>

215

<para>

216

This procedure returns the opacity setting. The return value is a

217

floating point number between 0 and 100.</para>

218

<para>

219

</para><variablelist role="params">

220

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The opacity.

221

222

</simpara></listitem></varlistentry>

223

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

224

225

<title>gimp_context_set_opacity ()</title>

226

<indexterm zone="gimp-context-set-opacity" role="GIMP 2.2"><primary sortas="gimp_context_set_opacity">gimp_context_set_opacity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_opacity (<link linkend="gdouble">gdouble</link> opacity);</programlisting>

227

<para>

228

Set the opacity.

229

</para>

230

<para>

231

This procedure modifies the opacity setting. The value should be a

232

floating point number between 0 and 100.</para>

233

<para>

234

</para><variablelist role="params">

235

<varlistentry><term><parameter>opacity</parameter> :</term>

236

<listitem><simpara> The opacity.

237

</simpara></listitem></varlistentry>

238

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

239

240

</simpara></listitem></varlistentry>

241

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

242

243

<title>gimp_context_get_paint_mode ()</title>

244

<indexterm zone="gimp-context-get-paint-mode" role="GIMP 2.2"><primary sortas="gimp_context_get_paint_mode">gimp_context_get_paint_mode</primary></indexterm><programlisting><link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> gimp_context_get_paint_mode (void);</programlisting>

245

<para>

246

Get the paint mode.

247

</para>

248

<para>

249

This procedure returns the paint-mode setting. The return value is

250

an integer which corresponds to the values listed in the argument

251

description.</para>

252

<para>

253

</para><variablelist role="params">

254

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The paint mode.

255

256

</simpara></listitem></varlistentry>

257

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

258

259

<title>gimp_context_set_paint_mode ()</title>

260

<indexterm zone="gimp-context-set-paint-mode" role="GIMP 2.2"><primary sortas="gimp_context_set_paint_mode">gimp_context_set_paint_mode</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_paint_mode (<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);</programlisting>

261

<para>

262

Set the paint mode.

263

</para>

264

<para>

265

This procedure modifies the paint_mode setting.</para>

266

<para>

267

</para><variablelist role="params">

268

<varlistentry><term><parameter>paint_mode</parameter> :</term>

269

<listitem><simpara> The paint mode.

270

</simpara></listitem></varlistentry>

271

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

272

273

</simpara></listitem></varlistentry>

274

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

275

276

<title>gimp_context_get_brush ()</title>

277

<indexterm zone="gimp-context-get-brush" role="GIMP 2.2"><primary sortas="gimp_context_get_brush">gimp_context_get_brush</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_context_get_brush (void);</programlisting>

278

<para>

279

Retrieve the currently active brush.

280

</para>

281

<para>

282

This procedure returns the name of the currently active brush. All

283

paint operations and stroke operations use this brush to control the

284

application of paint to the image.</para>

285

<para>

286

</para><variablelist role="params">

287

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the active brush.

288

289

</simpara></listitem></varlistentry>

290

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

291

292

<title>gimp_context_set_brush ()</title>

293

<indexterm zone="gimp-context-set-brush" role="GIMP 2.2"><primary sortas="gimp_context_set_brush">gimp_context_set_brush</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_brush (const <link linkend="gchar">gchar</link> *name);</programlisting>

294

<para>

295

Set the specified brush as the active brush.

296

</para>

297

<para>

298

This procedure allows the active brush to be set by specifying its

299

name. The name is simply a string which corresponds to one of the

300

names of the installed brushes. If there is no matching brush found,

301

this procedure will return an error. Otherwise, the specified brush

302

becomes active and will be used in all subsequent paint operations.</para>

303

<para>

304

</para><variablelist role="params">

305

306

<listitem><simpara> The name of the brush.

307

</simpara></listitem></varlistentry>

308

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

309

310

</simpara></listitem></varlistentry>

311

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

312

313

<title>gimp_context_get_pattern ()</title>

314

<indexterm zone="gimp-context-get-pattern" role="GIMP 2.2"><primary sortas="gimp_context_get_pattern">gimp_context_get_pattern</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_context_get_pattern (void);</programlisting>

315

<para>

316

Retrieve the currently active pattern.

317

</para>

318

<para>

319

This procedure returns name of the the currently active pattern. All

320

clone and bucket-fill operations with patterns will use this pattern

321

to control the application of paint to the image.</para>

322

<para>

323

</para><variablelist role="params">

324

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the active pattern.

325

326

</simpara></listitem></varlistentry>

327

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

328

329

<title>gimp_context_set_pattern ()</title>

330

<indexterm zone="gimp-context-set-pattern" role="GIMP 2.2"><primary sortas="gimp_context_set_pattern">gimp_context_set_pattern</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_pattern (const <link linkend="gchar">gchar</link> *name);</programlisting>

331

<para>

332

Set the specified pattern as the active pattern.

333

</para>

334

<para>

335

This procedure allows the active pattern to be set by specifying its

336

name. The name is simply a string which corresponds to one of the

337

names of the installed patterns. If there is no matching pattern

338

found, this procedure will return an error. Otherwise, the specified

339

pattern becomes active and will be used in all subsequent paint

340

operations.</para>

341

<para>

342

</para><variablelist role="params">

343

344

<listitem><simpara> The name of the pattern.

345

</simpara></listitem></varlistentry>

346

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

347

348

</simpara></listitem></varlistentry>

349

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

350

351

<title>gimp_context_get_gradient ()</title>

352

<indexterm zone="gimp-context-get-gradient" role="GIMP 2.2"><primary sortas="gimp_context_get_gradient">gimp_context_get_gradient</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_context_get_gradient (void);</programlisting>

353

<para>

354

Retrieve the currently active gradient.

355

</para>

356

<para>

357

This procedure returns the name of the currently active gradient.</para>

358

<para>

359

</para><variablelist role="params">

360

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the active gradient.

361

362

</simpara></listitem></varlistentry>

363

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

364

365

<title>gimp_context_set_gradient ()</title>

366

<indexterm zone="gimp-context-set-gradient" role="GIMP 2.2"><primary sortas="gimp_context_set_gradient">gimp_context_set_gradient</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_gradient (const <link linkend="gchar">gchar</link> *name);</programlisting>

367

<para>

368

Sets the specified gradient as the active gradient.

369

</para>

370

<para>

371

This procedure lets you set the specified gradient as the active or

372

\"current\" one. The name is simply a string which corresponds to

373

one of the loaded gradients. If no matching gradient is found, this

374

procedure will return an error. Otherwise, the specified gradient

375

will become active and will be used for subsequent custom gradient

376

operations.</para>

377

<para>

378

</para><variablelist role="params">

379

380

<listitem><simpara> The name of the gradient.

381

</simpara></listitem></varlistentry>

382

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

383

384

</simpara></listitem></varlistentry>

385

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

386

387

<title>gimp_context_get_palette ()</title>

388

<indexterm zone="gimp-context-get-palette" role="GIMP 2.2"><primary sortas="gimp_context_get_palette">gimp_context_get_palette</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_context_get_palette (void);</programlisting>

389

<para>

390

Retrieve the currently active palette.

391

</para>

392

<para>

393

This procedure returns the name of the the currently active palette.</para>

394

<para>

395

</para><variablelist role="params">

396

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the active palette.

397

398

</simpara></listitem></varlistentry>

399

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

400

401

<title>gimp_context_set_palette ()</title>

402

<indexterm zone="gimp-context-set-palette" role="GIMP 2.2"><primary sortas="gimp_context_set_palette">gimp_context_set_palette</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_palette (const <link linkend="gchar">gchar</link> *name);</programlisting>

403

<para>

404

Set the specified palette as the active palette.

405

</para>

406

<para>

407

This procedure allows the active palette to be set by specifying its

408

name. The name is simply a string which corresponds to one of the

409

names of the installed palettes. If no matching palette is found,

410

this procedure will return an error. Otherwise, the specified

411

palette becomes active and will be used in all subsequent palette

412

operations.</para>

413

<para>

414

</para><variablelist role="params">

415

416

<listitem><simpara> The name of the palette.

417

</simpara></listitem></varlistentry>

418

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

419

420

</simpara></listitem></varlistentry>

421

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

422

423

<title>gimp_context_get_font ()</title>

424

<indexterm zone="gimp-context-get-font" role="GIMP 2.2"><primary sortas="gimp_context_get_font">gimp_context_get_font</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_context_get_font (void);</programlisting>

425

<para>

426

Retrieve the currently active font.

427

</para>

428

<para>

429

This procedure returns the name of the currently active font.</para>

430

<para>

431

</para><variablelist role="params">

432

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the active font.

433

434

</simpara></listitem></varlistentry>

435

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

436

437

<title>gimp_context_set_font ()</title>

438

<indexterm zone="gimp-context-set-font" role="GIMP 2.2"><primary sortas="gimp_context_set_font">gimp_context_set_font</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_font (const <link linkend="gchar">gchar</link> *name);</programlisting>

439

<para>

440

Set the specified font as the active font.

441

</para>

442

<para>

443

This procedure allows the active font to be set by specifying its

444

name. The name is simply a string which corresponds to one of the

445

names of the installed fonts. If no matching font is found, this

446

procedure will return an error. Otherwise, the specified font

447

becomes active and will be used in all subsequent font operations.</para>

448

<para>

449

</para><variablelist role="params">

450

451

<listitem><simpara> The name of the font.

452

</simpara></listitem></varlistentry>

453

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

454

455

</simpara></listitem></varlistentry>

456

</variablelist><para role="since">Since GIMP 2.2</para></refsect2>

457

458

<title>gimp_context_get_paint_method ()</title>

459

<indexterm zone="gimp-context-get-paint-method" role="GIMP 2.4"><primary sortas="gimp_context_get_paint_method">gimp_context_get_paint_method</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_context_get_paint_method (void);</programlisting>

460

<para>

461

Retrieve the currently active paint method.

462

</para>

463

<para>

464

This procedure returns the name of the currently active paint

465

method.</para>

466

<para>

467

</para><variablelist role="params">

468

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the active paint method.

469

470

</simpara></listitem></varlistentry>

471

</variablelist><para role="since">Since GIMP 2.4</para></refsect2>

472

473

<title>gimp_context_set_paint_method ()</title>

474

<indexterm zone="gimp-context-set-paint-method" role="GIMP 2.4"><primary sortas="gimp_context_set_paint_method">gimp_context_set_paint_method</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_set_paint_method (const <link linkend="gchar">gchar</link> *name);</programlisting>

475

<para>

476

Set the specified paint method as the active paint method.

477

</para>

478

<para>

479

This procedure allows the active paint method to be set by

480

specifying its name. The name is simply a string which corresponds

481

to one of the names of the available paint methods. If there is no

482

matching method found, this procedure will return an error.

483

Otherwise, the specified method becomes active and will be used in

484

all subsequent paint operations.</para>

485

<para>

486

</para><variablelist role="params">

487

488

<listitem><simpara> The name of the paint method.

489

</simpara></listitem></varlistentry>

490

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

491

492

</simpara></listitem></varlistentry>

493

</variablelist><para role="since">Since GIMP 2.4</para></refsect2>

494

495

<title>gimp_context_list_paint_methods ()</title>

496

<indexterm zone="gimp-context-list-paint-methods" role="GIMP 2.4"><primary sortas="gimp_context_list_paint_methods">gimp_context_list_paint_methods</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_context_list_paint_methods (<link linkend="gint">gint</link> *num_paint_methods,

497

498

<para>

499

Lists the available paint methods.

500

</para>

501

<para>

502

This procedure lists the names of the available paint methods. Any

503

of the results can be used for <link linkend="gimp-context-set-paint-method"><function>gimp_context_set_paint_method()</function></link>.</para>

504

<para>

505

</para><variablelist role="params">

506

<varlistentry><term><parameter>num_paint_methods</parameter> :</term>

507

<listitem><simpara> The number of the available paint methods.

508

</simpara></listitem></varlistentry>

509

<varlistentry><term><parameter>paint_methods</parameter> :</term>

510

<listitem><simpara> The names of the available paint methods.

511

</simpara></listitem></varlistentry>

512

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.

513

514

</simpara></listitem></varlistentry>

515

</variablelist><para role="since">Since GIMP 2.4</para></refsect2>

516

517

</refsect1>

518

519

520

521

522

</refentry>

Older »