/usr/share/gtk-doc/html/libanjuta/AnjutaCommand.html is in libanjuta-dev 2:3.28.0-1.
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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AnjutaCommand: Anjuta Developers Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Anjuta Developers Reference Manual">
<link rel="up" href="libanjuta-api.html" title="libanjuta API">
<link rel="prev" href="libanjuta-Debugging.html" title="Debugging">
<link rel="next" href="AnjutaSyncCommand.html" title="AnjutaSyncCommand">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#AnjutaCommand.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AnjutaCommand.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#AnjutaCommand.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libanjuta-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libanjuta-Debugging.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AnjutaSyncCommand.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AnjutaCommand"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AnjutaCommand.top_of_page"></a>AnjutaCommand</span></h2>
<p>AnjutaCommand — System for creating objects that provide a standard
interface to external components (libraries, processes,
etc.)</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AnjutaCommand.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-start" title="anjuta_command_start ()">anjuta_command_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-cancel" title="anjuta_command_cancel ()">anjuta_command_cancel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-notify-data-arrived" title="anjuta_command_notify_data_arrived ()">anjuta_command_notify_data_arrived</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-notify-complete" title="anjuta_command_notify_complete ()">anjuta_command_notify_complete</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-notify-progress" title="anjuta_command_notify_progress ()">anjuta_command_notify_progress</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-is-running" title="anjuta_command_is_running ()">anjuta_command_is_running</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-set-error-message" title="anjuta_command_set_error_message ()">anjuta_command_set_error_message</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-get-error-message" title="anjuta_command_get_error_message ()">anjuta_command_get_error_message</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-start-automatic-monitor" title="anjuta_command_start_automatic_monitor ()">anjuta_command_start_automatic_monitor</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaCommand.html#anjuta-command-stop-automatic-monitor" title="anjuta_command_stop_automatic_monitor ()">anjuta_command_stop_automatic_monitor</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AnjutaCommand.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AnjutaCommand.html#AnjutaCommand-command-finished" title="The “command-finished” signal">command-finished</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AnjutaCommand.html#AnjutaCommand-command-started" title="The “command-started” signal">command-started</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AnjutaCommand.html#AnjutaCommand-data-arrived" title="The “data-arrived” signal">data-arrived</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AnjutaCommand.html#AnjutaCommand-progress" title="The “progress” signal">progress</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AnjutaCommand.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="AnjutaCommand.html#AnjutaCommandPriv" title="AnjutaCommandPriv">AnjutaCommandPriv</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AnjutaCommand.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> AnjutaCommand
<span class="lineart">├──</span> <a class="link" href="AnjutaAsyncCommand.html" title="AnjutaAsyncCommand">AnjutaAsyncCommand</a>
<span class="lineart">╰──</span> <a class="link" href="AnjutaSyncCommand.html" title="AnjutaSyncCommand">AnjutaSyncCommand</a>
</pre>
</div>
<div class="refsect1">
<a name="AnjutaCommand.description"></a><h2>Description</h2>
<p><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> is the base class for objects that are designed to provide
a layer of abstraction between UI code and some other component, like a
library or child process. AnjutaCommand provides a simple and consistent
interface for plugins to interact with these components without needing
to concern themselves with the exact details of how these components work.</p>
<p>To create command objects, plugins derive them from an <a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a>
subclass like <a class="link" href="AnjutaAsyncCommand.html" title="AnjutaAsyncCommand"><span class="type">AnjutaAsyncCommand</span></a>, which runs commands in another thread or
<a class="link" href="AnjutaSyncCommand.html" title="AnjutaSyncCommand"><span class="type">AnjutaSyncCommand</span></a>, which runs commands synchronously.</p>
<p>These classes determine how ::run is called and how signals are emitted.
::run is responsible for actually doing the work of the command. It is the
responsiblity of the command object that does a certain task to implement
::run to do its job. Everything else is normally implemented by its parent
classes at this point</p>
<p>For an example of how to use <a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a>, see the Subversion and Git
plugins.</p>
</div>
<div class="refsect1">
<a name="AnjutaCommand.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="anjuta-command-start"></a><h3>anjuta_command_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_command_start (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>);</pre>
<p>Starts a command. Client code can handle data from the command by connecting
to the ::data-arrived signal. </p>
<p><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> subclasses should override this method to determine how they
call ::run, which actually does the command's legwork.</p>
<div class="refsect3">
<a name="anjuta-command-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object to start</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-cancel"></a><h3>anjuta_command_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_command_cancel (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>);</pre>
<p>Cancels a running command.</p>
<div class="refsect3">
<a name="anjuta-command-cancel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-notify-data-arrived"></a><h3>anjuta_command_notify_data_arrived ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_command_notify_data_arrived (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>);</pre>
<p>Used by base classes derived from <a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> to emit the ::data-arrived
signal. This method should be used by both base command classes and
non-base classes as appropriate.</p>
<div class="refsect3">
<a name="anjuta-command-notify-data-arrived.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-notify-complete"></a><h3>anjuta_command_notify_complete ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_command_notify_complete (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> return_code</code></em>);</pre>
<p>Used by base classes derived from <a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> to emit the
::command-finished signal. This method should not be used by client code or
<a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> objects that are not base classes.</p>
<div class="refsect3">
<a name="anjuta-command-notify-complete.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>return_code</p></td>
<td class="parameter_description"><p>The returned code that is passed to the notify callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-notify-progress"></a><h3>anjuta_command_notify_progress ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_command_notify_progress (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> progress</code></em>);</pre>
<p>Emits the ::progress signal. Can be used by both base classes and
commands as needed.</p>
<div class="refsect3">
<a name="anjuta-command-notify-progress.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>The of the command that is passed to the notify callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-is-running"></a><h3>anjuta_command_is_running ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
anjuta_command_is_running (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>);</pre>
<div class="refsect3">
<a name="anjuta-command-is-running.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="anjuta-command-is-running.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the command is currently running; <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-set-error-message"></a><h3>anjuta_command_set_error_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_command_set_error_message (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *error_message</code></em>);</pre>
<p>Command objects use this to set error messages when they encounter some kind
of failure.</p>
<div class="refsect3">
<a name="anjuta-command-set-error-message.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error_message</p></td>
<td class="parameter_description"><p>Error message.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-get-error-message"></a><h3>anjuta_command_get_error_message ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
anjuta_command_get_error_message (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>);</pre>
<p>Get the error message from the command, if there is one. This method is
normally used from a ::command-finished handler to report errors to the user
when a command finishes.</p>
<div class="refsect3">
<a name="anjuta-command-get-error-message.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="anjuta-command-get-error-message.returns"></a><h4>Returns</h4>
<p>Error message string that must
be freed when no longer needed. If no error is set, return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-start-automatic-monitor"></a><h3>anjuta_command_start_automatic_monitor ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
anjuta_command_start_automatic_monitor
(<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>);</pre>
<p>Sets up any monitoring needed for commands that should start themselves
automatically in response to some event.</p>
<div class="refsect3">
<a name="anjuta-command-start-automatic-monitor.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="anjuta-command-start-automatic-monitor.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if automatic starting is supported by the command and
no errors were encountered; <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if automatic starting is unsupported or on
error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-command-stop-automatic-monitor"></a><h3>anjuta_command_stop_automatic_monitor ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_command_stop_automatic_monitor (<em class="parameter"><code><a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *self</code></em>);</pre>
<p>Stops automatic monitoring for self executing commands. For commands that
do not support self-starting, this function does nothing.</p>
<div class="refsect3">
<a name="anjuta-command-stop-automatic-monitor.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>Command object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="AnjutaCommand.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AnjutaCommandPriv"></a><h3>AnjutaCommandPriv</h3>
<pre class="programlisting">typedef struct _AnjutaCommandPriv AnjutaCommandPriv;</pre>
</div>
</div>
<div class="refsect1">
<a name="AnjutaCommand.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="AnjutaCommand-command-finished"></a><h3>The <code class="literal">“command-finished”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *command,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> return_code,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Indicates that the command has completed. Clients should at least handle
this signal to unref the command object.</p>
<div class="note"><p>
Sublasses that override the method for this signal should chain up to
the parent implementation to ensure proper handling of running/not
running states.
</p></div>
<div class="refsect3">
<a name="AnjutaCommand-command-finished.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>command</p></td>
<td class="parameter_description"><p>Command</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>return_code</p></td>
<td class="parameter_description"><p>The return code of the finished commmand</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaCommand-command-started"></a><h3>The <code class="literal">“command-started”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *anjutacommand,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaCommand-data-arrived"></a><h3>The <code class="literal">“data-arrived”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *command,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Notifies clients that the command has processed data that is ready to
be used.</p>
<div class="refsect3">
<a name="AnjutaCommand-data-arrived.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>command</p></td>
<td class="parameter_description"><p>Command</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaCommand-progress"></a><h3>The <code class="literal">“progress”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AnjutaCommand.html" title="AnjutaCommand"><span class="type">AnjutaCommand</span></a> *command,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> progress,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Notifies clients of changes in progress during command execution.</p>
<div class="refsect3">
<a name="AnjutaCommand-progress.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>command</p></td>
<td class="parameter_description"><p>Command</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>Fraction of the command's task that is complete, between 0.0
and 1.0, inclusive.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
</div>
<div class="refsect1">
<a name="AnjutaCommand.see-also"></a><h2>See Also</h2>
<p><a class="link" href="AnjutaAsyncCommand.html" title="AnjutaAsyncCommand"><span class="type">AnjutaAsyncCommand</span></a>, <a class="link" href="AnjutaSyncCommand.html" title="AnjutaSyncCommand"><span class="type">AnjutaSyncCommand</span></a>
<em class="parameter"><code>include</code></em>
libanjuta/anjuta-command.h</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|