/usr/include/gtkmm-2.4/gtkmm/action.h is in libgtkmm-2.4-dev 1:2.24.5-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 934 935 936 937 938 939 940 941 942 943 944 945 946 | // -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_ACTION_H
#define _GTKMM_ACTION_H
#include <gtkmmconfig.h>
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2003 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gtkmm/widget.h>
#include <gtkmm/accelgroup.h>
#include <gtkmm/stockid.h>
#include <giomm/icon.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkAction GtkAction;
typedef struct _GtkActionClass GtkActionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class Action_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{
class ActionGroup;
class Menu;
class MenuItem;
class ToolItem;
class Image;
/** An action which can be triggered by a menu or toolbar item.
*
* Actions represent operations that the user can perform, along with
* some information about how it should be presented in the user interface.
* Each action provides methods to create icons, menu items and toolbar
* items representing itself.
*
* As well as the callback that is called when the action is activated,
* the following is also associated with the action:
*
* - a name (not translated, for path lookup)
* - a label (translated, for display)
* - an accelerator
* - whether the label indicates a stock id
* - a tooltip (optional, translated)
* - a toolbar label (optional, shorter than label)
*
* The action will also have some state information:
*
* - visible (shown/hidden)
* - sensitive (enabled/disabled)
*
* Apart from regular actions, there are toggle actions,
* which can be toggled between two states and radio actions,
* of which only one in a group can be in the "active" state.
* Other actions can be implemented as Gtk::Action subclasses.
*
* Each action can have one or more proxy menu item, toolbar button or other proxy widgets.
* Proxies mirror the state of the action (text label, tooltip, icon, visible, sensitive, etc), and should change when the action's state changes. When the proxy is activated, it should activate its action.
*/
class Action : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Action CppObjectType;
typedef Action_Class CppClassType;
typedef GtkAction BaseObjectType;
typedef GtkActionClass BaseClassType;
private: friend class Action_Class;
static CppClassType action_class_;
private:
// noncopyable
Action(const Action&);
Action& operator=(const Action&);
protected:
explicit Action(const Glib::ConstructParams& construct_params);
explicit Action(GtkAction* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Action();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GtkAction* gobj() { return reinterpret_cast<GtkAction*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkAction* gobj() const { return reinterpret_cast<GtkAction*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GtkAction* gobj_copy();
private:
protected:
/** Creates an empty action. */
Action();
/** Creates an action with a stock ID.
* The stock ID is used to set a default icon, text and accelerator for the
* action.
*
* @param name A unique name for the action.
* @param stock_id The stock icon to display in widgets representing the
* action.
* @param label The label displayed in menu items and on buttons.
* @param tooltip A tooltip for the action.
*/
explicit Action(const Glib::ustring& name, const StockID& stock_id = StockID(), const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
/** Creates an action with an icon name.
* The action's icon will reflect the specified icon name in the user's
* icon theme.
*
* @param name A unique name for the action.
* @param icon_name An IconTheme icon name used for widgets representing the
* action.
* @param label The label displayed in menu items and on buttons.
* @param tooltip A tooltip for the action.
*/
explicit Action(const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
public:
//Note that gtk_action_new() does not allow name to be NULL, which suggests that we should not have a default constructor,
//but it's OK to set the name later:
static Glib::RefPtr<Action> create();
/** Creates an action.
*
* @param name A unique name for the action.
* @param label The label displayed in menu items and on buttons.
* @param tooltip A tooltip for the action.
*
* @return A new Action.
*/
static Glib::RefPtr<Action> create(const Glib::ustring& name, const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
/** Creates an action with a stock ID.
* The stock ID is used to set a default icon, text and accelerator for the
* action.
*
* @param name A unique name for the action.
* @param stock_id The stock icon to display in widgets representing the
* action.
* @param label The label displayed in menu items and on buttons.
* @param tooltip A tooltip for the action.
*
* @return A new Action.
*/
static Glib::RefPtr<Action> create(const Glib::ustring& name, const Gtk::StockID& stock_id, const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
/** Create an action with an icon name.
* The action's icon will reflect the specified icon name in the user's
* icon theme.
*
* @param name A unique name for the action.
* @param icon_name An IconTheme icon name used for widgets representing the
* action.
* @param label The label displayed in menu items and on buttons.
* @param tooltip A tooltip for the action.
*
* @return A new Action.
*/
static Glib::RefPtr<Action> create_with_icon_name(const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label, const Glib::ustring& tooltip);
/** Returns the name of the action.
*
* @newin{2,4}
*
* @return The name of the action. The string belongs to GTK+ and should not
* be freed.
*/
Glib::ustring get_name() const;
/** Returns whether the action is effectively sensitive.
*
* @newin{2,4}
*
* @return <tt>true</tt> if the action and its associated action group
* are both sensitive.
*/
bool is_sensitive() const;
/** Returns whether the action itself is sensitive. Note that this doesn't
* necessarily mean effective sensitivity. See is_sensitive()
* for that.
*
* @newin{2,4}
*
* @return <tt>true</tt> if the action itself is sensitive.
*/
bool get_sensitive() const;
/** Sets the property_sensitive() property of the action to @a sensitive. Note that
* this doesn't necessarily mean effective sensitivity. See
* is_sensitive()
* for that.
*
* @newin{2,6}
*
* @param sensitive <tt>true</tt> to make the action sensitive.
*/
void set_sensitive(bool sensitive = true);
/** Returns whether the action is effectively visible.
*
* @newin{2,4}
*
* @return <tt>true</tt> if the action and its associated action group
* are both visible.
*/
bool is_visible() const;
/** Returns whether the action itself is visible. Note that this doesn't
* necessarily mean effective visibility. See is_sensitive()
* for that.
*
* @newin{2,4}
*
* @return <tt>true</tt> if the action itself is visible.
*/
bool get_visible() const;
/** Sets the property_visible() property of the action to @a visible. Note that
* this doesn't necessarily mean effective visibility. See
* is_visible()
* for that.
*
* @newin{2,6}
*
* @param visible <tt>true</tt> to make the action visible.
*/
void set_visible(bool visible = true);
/** Emits the "activate" signal on the specified action, if it isn't
* insensitive. This gets called by the proxy widgets when they get
* activated.
*
* It can also be used to manually activate an action.
*
* @newin{2,4}
*/
void activate();
/** This function is intended for use by action implementations to
* create icons displayed in the proxy widgets.
*
* @newin{2,4}
*
* @param icon_size The size of the icon that should be created.
* @return A widget that displays the icon for this action.
*/
Image* create_icon(IconSize icon_size);
/** Creates a menu item widget that proxies for the given action.
*
* @newin{2,4}
*
* @return A menu item connected to the action.
*/
MenuItem* create_menu_item();
/** Creates a toolbar item widget that proxies for the given action.
*
* @newin{2,4}
*
* @return A toolbar item connected to the action.
*/
ToolItem* create_tool_item();
/** If @a action provides a Gtk::Menu widget as a submenu for the menu
* item or the toolbar item it creates, this function returns an
* instance of that menu.
*
* @newin{2,12}
*
* @return The menu item provided by the
* action, or <tt>0</tt>.
*/
Menu* create_menu();
//TODO: Deprecate these when we can derive the appropriate widgets from Activatable, when we can break ABI.
/** Connects a widget to an action object as a proxy. Synchronises
* various properties of the action with the widget (such as label
* text, icon, tooltip, etc), and attaches a callback so that the
* action gets activated when the proxy widget does.
*
* If the widget is already connected to an action, it is disconnected
* first.
*
* @newin{2,4}
*
* Deprecated: 2.16: Use Gtk::Activatable::set_related_action() instead.
*
* @param proxy The proxy widget.
*/
void connect_proxy(Widget& proxy);
/** Disconnects a proxy widget from an action.
* Does <em>not</em> destroy the widget, however.
*
* @newin{2,4}
*
* Deprecated: 2.16: Use Gtk::Activatable::set_related_action() instead.
*
* @param proxy The proxy widget.
*/
void disconnect_proxy(Widget& proxy);
/** Returns the proxy widgets for an action.
* See also Gtk::Widget::get_action().
*
* @newin{2,4}
*
* @return A SList of proxy widgets. The list is owned by GTK+
* and must not be modified.
*/
Glib::SListHandle<Widget*> get_proxies();
/** Returns the proxy widgets for an action.
* See also Gtk::Widget::get_action().
*
* @newin{2,4}
*
* @return A SList of proxy widgets. The list is owned by GTK+
* and must not be modified.
*/
Glib::SListHandle<const Widget*> get_proxies() const;
/** Installs the accelerator for @a action if @a action has an
* accel path and group. See set_accel_path() and
* set_accel_group()
*
* Since multiple proxies may independently trigger the installation
* of the accelerator, the @a action counts the number of times this
* function has been called and doesn't remove the accelerator until
* disconnect_accelerator() has been called as many times.
*
* @newin{2,4}
*/
void connect_accelerator();
/** Undoes the effect of one call to connect_accelerator().
*
* @newin{2,4}
*/
void disconnect_accelerator();
/** Returns the accel path for this action.
*
* @newin{2,6}
*
* @return The accel path for this action, or <tt>0</tt>
* if none is set. The returned string is owned by GTK+
* and must not be freed or modified.
*/
Glib::ustring get_accel_path() const;
/// For instance, void on_activate();
typedef sigc::slot<void> SlotActivate;
/** The "activate" signal is emitted when the action is activated.
*
* @par Slot Prototype:
* <tt>void on_my_%activate()</tt>
*
*/
Glib::SignalProxy0< void > signal_activate();
//Used by AccelGroup:
/** Sets the accel path for this action. All proxy widgets associated
* with the action will have this accel path, so that their
* accelerators are consistent.
*
* Note that @a accel_path string will be stored in a Quark. Therefore, if you
* pass a static string, you can save some memory by interning it first with
* Glib::intern_static_string().
*
* @newin{2,4}
*
* @param accel_path The accelerator path.
*/
void set_accel_path(const Glib::ustring& accel_path);
/** Sets the Gtk::AccelGroup in which the accelerator for this action
* will be installed.
*
* @newin{2,4}
*
* @param accel_group A Gtk::AccelGroup or <tt>0</tt>.
*/
void set_accel_group(const Glib::RefPtr<AccelGroup>& accel_group);
/** Sets the label of @a action.
*
* @newin{2,16}
*
* @param label The label text to set.
*/
void set_label(const Glib::ustring& label);
/** Gets the label text of @a action.
*
* @newin{2,16}
*
* @return The label text.
*/
Glib::ustring get_label() const;
/** Sets a shorter label text on @a action.
*
* @newin{2,16}
*
* @param short_label The label text to set.
*/
void set_short_label(const Glib::ustring& short_label);
/** Gets the short label text of @a action.
*
* @newin{2,16}
*
* @return The short label text.
*/
Glib::ustring get_short_label() const;
/** Sets the tooltip text on @a action
*
* @newin{2,16}
*
* @param tooltip The tooltip text.
*/
void set_tooltip(const Glib::ustring& tooltip);
/** Gets the tooltip text of @a action.
*
* @newin{2,16}
*
* @return The tooltip text.
*/
Glib::ustring get_tooltip() const;
/** Sets the stock id on @a action
*
* @newin{2,16}
*
* @param stock_id The stock id.
*/
void set_stock_id(const StockID& stock_id);
/** Gets the stock id of @a action.
*
* @newin{2,16}
*
* @return The stock id.
*/
StockID get_stock_id() const;
/** Sets the icon of @a action.
*
* @newin{2,16}
*
* @param icon The Icon to set.
*/
void set_gicon(const Glib::RefPtr<Gio::Icon>& icon);
/** Gets the gicon of @a action.
*
* @newin{2,16}
*
* @return The action's Icon if one is set.
*/
Glib::RefPtr<Gio::Icon> get_gicon();
/** Gets the gicon of @a action.
*
* @newin{2,16}
*
* @return The action's Icon if one is set.
*/
Glib::RefPtr<const Gio::Icon> get_gicon() const;
/** Sets the icon name on @a action
*
* @newin{2,16}
*
* @param icon_name The icon name to set.
*/
void set_icon_name(const Glib::ustring& icon_name);
/** Gets the icon name of @a action.
*
* @newin{2,16}
*
* @return The icon name.
*/
Glib::ustring get_icon_name() const;
/** Sets whether @a action is visible when horizontal
*
* @newin{2,16}
*
* @param visible_horizontal Whether the action is visible horizontally.
*/
void set_visible_horizontal(bool visible_horizontal = true);
/** Checks whether @a action is visible when horizontal
*
* @newin{2,16}
*
* @return Whether @a action is visible when horizontal.
*/
bool get_visible_horizontal() const;
/** Sets whether @a action is visible when vertical
*
* @newin{2,16}
*
* @param visible_vertical Whether the action is visible vertically.
*/
void set_visible_vertical(bool visible_vertical = true);
/** Checks whether @a action is visible when horizontal
*
* @newin{2,16}
*
* @return Whether @a action is visible when horizontal.
*/
bool get_visible_vertical() const;
/** Sets whether the action is important, this attribute is used
* primarily by toolbar items to decide whether to show a label
* or not.
*
* @newin{2,16}
*
* @param is_important <tt>true</tt> to make the action important.
*/
void set_is_important(bool is_important = true);
/** Checks whether @a action is important or not
*
* @newin{2,16}
*
* @return Whether @a action is important.
*/
bool get_is_important() const;
/** Sets whether @a action<!-- -->'s menu item proxies will ignore the
* Gtk::Settings::property_gtk_menu_images() setting and always show their image, if available.
*
* Use this if the menu item would be useless or hard to use
* without their image.
*
* @newin{2,20}
*
* @param always_show <tt>true</tt> if menuitem proxies should always show their image.
*/
void set_always_show_image(bool always_show = true);
/** Returns whether @a action<!-- -->'s menu item proxies will ignore the
* Gtk::Settings::property_gtk_menu_images() setting and always show their image,
* if available.
*
* @newin{2,20}
*
* @return <tt>true</tt> if the menu item proxies will always show their image.
*/
bool get_always_show_image() const;
/** Disable activation signals from the action
*
* This is needed when updating the state of your proxy
* Gtk::Activatable widget could result in calling activate(),
* this is a convenience function to avoid recursing in those
* cases (updating toggle state for instance).
*
* @newin{2,16}
*/
void block_activate();
/** Reenable activation signals from the action
*
* @newin{2,16}
*/
void unblock_activate();
//gtk_action_get_accel_closure() is too C-specific:
/** A unique name for the action.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name() const;
/** The label used for menu items and buttons that activate this action.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_label() ;
/** The label used for menu items and buttons that activate this action.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_label() const;
/** A shorter label that may be used on toolbar buttons.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_short_label() ;
/** A shorter label that may be used on toolbar buttons.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_short_label() const;
/** A tooltip for this action.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_tooltip() ;
/** A tooltip for this action.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip() const;
/** The stock icon displayed in widgets representing this action.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< StockID > property_stock_id() ;
/** The stock icon displayed in widgets representing this action.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< StockID > property_stock_id() const;
/** The GIcon being displayed.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > property_gicon() ;
/** The GIcon being displayed.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > property_gicon() const;
/** The name of the icon from the icon theme.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_icon_name() ;
/** The name of the icon from the icon theme.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name() const;
/** Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_visible_horizontal() ;
/** Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_visible_horizontal() const;
/** Whether the toolbar item is visible when the toolbar is in a vertical orientation.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_visible_vertical() ;
/** Whether the toolbar item is visible when the toolbar is in a vertical orientation.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_visible_vertical() const;
/** When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_visible_overflown() ;
/** When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_visible_overflown() const;
/** Whether the action is considered important. When TRUE, toolitem proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_is_important() ;
/** Whether the action is considered important. When TRUE, toolitem proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_is_important() const;
/** When TRUE, empty menu proxies for this action are hidden.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_hide_if_empty() ;
/** When TRUE, empty menu proxies for this action are hidden.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_hide_if_empty() const;
/** Whether the action is enabled.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_sensitive() ;
/** Whether the action is enabled.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_sensitive() const;
/** Whether the action is visible.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_visible() ;
/** Whether the action is visible.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_visible() const;
/** The GtkActionGroup this GtkAction is associated with, or NULL (for internal use).
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<ActionGroup> > property_action_group() ;
/** The GtkActionGroup this GtkAction is associated with, or NULL (for internal use).
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<ActionGroup> > property_action_group() const;
/** Whether the image will always be shown.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_always_show_image() ;
/** Whether the image will always be shown.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_always_show_image() const;
protected:
//For use by child actions:
//TODO: Deprecate these when we can derive the appropriate widgets from Activatable, when we can break ABI.
/** Disables calls to the activate()
* function by signals on the given proxy widget. This is used to
* break notification loops for things like check or radio actions.
*
* This function is intended for use by action implementations.
*
* @newin{2,4}
*
* Deprecated: 2.16: activatables are now responsible for activating the
* action directly so this doesnt apply anymore.
*
* @param proxy A proxy widget.
*/
void block_activate_from(Widget& proxy);
/** Re-enables calls to the activate()
* function by signals on the given proxy widget. This undoes the
* blocking done by block_activate_from().
*
* This function is intended for use by action implementations.
*
* @newin{2,4}
*
* Deprecated: 2.16: activatables are now responsible for activating the
* action directly so this doesnt apply anymore.
*
* @param proxy A proxy widget.
*/
void unblock_activate_from(Widget& proxy);
protected:
//Widget-creation routines:
virtual Widget* create_menu_item_vfunc();
virtual Widget* create_tool_item_vfunc();
virtual void connect_proxy_vfunc(Widget* proxy);
virtual void disconnect_proxy_vfunc(Widget* proxy);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_activate().
virtual void on_activate();
};
} // namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::Action
*/
Glib::RefPtr<Gtk::Action> wrap(GtkAction* object, bool take_copy = false);
}
#endif /* _GTKMM_ACTION_H */
|