/usr/include/gtkmm-3.0/gtkmm/action.h is in libgtkmm-3.0-dev 3.22.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 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 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 | // Generated by gmmproc 2.50.0 -- 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <vector>
#include <gtkmm/widget.h>
#include <gtkmm/accelgroup.h>
#include <giomm/icon.h>
//TODO: Do this when we can stop using Gtk::Action in virtual functions in Gtk::Activatable, when we break ABI:
//_IS_DEPRECATED // This whole file is deprecated.
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GtkAction = struct _GtkAction;
using GtkActionClass = struct _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; //deprecated
class Menu;
class MenuItem;
class ToolItem;
class Image;
class StockID; //deprecated
/** A deprecated 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.
*
* @deprecated Use Gio::Action and Gio::SimpleAction instead, and associate actions
* with Gtk::Actionable widgets. Use Gio::MenuModel for creating menus with
* Gtk::Menu(const Glib::RefPtr<Gio::MenuModel>& model).<br>
* Some gtkmm widgets don't derive from Gtk::Actionable, although the corresponding
* gtk+ widgets implement the GtkActionable interface. This discrepancy can't be
* fixed until we can break ABI. You can sometimes work around this problem
* by using a widget's %gobj() method and calling a gtk_actionable_*() method
* directly. Several examples in the
* <a href="https://developer.gnome.org/gtkmm-tutorial/stable/">Programming with gtkmm 3</a>
* book use Gio::SimpleAction, such as the menus and toolbars examples.
*/
class Action
: public Glib::Object,
public Buildable
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
using CppObjectType = Action;
using CppClassType = Action_Class;
using BaseObjectType = GtkAction;
using BaseClassType = GtkActionClass;
// noncopyable
Action(const Action&) = delete;
Action& operator=(const Action&) = delete;
private: friend class Action_Class;
static CppClassType action_class_;
protected:
explicit Action(const Glib::ConstructParams& construct_params);
explicit Action(GtkAction* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
Action(Action&& src) noexcept;
Action& operator=(Action&& src) noexcept;
~Action() noexcept override;
/** 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();
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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.
* @deprecated There is no corresponding replacement when using Gio::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.
* @deprecated See set_icon_name(), set_label() and set_tooltip() for
* replacements when using Gio::Action.
*/
explicit Action(const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
#endif // GTKMM_DISABLE_DEPRECATED
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();
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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.
* @deprecated See set_label() and set_tooltip() for replacements when using Gio::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.
* @deprecated There is no corresponding replacement when using Gio::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.
* @deprecated See set_icon_name(), set_label() and set_tooltip() for
* replacements when using Gio::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);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns the name of the action.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Glib::action_get_name() on a Action instead
*
* @deprecated Use Gio::Action::get_name() on a Gio::Action instead.
*
* @return The name of the action. The string belongs to GTK+ and should not
* be freed.
*/
Glib::ustring get_name() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns whether the action is effectively sensitive.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Glib::action_get_enabled() on a Action
* instead
*
* @deprecated Use Gio::Action::get_enabled() on a Gio::Action instead.
*
* @return <tt>true</tt> if the action and its associated action group
* are both sensitive.
*/
bool is_sensitive() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns whether the action itself is sensitive. Note that this doesn’t
* necessarily mean effective sensitivity. See is_sensitive()
* for that.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Glib::action_get_enabled() on a Action
* instead
*
* @deprecated Use Gio::Action::get_enabled() on a Gio::Action instead.
*
* @return <tt>true</tt> if the action itself is sensitive.
*/
bool get_sensitive() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the :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}
*
* Deprecated: 3.10: Use Glib::simple_action_set_enabled() on a SimpleAction
* instead
*
* @deprecated Use Gio::SimpleAction::set_enabled() on a Gio::SimpleAction instead.
*
* @param sensitive <tt>true</tt> to make the action sensitive.
*/
void set_sensitive(bool sensitive = true);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns whether the action is effectively visible.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Action instead, and control and monitor the state of
* Gtk::Actionable widgets directly
*
* @deprecated Use Gio::Action instead, and control and monitor the state of Gtk::Actionable widgets directly.
*
* @return <tt>true</tt> if the action and its associated action group
* are both visible.
*/
bool is_visible() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns whether the action itself is visible. Note that this doesn’t
* necessarily mean effective visibility. See is_sensitive()
* for that.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Action instead, and control and monitor the state of
* Gtk::Actionable widgets directly
*
* @deprecated Use Gio::Action instead, and control and monitor the state of Gtk::Actionable widgets directly.
*
* @return <tt>true</tt> if the action itself is visible.
*/
bool get_visible() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the :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}
*
* Deprecated: 3.10: Use Action instead, and control and monitor the state of
* Gtk::Actionable widgets directly
*
* @deprecated Use Gio::Action instead, and control and monitor the state of Gtk::Actionable widgets directly.
*
* @param visible <tt>true</tt> to make the action visible.
*/
void set_visible(bool visible = true);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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}
*
* Deprecated: 3.10: Use Glib::action_group_activate_action() on a Action instead
*
* @deprecated Use Gio::ActionGroup::activate_action() on a Gio::Action instead.
*/
void activate();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** This function is intended for use by action implementations to
* create icons displayed in the proxy widgets.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Glib::menu_item_set_icon() to set an icon on a MenuItem,
* or Gtk::Container::add() to add a Gtk::Image to a Gtk::Button
*
* @deprecated Use Gio::MenuItem::set_icon() to set an icon on a Gio::MenuItem, or Gtk::Container::add() to add a Gtk::Image to a Gtk::Button.
*
* @param icon_size The size of the icon (Gtk::IconSize) that should
* be created.
* @return A widget that displays the icon for this action.
*/
Image* create_icon(IconSize icon_size);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Creates a menu item widget that proxies for the given action.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Glib::menu_item_new() and associate it with a Action
* instead.
*
* @deprecated Use a Gio::MenuItem and associate it with a Gio::Action instead.
*
* @return A menu item connected to the action.
*/
MenuItem* create_menu_item();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Creates a toolbar item widget that proxies for the given action.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use a Gtk::ToolItem and associate it with a Action using
* Gtk::Actionable::set_action_name() instead
*
* @deprecated Use a Gtk::ToolItem and associate it with a Gio::Action using Gtk::Actionable::set_action_name() instead. (Impossible until GtkToolItem implements the GActionable interface.)
*
* @return A toolbar item connected to the action.
*/
ToolItem* create_tool_item();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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}
*
* Deprecated: 3.10: Use Action and MenuModel instead, and create a
* Gtk::Menu with Gtk::Menu::new_from_model()
*
* @deprecated Use Gio::Action and Gio::MenuModel instead, and create a Gtk::Menu with Gtk::Menu(const Glib::RefPtr<Gio::MenuModel>& model).
*
* @return The menu item provided by the
* action, or <tt>nullptr</tt>.
*/
Menu* create_menu();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns the proxy widgets for an action.
* See also Gtk::Activatable::get_related_action().
*
* @newin{2,4}
*
* Deprecated: 3.10
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @return A SList of proxy widgets. The list is owned by GTK+
* and must not be modified.
*/
std::vector<Widget*> get_proxies();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns the proxy widgets for an action.
* See also Gtk::Activatable::get_related_action().
*
* @newin{2,4}
*
* Deprecated: 3.10
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @return A SList of proxy widgets. The list is owned by GTK+
* and must not be modified.
*/
std::vector<const Widget*> get_proxies() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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}
*
* Deprecated: 3.10: Use Action and the accelerator group on an associated
* Gtk::Menu instead
*
* @deprecated Use Gio::Action and the accelerator group on an associated Gtk::Menu instead.
*/
void connect_accelerator();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Undoes the effect of one call to connect_accelerator().
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Action and the accelerator group on an associated
* Gtk::Menu instead
*
* @deprecated Use Gio::Action and the accelerator group on an associated Gtk::Menu instead.
*/
void disconnect_accelerator();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns the accel path for this action.
*
* @newin{2,6}
*
* Deprecated: 3.10: Use Action and the accelerator path on an associated
* Gtk::Menu instead
*
* @deprecated Use Gio::Action and the accelerator path on an associated Gtk::Menu instead.
*
* @return The accel path for this action, or <tt>nullptr</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;
#endif // GTKMM_DISABLE_DEPRECATED
/// For instance, void on_activate();
typedef sigc::slot<void> SlotActivate;
#ifndef GTKMM_DISABLE_DEPRECATED
/**
* @par Slot Prototype:
* <tt>void on_my_%activate()</tt>
*
* The "activate" signal is emitted when the action is activated.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use SimpleAction::signal_activate() instead
*
* @deprecated Use Gio::SimpleAction::signal_activate() instead.
*/
Glib::SignalProxy< void > signal_activate();
#endif // GTKMM_DISABLE_DEPRECATED
//Used by AccelGroup:
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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}
*
* Deprecated: 3.10: Use Action and the accelerator path on an associated
* Gtk::Menu instead
*
* @deprecated Use Gio::Action and the accelerator path on an associated Gtk::Menu instead.
*
* @param accel_path The accelerator path.
*/
void set_accel_path(const Glib::ustring& accel_path);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the Gtk::AccelGroup in which the accelerator for this action
* will be installed.
*
* @newin{2,4}
*
* Deprecated: 3.10: Use Action and the accelerator group on an associated
* Gtk::Menu instead
*
* @deprecated Use Gio::Action and the accelerator group on an associated Gtk::Menu instead.
*
* @param accel_group A Gtk::AccelGroup or <tt>nullptr</tt>.
*/
void set_accel_group(const Glib::RefPtr<AccelGroup>& accel_group);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the label of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and set a label on a menu item with
* Glib::menu_item_set_label(). For Gtk::Actionable widgets, use the widget-specific
* API to set a label
*
* @deprecated Use Gio::Action instead, and set a label on a menu item with Gio::MenuItem::set_label(). For Gtk::Actionable widgets, use the widget-specific API to set a label.
*
* @param label The label text to set.
*/
void set_label(const Glib::ustring& label);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the label text of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and get a label from a menu item
* with Glib::menu_item_get_attribute_value(). For Gtk::Actionable widgets, use the
* widget-specific API to get a label
*
* @deprecated Use Gio::Action instead, and get a label from a menu item with Gio::MenuItem::get_attribute_value(). For Gtk::Actionable widgets, use the widget-specific API to get a label.
*
* @return The label text.
*/
Glib::ustring get_label() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets a shorter label text on @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, which has no equivalent of short
* labels
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @param short_label The label text to set.
*/
void set_short_label(const Glib::ustring& short_label);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the short label text of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, which has no equivalent of short
* labels
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @return The short label text.
*/
Glib::ustring get_short_label() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the tooltip text on @a action
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and set tooltips on associated
* Gtk::Actionable widgets with Gtk::Widget::set_tooltip_text()
*
* @deprecated Use Gio::Action instead, and set tooltips on associated Gtk::Actionable widgets with Gtk::Widget::set_tooltip_text().
*
* @param tooltip The tooltip text.
*/
void set_tooltip(const Glib::ustring& tooltip);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the tooltip text of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and get tooltips from associated
* Gtk::Actionable widgets with Gtk::Widget::get_tooltip_text()
*
* @deprecated Use Gio::Action instead, and get tooltips from associated Gtk::Actionable widgets with Gtk::Widget::get_tooltip_text().
*
* @return The tooltip text.
*/
Glib::ustring get_tooltip() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the stock id on @a action
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, which has no equivalent of stock
* items
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @param stock_id The stock id.
*/
void set_stock_id(const StockID& stock_id);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the stock id of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, which has no equivalent of stock
* items
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @return The stock id.
*/
StockID get_stock_id() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the icon of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and Glib::menu_item_set_icon() to set an
* icon on a MenuItem associated with a Action, or Gtk::Container::add() to
* add a Gtk::Image to a Gtk::Button
*
* @deprecated Use Gio::Action instead, and Gio::MenuItem::set_icon() to set an icon on a Gio::MenuItem associated with a Gio::Action, or Gtk::Container::add() to add a Gtk::Image to a Gtk::Button.
*
* @param icon The Icon to set.
*/
void set_gicon(const Glib::RefPtr<Gio::Icon>& icon);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the gicon of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and
* Glib::menu_item_get_attribute_value() to get an icon from a MenuItem
* associated with a Action
*
* @deprecated Use Gio::Action instead, and Gio::MenuItem::get_attribute_value() to get an icon from a Gio::MenuItem associated with a Gio::Action.
*
* @return The action’s Icon if one is set.
*/
Glib::RefPtr<Gio::Icon> get_gicon();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the gicon of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and
* Glib::menu_item_get_attribute_value() to get an icon from a MenuItem
* associated with a Action
*
* @deprecated Use Gio::Action instead, and Gio::MenuItem::get_attribute_value() to get an icon from a Gio::MenuItem associated with a Gio::Action.
*
* @return The action’s Icon if one is set.
*/
Glib::RefPtr<const Gio::Icon> get_gicon() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the icon name on @a action
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and Glib::menu_item_set_icon() to set an
* icon on a MenuItem associated with a Action, or Gtk::Container::add() to
* add a Gtk::Image to a Gtk::Button
*
* @deprecated Use Gio::Action instead, and Gio::MenuItem::set_icon() to set an icon on a Gio::MenuItem associated with a Gio::Action, or Gtk::Container::add() to add a Gtk::Image to a Gtk::Button.
*
* @param icon_name The icon name to set.
*/
void set_icon_name(const Glib::ustring& icon_name);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the icon name of @a action.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and
* Glib::menu_item_get_attribute_value() to get an icon from a MenuItem
* associated with a Action
*
* @deprecated Use Gio::Action instead, and Gio::MenuItem::get_attribute_value() to get an icon from a Gio::MenuItem associated with a Gio::Action.
*
* @return The icon name.
*/
Glib::ustring get_icon_name() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets whether @a action is visible when horizontal
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and control and monitor the
* visibility of associated widgets and menu items directly
*
* @deprecated Use Gio::Action instead, and control and monitor the visibility of associated widgets and menu items directly.
*
* @param visible_horizontal Whether the action is visible horizontally.
*/
void set_visible_horizontal(bool visible_horizontal = true);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Checks whether @a action is visible when horizontal
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and control and monitor the
* visibility of associated widgets and menu items directly
*
* @deprecated Use Gio::Action instead, and control and monitor the visibility of associated widgets and menu items directly.
*
* @return Whether @a action is visible when horizontal.
*/
bool get_visible_horizontal() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets whether @a action is visible when vertical
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and control and monitor the
* visibility of associated widgets and menu items directly
*
* @deprecated Use Gio::Action instead, and control and monitor the visibility of associated widgets and menu items directly.
*
* @param visible_vertical Whether the action is visible vertically.
*/
void set_visible_vertical(bool visible_vertical = true);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Checks whether @a action is visible when horizontal
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and control and monitor the
* visibility of associated widgets and menu items directly
*
* @deprecated Use Gio::Action instead, and control and monitor the visibility of associated widgets and menu items directly.
*
* @return Whether @a action is visible when horizontal.
*/
bool get_visible_vertical() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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}
*
* Deprecated: 3.10: Use Action instead, and control and monitor whether
* labels are shown directly
*
* @deprecated Use Gio::Action instead, and control and monitor whether labels are shown directly.
*
* @param is_important <tt>true</tt> to make the action important.
*/
void set_is_important(bool is_important = true);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Checks whether @a action is important or not
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Action instead, and control and monitor whether
* labels are shown directly
*
* @deprecated Use Gio::Action instead, and control and monitor whether labels are shown directly.
*
* @return Whether @a action is important.
*/
bool get_is_important() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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}
*
* Deprecated: 3.10: Use Glib::menu_item_set_icon() on a MenuItem instead, if the
* item should have an image
*
* @deprecated Use Gio::MenuItem::set_icon() on a Gio::MenuItem instead, if the item should have an image.
*
* @param always_show <tt>true</tt> if menuitem proxies should always show their image.
*/
void set_always_show_image(bool always_show = true);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Returns whether @a action's menu item proxies will always
* show their image, if available.
*
* @newin{2,20}
*
* Deprecated: 3.10: Use Glib::menu_item_get_attribute_value() on a MenuItem
* instead
*
* @deprecated Use Gio::MenuItem::get_attribute_value() on a Gio::MenuItem instead.
*
* @return <tt>true</tt> if the menu item proxies will always show their image.
*/
bool get_always_show_image() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** 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}
*
* Deprecated: 3.10: Use Glib::simple_action_set_enabled() to disable the
* SimpleAction instead
*
* @deprecated Use Gio::SimpleAction::set_enabled() to disable the Gio::SimpleAction instead.
*/
void block_activate();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Reenable activation signals from the action
*
* @newin{2,16}
*
* Deprecated: 3.10: Use Glib::simple_action_set_enabled() to enable the
* SimpleAction instead
*
* @deprecated Use Gio::SimpleAction::set_enabled() to enable the Gio::SimpleAction instead.
*/
void unblock_activate();
#endif // GTKMM_DISABLE_DEPRECATED
//gtk_action_get_accel_closure() is too C-specific:
#ifndef GTKMM_DISABLE_DEPRECATED
/** A unique name for the action.
*
* Deprecated: 3.10: Use Action::property_name() instead
*
* @deprecated Use Gio::Action::property_name() instead.
*
* @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;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** The label used for menu items and buttons that activate
* this action. If the label is <tt>nullptr</tt>, GTK+ uses the stock
* label specified via the stock-id property.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* Deprecated: 3.10: Use the "label" attribute on MenuItem instead
*
* @deprecated Use the 'label' attribute on Gio::MenuItem instead.
*
* @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. If the label is <tt>nullptr</tt>, GTK+ uses the stock
* label specified via the stock-id property.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* Deprecated: 3.10: Use the "label" attribute on MenuItem instead
*
* @deprecated Use the 'label' attribute on Gio::MenuItem instead.
*
* @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;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** A shorter label that may be used on toolbar buttons.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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_short_label() ;
/** A shorter label that may be used on toolbar buttons.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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_short_label() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** A tooltip for this action.
*
* Deprecated: 3.10: Use Gtk::Widget::set_tooltip_text() instead
*
* @deprecated Use Gtk::Widget::set_tooltip_text() and Gtk::Widget::get_tooltip_text() instead.
*
* @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.
*
* Deprecated: 3.10: Use Gtk::Widget::set_tooltip_text() instead
*
* @deprecated Use Gtk::Widget::set_tooltip_text() and Gtk::Widget::get_tooltip_text() instead.
*
* @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;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** The stock icon displayed in widgets representing this action.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** The Icon displayed in the Gtk::Action.
*
* Note that the stock icon is preferred, if the Gtk::Action::property_stock_id()
* property holds the id of an existing stock icon.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use the "icon" attribute on a MenuItem instead
*
* @deprecated Use the 'icon' attribute on Gio::MenuItem instead.
*
* @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 Icon displayed in the Gtk::Action.
*
* Note that the stock icon is preferred, if the Gtk::Action::property_stock_id()
* property holds the id of an existing stock icon.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* @newin{2,16}
*
* Deprecated: 3.10: Use the "icon" attribute on a MenuItem instead
*
* @deprecated Use the 'icon' attribute on Gio::MenuItem instead.
*
* @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;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** The name of the icon from the icon theme.
*
* Note that the stock icon is preferred, if the Gtk::Action::property_stock_id()
* property holds the id of an existing stock icon, and the Icon is
* preferred if the Gtk::Action::property_gicon() property is set.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* @newin{2,10}
*
* Deprecated: 3.10: Use the "icon" attribute on a MenuItem instead
*
* @deprecated Use the 'icon' attribute on Gio::MenuItem instead.
*
* @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.
*
* Note that the stock icon is preferred, if the Gtk::Action::property_stock_id()
* property holds the id of an existing stock icon, and the Icon is
* preferred if the Gtk::Action::property_gicon() property is set.
*
* This is an appearance property and thus only applies if
* Gtk::Activatable::property_use_action_appearance() is <tt>true</tt>.
*
* @newin{2,10}
*
* Deprecated: 3.10: Use the "icon" attribute on a MenuItem instead
*
* @deprecated Use the 'icon' attribute on Gio::MenuItem instead.
*
* @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;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_visible_horizontal() ;
/** Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_visible_horizontal() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Whether the toolbar item is visible when the toolbar is in a vertical orientation.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_visible_vertical() ;
/** Whether the toolbar item is visible when the toolbar is in a vertical orientation.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_visible_vertical() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** When <tt>true</tt>, toolitem proxies for this action are represented in the
* toolbar overflow menu.
*
* @newin{2,6}
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_visible_overflown() ;
/** When <tt>true</tt>, toolitem proxies for this action are represented in the
* toolbar overflow menu.
*
* @newin{2,6}
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_visible_overflown() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Whether the action is considered important. When <tt>true</tt>, toolitem
* proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_is_important() ;
/** Whether the action is considered important. When <tt>true</tt>, toolitem
* proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_is_important() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** When <tt>true</tt>, empty menu proxies for this action are hidden.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_hide_if_empty() ;
/** When <tt>true</tt>, empty menu proxies for this action are hidden.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_hide_if_empty() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Whether the action is enabled.
*
* Deprecated: 3.10: Use Action::property_enabled() and SimpleAction::property_enabled()
* instead
*
* @deprecated Use Gio::Action::property_enabled() and Gio::SimpleAction::property_enabled() instead.
*
* @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.
*
* Deprecated: 3.10: Use Action::property_enabled() and SimpleAction::property_enabled()
* instead
*
* @deprecated Use Gio::Action::property_enabled() and Gio::SimpleAction::property_enabled() instead.
*
* @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;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Whether the action is visible.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_visible() ;
/** Whether the action is visible.
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_visible() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** The GtkActionGroup this GtkAction is associated with, or <tt>nullptr</tt>
* (for internal use).
*
* Deprecated: 3.10: Lookup the Action using Glib::action_map_lookup_action()
* instead
*
* @deprecated Lookup the Gio::Action using Gio::ActionMap::lookup_action() instead.
*
* @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 <tt>nullptr</tt>
* (for internal use).
*
* Deprecated: 3.10: Lookup the Action using Glib::action_map_lookup_action()
* instead
*
* @deprecated Lookup the Gio::Action using Gio::ActionMap::lookup_action() instead.
*
* @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;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** If <tt>true</tt>, the action's menu item proxies will ignore the Gtk::Settings::property_gtk_menu_images()
* setting and always show their image, if available.
*
* Use this property if the menu item would be useless or hard to use
* without their image.
*
* @newin{2,20}
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_always_show_image() ;
/** If <tt>true</tt>, the action's menu item proxies will ignore the Gtk::Settings::property_gtk_menu_images()
* setting and always show their image, if available.
*
* Use this property if the menu item would be useless or hard to use
* without their image.
*
* @newin{2,20}
*
* Deprecated: 3.10: There is no corresponding replacement when using
* Action
*
* @deprecated There is no corresponding replacement when using Gio::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< bool > property_always_show_image() const;
#endif // GTKMM_DISABLE_DEPRECATED
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 */
|