/usr/share/gtk-doc/html/polkit-gtk-mate-1/PolkitLockButton.html is in libmatepolkit-doc 1.16.0-2.
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 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PolkitLockButton: PolicyKit-GTK+ Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="PolicyKit-GTK+ Reference Manual">
<link rel="up" href="ref-gtk-api.html" title="Part I. API Reference">
<link rel="prev" href="ref-gtk-api.html" title="Part I. API Reference">
<link rel="next" href="polkit-gtk-hierarchy.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.25 (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="#PolkitLockButton.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#PolkitLockButton.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#PolkitLockButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#PolkitLockButton.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#PolkitLockButton.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="ref-gtk-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ref-gtk-api.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="polkit-gtk-hierarchy.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="PolkitLockButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PolkitLockButton.top_of_page"></a>PolkitLockButton</span></h2>
<p>PolkitLockButton — Widget for obtaining/revoking authorizations</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="PolkitLockButton.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="PolkitLockButton.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">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="PolkitLockButton.html#polkit-lock-button-new" title="polkit_lock_button_new ()">polkit_lock_button_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PolkitLockButton.html#polkit-lock-button-get-is-authorized" title="polkit_lock_button_get_is_authorized ()">polkit_lock_button_get_is_authorized</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PolkitLockButton.html#polkit-lock-button-get-is-visible" title="polkit_lock_button_get_is_visible ()">polkit_lock_button_get_is_visible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PolkitLockButton.html#polkit-lock-button-get-can-obtain" title="polkit_lock_button_get_can_obtain ()">polkit_lock_button_get_can_obtain</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="PolkitLockButton.html#polkit-lock-button-set-unlock-text" title="polkit_lock_button_set_unlock_text ()">polkit_lock_button_set_unlock_text</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="PolkitLockButton.html#polkit-lock-button-set-unlock-tooltip" title="polkit_lock_button_set_unlock_tooltip ()">polkit_lock_button_set_unlock_tooltip</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="PolkitLockButton.html#polkit-lock-button-set-lock-text" title="polkit_lock_button_set_lock_text ()">polkit_lock_button_set_lock_text</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="PolkitLockButton.html#polkit-lock-button-set-lock-tooltip" title="polkit_lock_button_set_lock_tooltip ()">polkit_lock_button_set_lock_tooltip</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="PolkitLockButton.html#polkit-lock-button-set-lock-down-text" title="polkit_lock_button_set_lock_down_text ()">polkit_lock_button_set_lock_down_text</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="PolkitLockButton.html#polkit-lock-button-set-lock-down-tooltip" title="polkit_lock_button_set_lock_down_tooltip ()">polkit_lock_button_set_lock_down_tooltip</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="PolkitLockButton.html#polkit-lock-button-set-not-authorized-text" title="polkit_lock_button_set_not_authorized_text ()">polkit_lock_button_set_not_authorized_text</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="PolkitLockButton.html#polkit-lock-button-set-not-authorized-tooltip" title="polkit_lock_button_set_not_authorized_tooltip ()">polkit_lock_button_set_not_authorized_tooltip</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PolkitLockButton.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--action-id" title="The “action-id” property">action-id</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--can-obtain" title="The “can-obtain” property">can-obtain</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--is-authorized" title="The “is-authorized” property">is-authorized</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--is-visible" title="The “is-visible” property">is-visible</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--text-lock" title="The “text-lock” property">text-lock</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--text-lock-down" title="The “text-lock-down” property">text-lock-down</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--text-not-authorized" title="The “text-not-authorized” property">text-not-authorized</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--text-unlock" title="The “text-unlock” property">text-unlock</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--tooltip-lock" title="The “tooltip-lock” property">tooltip-lock</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--tooltip-lock-down" title="The “tooltip-lock-down” property">tooltip-lock-down</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--tooltip-not-authorized" title="The “tooltip-not-authorized” property">tooltip-not-authorized</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PolkitLockButton.html#PolkitLockButton--tooltip-unlock" title="The “tooltip-unlock” property">tooltip-unlock</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PolkitLockButton.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="PolkitLockButton.html#PolkitLockButton-changed" title="The “changed” signal">changed</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PolkitLockButton.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="PolkitLockButton.html#PolkitLockButton-struct" title="PolkitLockButton">PolkitLockButton</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="PolkitLockButton.html#PolkitLockButtonClass" title="struct PolkitLockButtonClass">PolkitLockButtonClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PolkitLockButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> GtkWidget
<span class="lineart">╰──</span> GtkContainer
<span class="lineart">╰──</span> GtkBox
<span class="lineart">╰──</span> PolkitLockButton
</pre>
</div>
<div class="refsect1">
<a name="PolkitLockButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
PolkitLockButton implements
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
</div>
<div class="refsect1">
<a name="PolkitLockButton.description"></a><h2>Description</h2>
<p><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> is a widget that can be used in control panels to
allow users to obtain and revoke authorizations needed for the
control panel UI to function.</p>
<p>If the user lacks the authorization but authorization can be
obtained through authentication, the widget looks like this</p>
<div class="mediaobject">
<a name="lock-button-locked"></a><img src="polkit-lock-button-locked.png">
</div>
<p>and the user can click the button to obtain the authorization. This
will pop up an authentication dialog.
Once authorization is obtained, the widget changes to this</p>
<div class="mediaobject">
<a name="lock-button-unlocked"></a><img src="polkit-lock-button-unlocked.png">
</div>
<p>and the authorization can be dropped by clicking the button.
If the user is not able to obtain authorization at all, the widget
looks like this</p>
<div class="mediaobject">
<a name="lock-button-unlocked-not-authorized"></a><img src="polkit-lock-button-not-authorized.png">
</div>
<p>If the user is authorized (either implicitly via the .policy file
defaults or through e.g. Local Authority configuration) and no
authentication is necessary and the Authority Implementation
supports lock-down, the widget looks like this</p>
<div class="mediaobject">
<a name="lock-button-unlocked-lock-down"></a><img src="polkit-lock-button-lock-down.png">
</div>
<p>allowing the user to lock down the action. The lockdown can be
removed by right clicking the button - the user can discover this
through the tooltip. If the Authority implementation does not
support lockdown, the widget will be hidden.</p>
<p>Finally, if the user is not authorized but authorization can be
obtained and the obtained authorization will be a one-shot
authorization, the widget will be hidden. This means that any
attempt to use the Mechanism that requires authorization for the
specified action will always prompt for authentication. This
condition happens exactly when
(!<a class="link" href="PolkitLockButton.html#polkit-lock-button-get-is-authorized" title="polkit_lock_button_get_is_authorized ()"><code class="function">polkit_lock_button_get_is_authorized()</code></a> &&
<a class="link" href="PolkitLockButton.html#polkit-lock-button-get-can-obtain" title="polkit_lock_button_get_can_obtain ()"><code class="function">polkit_lock_button_get_can_obtain()</code></a> &&
!<a class="link" href="PolkitLockButton.html#polkit-lock-button-get-is-visible" title="polkit_lock_button_get_is_visible ()"><code class="function">polkit_lock_button_get_is_visible()</code></a>) is <code class="literal">TRUE</code>.</p>
<p>Typically <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> is only useful for actions where
authorization is obtained through authentication (and retained) or
where users are implictly authorized (cf. the defaults specified in
the <code class="literal">.policy</code> file for the action) but note that
this behavior can be overridden by the Authority implementation.</p>
<p>The typical usage of this widget is like this:</p>
<pre class="programlisting">
static void
update_sensitivity_according_to_lock_button (FooBar *bar)
{
gboolean make_sensitive;
make_sensitive = FALSE;
if (polkit_lock_button_get_is_authorized (POLKIT_LOCK_BUTTON (bar->priv->lock_button)))
{
make_sensitive = TRUE;
}
else
{
/* Catch the case where authorization is one-shot - this means
* an authentication dialog will be shown every time a widget the user
* manipulates calls into the Mechanism.
*/
if (polkit_lock_button_get_can_obtain (POLKIT_LOCK_BUTTON (bar->priv->lock_button)) &&
!polkit_lock_button_get_is_visible (POLKIT_LOCK_BUTTON (bar->priv->lock_button)))
make_sensitive = TRUE;
}
/* Make all widgets relying on authorization sensitive according to
* the value of make_sensitive.
*/
}
static void
on_lock_button_changed (PolkitLockButton *button,
gpointer user_data)
{
FooBar *bar = FOO_BAR (user_data);
update_sensitivity_according_to_lock_button (bar);
}
static void
foo_bar_init (FooBar *bar)
{
/* Construct other widgets */
bar->priv->lock_button = polkit_lock_button_new ("org.project.mechanism.action-name");
g_signal_connect (bar->priv->lock_button,
"changed",
G_CALLBACK (on_lock_button_changed),
bar);
update_sensitity_according_to_lock_button (bar);
/* Pack bar->priv->lock_button into widget hierarchy */
}
</pre>
</div>
<div class="refsect1">
<a name="PolkitLockButton.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="polkit-lock-button-new"></a><h3>polkit_lock_button_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
polkit_lock_button_new (<em class="parameter"><code>const <span class="type">gchar</span> *action_id</code></em>);</pre>
<p>Constructs a <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> for <em class="parameter"><code>action_id</code></em>
.</p>
<div class="refsect3">
<a name="polkit-lock-button-new.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>action_id</p></td>
<td class="parameter_description"><p>An action identifer.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="polkit-lock-button-new.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-get-is-authorized"></a><h3>polkit_lock_button_get_is_authorized ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
polkit_lock_button_get_is_authorized (<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>);</pre>
<p>Gets whether the process is authorized.</p>
<div class="refsect3">
<a name="polkit-lock-button-get-is-authorized.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="polkit-lock-button-get-is-authorized.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if authorized.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-get-is-visible"></a><h3>polkit_lock_button_get_is_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
polkit_lock_button_get_is_visible (<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>);</pre>
<p>Gets whether <em class="parameter"><code>button</code></em>
is currently being shown.</p>
<div class="refsect3">
<a name="polkit-lock-button-get-is-visible.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="polkit-lock-button-get-is-visible.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>button</code></em>
has any visible UI elements.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-get-can-obtain"></a><h3>polkit_lock_button_get_can_obtain ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
polkit_lock_button_get_can_obtain (<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>);</pre>
<p>Gets whether the user can obtain an authorization through
authentication.</p>
<div class="refsect3">
<a name="polkit-lock-button-get-can-obtain.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="polkit-lock-button-get-can-obtain.returns"></a><h4>Returns</h4>
<p> Whether the authorization is obtainable.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-set-unlock-text"></a><h3>polkit_lock_button_set_unlock_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
polkit_lock_button_set_unlock_text (<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>Makes <em class="parameter"><code>button</code></em>
display <em class="parameter"><code>text</code></em>
when not authorized and clicking the button will obtain the authorization.</p>
<div class="refsect3">
<a name="polkit-lock-button-set-unlock-text.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>The text to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-set-unlock-tooltip"></a><h3>polkit_lock_button_set_unlock_tooltip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
polkit_lock_button_set_unlock_tooltip (<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip</code></em>);</pre>
<p>Makes <em class="parameter"><code>button</code></em>
display <em class="parameter"><code>tooltip</code></em>
when not authorized and clicking the button will obtain the authorization.</p>
<div class="refsect3">
<a name="polkit-lock-button-set-unlock-tooltip.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>The text of the tooltip.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-set-lock-text"></a><h3>polkit_lock_button_set_lock_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
polkit_lock_button_set_lock_text (<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>Makes <em class="parameter"><code>button</code></em>
display <em class="parameter"><code>text</code></em>
when authorized and clicking the button will revoke the authorization.</p>
<div class="refsect3">
<a name="polkit-lock-button-set-lock-text.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>The text to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-set-lock-tooltip"></a><h3>polkit_lock_button_set_lock_tooltip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
polkit_lock_button_set_lock_tooltip (<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip</code></em>);</pre>
<p>Makes <em class="parameter"><code>button</code></em>
display <em class="parameter"><code>tooltip</code></em>
when authorized and clicking the button will revoke the authorization.</p>
<div class="refsect3">
<a name="polkit-lock-button-set-lock-tooltip.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>The text of the tooltip.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-set-lock-down-text"></a><h3>polkit_lock_button_set_lock_down_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
polkit_lock_button_set_lock_down_text (<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>Makes <em class="parameter"><code>button</code></em>
display <em class="parameter"><code>text</code></em>
when authorized and it is possible to lock down the action.</p>
<div class="refsect3">
<a name="polkit-lock-button-set-lock-down-text.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>The text to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-set-lock-down-tooltip"></a><h3>polkit_lock_button_set_lock_down_tooltip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
polkit_lock_button_set_lock_down_tooltip
(<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip</code></em>);</pre>
<p>Makes <em class="parameter"><code>button</code></em>
display <em class="parameter"><code>tooltip</code></em>
when authorized and it is possible to lock down the action.</p>
<div class="refsect3">
<a name="polkit-lock-button-set-lock-down-tooltip.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>The text of the tooltip.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-set-not-authorized-text"></a><h3>polkit_lock_button_set_not_authorized_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
polkit_lock_button_set_not_authorized_text
(<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>Makes <em class="parameter"><code>button</code></em>
display <em class="parameter"><code>text</code></em>
when an authorization cannot be obtained.</p>
<div class="refsect3">
<a name="polkit-lock-button-set-not-authorized-text.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>The text to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-lock-button-set-not-authorized-tooltip"></a><h3>polkit_lock_button_set_not_authorized_tooltip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
polkit_lock_button_set_not_authorized_tooltip
(<em class="parameter"><code><a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip</code></em>);</pre>
<p>Makes <em class="parameter"><code>button</code></em>
display <em class="parameter"><code>tooltip</code></em>
when an authorization cannot be obtained.</p>
<div class="refsect3">
<a name="polkit-lock-button-set-not-authorized-tooltip.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>The text of the tooltip.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="PolkitLockButton.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="PolkitLockButton-struct"></a><h3>PolkitLockButton</h3>
<pre class="programlisting">typedef struct _PolkitLockButton PolkitLockButton;</pre>
<p>The <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> structure contains only private data and
should be accessed using the provided API.</p>
<div class="refsect3">
<a name="PolkitLockButton.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButtonClass"></a><h3>struct PolkitLockButtonClass</h3>
<pre class="programlisting">struct PolkitLockButtonClass {
GtkBoxClass parent_class;
/* Signals */
void (*changed)(PolkitLockButton* button);
};
</pre>
<p>Class structure for <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</p>
<div class="refsect3">
<a name="PolkitLockButtonClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="PolkitLockButtonClass.changed"></a>changed</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal class handler for the <a class="link" href="PolkitLockButton.html#PolkitLockButton-changed" title="The “changed” signal"><span class="type">“changed”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="PolkitLockButton.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="PolkitLockButton--action-id"></a><h3>The <code class="literal">“action-id”</code> property</h3>
<pre class="programlisting"> “action-id” <span class="type">gchar</span> *</pre>
<p>The action identifier to use for the button.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--can-obtain"></a><h3>The <code class="literal">“can-obtain”</code> property</h3>
<pre class="programlisting"> “can-obtain” <span class="type">gboolean</span></pre>
<p>Whether authorization can be obtained.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--is-authorized"></a><h3>The <code class="literal">“is-authorized”</code> property</h3>
<pre class="programlisting"> “is-authorized” <span class="type">gboolean</span></pre>
<p>Whether the process is authorized.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--is-visible"></a><h3>The <code class="literal">“is-visible”</code> property</h3>
<pre class="programlisting"> “is-visible” <span class="type">gboolean</span></pre>
<p>Whether the widget is visible.</p>
<p>Flags: Read</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--text-lock"></a><h3>The <code class="literal">“text-lock”</code> property</h3>
<pre class="programlisting"> “text-lock” <span class="type">gchar</span> *</pre>
<p>The text to display when prompting the user to lock.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "Click to prevent changes"</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--text-lock-down"></a><h3>The <code class="literal">“text-lock-down”</code> property</h3>
<pre class="programlisting"> “text-lock-down” <span class="type">gchar</span> *</pre>
<p>The text to display when prompting the user to lock down the action for all users.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "Click to lock down"</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--text-not-authorized"></a><h3>The <code class="literal">“text-not-authorized”</code> property</h3>
<pre class="programlisting"> “text-not-authorized” <span class="type">gchar</span> *</pre>
<p>The text to display when the user cannot obtain authorization through authentication.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "Not authorized to make changes"</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--text-unlock"></a><h3>The <code class="literal">“text-unlock”</code> property</h3>
<pre class="programlisting"> “text-unlock” <span class="type">gchar</span> *</pre>
<p>The text to display when prompting the user to unlock.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "Click to make changes"</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--tooltip-lock"></a><h3>The <code class="literal">“tooltip-lock”</code> property</h3>
<pre class="programlisting"> “tooltip-lock” <span class="type">gchar</span> *</pre>
<p>The tooltip to display when prompting the user to lock.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "To prevent further changes, click the lock."</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--tooltip-lock-down"></a><h3>The <code class="literal">“tooltip-lock-down”</code> property</h3>
<pre class="programlisting"> “tooltip-lock-down” <span class="type">gchar</span> *</pre>
<p>The tooltip to display when prompting the user to lock down the action for all users.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "To prevent users without administrative privileges from making changes, click the lock."</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--tooltip-not-authorized"></a><h3>The <code class="literal">“tooltip-not-authorized”</code> property</h3>
<pre class="programlisting"> “tooltip-not-authorized” <span class="type">gchar</span> *</pre>
<p>The tooltip to display when the user cannot obtain authorization through authentication.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "System policy prevents changes. Contact your system administator."</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitLockButton--tooltip-unlock"></a><h3>The <code class="literal">“tooltip-unlock”</code> property</h3>
<pre class="programlisting"> “tooltip-unlock” <span class="type">gchar</span> *</pre>
<p>The tooltip to display when prompting the user to unlock.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "Authentication is needed to make changes."</p>
</div>
</div>
<div class="refsect1">
<a name="PolkitLockButton.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="PolkitLockButton-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a> *button,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when something on <em class="parameter"><code>button</code></em>
changes.</p>
<div class="refsect3">
<a name="PolkitLockButton-changed.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>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitLockButton.html" title="PolkitLockButton"><span class="type">PolkitLockButton</span></a>.</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: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|