/usr/share/mypaint/gui/layout.py is in mypaint 1.1.0-3.
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 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 | # This file is part of MyPaint.
# Copyright (C) 2007-2011 by Andrew Chadwick <andrewc-git@piffle.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
"""Manage a main window with a sidebar, plus a number of subwindows.
Tools can be snapped in and out of the sidebar.
Window sizes and sidebar positions are stored to user preferences.
"""
import os
import pygtkcompat
import gtk
from gtk import gdk
import pango
import cairo
gobject = pygtkcompat.gobject
from math import sqrt
from warnings import warn
from gettext import gettext as _
from elastic import ElasticContainer
def style_get_property(widget, property_name):
if pygtkcompat.USE_GTK3:
# FIXME: is the equivalent GI call broken? It seems to take value as an argument..
return 10
else:
return widget.style_get_property(property_name)
class LayoutManager:
"""Keeps track of tool positions, and main window state.
"""
def __init__(self, factory, factory_opts=[], prefs=None):
"""Constructor.
"prefs"
should be a ref to a dict-like object. Persistent prefs
will be read from and written back to it.
"factory"
is a callable which has the signature
factory(role, layout_manager, *factory_opts)
and which will be called for each needed tool. It should
return a value of the form:
1. (None,)
2. (window,)
3. (widget,)
4. (tool_widget, stock_id)
Form 1 indicates that no matching widget could be found.
Form 2 should be used for floating dialog windows, popup
windows and similar, or for "main-window". Form 3 is
expected when the "role" parameter is "main-widget"; the
returned widgets are packed into the main window.
"""
if prefs is None:
prefs = {}
self.prefs = prefs
self.window_group = gtk.WindowGroup()
self.factory = factory
self.factory_opts = factory_opts
self.widgets = {} # {role: <gtk.Widget>} as returned by factory()
self.tools = {} # {role: Tool}
self.subwindows = {} # {role: <gtk.Window>}
self.main_window = None
self.saved_user_tools = []
self.tool_visibility_observers = []
self.subwindow_visibility_observers = []
def set_main_window_title(self, title):
"""Set the title for the main window.
"""
self.main_window.set_title(title)
def get_widget_by_role(self, role):
"""Returns the raw widget for a particular role name.
Internally cached; will invoke the factory method once for each
unique role name the first time it's seen.
"""
if role in self.widgets:
return self.widgets[role]
else:
try:
result = self.factory(role, self, *self.factory_opts)
except ImportError:
result = None
if role == 'main-window':
self.main_window = result[0]
assert isinstance(self.main_window, MainWindow)
self.drag_state = ToolDragState(self)
# ^^^ Yuck. Would be nicer to init in constructor
self.widgets[role] = self.main_window
return self.main_window
elif role == 'main-widget':
widget = result[0]
self.widgets[role] = widget
return widget
if result is None:
return None
else:
widget = result[0]
if isinstance(widget, gtk.Window):
self.subwindows[role] = widget
self.widgets[role] = widget
widget.set_role(role)
widget.set_transient_for(self.main_window)
cb = self.notify_subwindow_visibility_observers
widget.connect("show", cb, True)
widget.connect("hide", cb, False)
return widget
elif isinstance(widget, gtk.Widget):
stock_id, title = result[1], result[2]
tool = Tool(widget, role, title, stock_id, self)
self.tools[role] = tool
self.widgets[role] = tool
return widget
else:
self.widgets[role] = None
warn("Unknown role \"%s\"" % role, RuntimeWarning,
stacklevel=2)
return None
def get_subwindow_by_role(self, role):
"""Returns the managed subwindow for a given role, or None
"""
self.get_widget_by_role(role)
return self.subwindows.get(role, None)
def get_tool_by_role(self, role):
"""Returns the tool wrapper for a given role.
Only valid for roles for which a corresponding packable widget was
created by the factory method.
"""
self.get_widget_by_role(role)
return self.tools.get(role, None)
def get_window_hidden_by_role(self, role, default=True):
return self.prefs.get(role, {}).get("hidden", default)
def get_window_floating_by_role(self, role, default=True):
return self.prefs.get(role, {}).get("floating", default)
def get_tools_in_sbindex_order(self):
"""Lists all loaded tools in order of ther sbindex setting.
The returned list contains all tools known to the LayoutManager
even if they aren't currently docked in a sidebar.
"""
tools = []
sbindexes = [s.get("sbindex", 0) for r, s in self.prefs.iteritems()]
sbindexes.append(0)
index_hwm = len(self.tools) + max(sbindexes)
for role, tool in self.tools.iteritems():
index = self.prefs.get(role, {}).get("sbindex", index_hwm)
index_hwm += 1
tools.append((index, tool.role, tool))
tools.sort()
return [t for i,r,t in tools]
def toggle_user_tools(self, on=None):
"""Temporarily toggle the user's chosen tools on or off.
"""
if on:
for tool in self.saved_user_tools:
tool.set_hidden(False, temporary=True)
tool.set_floating(tool.floating)
self.saved_user_tools = []
else:
for tool in self.get_tools_in_sbindex_order():
if tool.hidden:
continue
tool.set_hidden(True, temporary=True)
self.saved_user_tools.append(tool)
def show_all(self):
"""Displays all initially visible tools.
"""
# Ensure that everything not hidden in prefs is loaded up front
for role, win_pos in self.prefs.iteritems():
hidden = self.get_window_hidden_by_role(role)
if not hidden:
self.get_widget_by_role(role)
# Insert those that are tools into sidebar, or float them
# free as appropriate
floating_tools = []
for tool in self.get_tools_in_sbindex_order():
floating = self.get_window_floating_by_role(tool.role)
if floating:
floating_tools.append(tool)
else:
self.main_window.sidebar.add_tool(tool)
tool.set_floating(floating)
self.main_window.show_all()
# Floating tools
for tool in floating_tools:
win = tool.floating_window
tool.set_floating(True)
win.show_all()
# Present the main window for consistency with the toggle action.
gobject.idle_add(self.main_window.present)
def notify_tool_visibility_observers(self, *args, **kwargs):
for func in self.tool_visibility_observers:
func(*args, **kwargs)
def notify_subwindow_visibility_observers(self, *args, **kwargs):
for func in self.subwindow_visibility_observers:
func(*args, **kwargs)
class WindowWithSavedPosition:
"""Mixin for gtk.Windows which load/save their position via a LayoutManager.
Classes using this interface must provide an attribute named layout_manager
which exposes the LayoutManager whose prefs attr this window will read its
initial position from and update. As a consequence of how this mixin
interacts with the LayoutManager, it must have a meaningful window role at
realize time.
"""
def __init__(self):
"""Mixin constructor. Construction order does not matter.
"""
self.__last_conf_pos = None
self.__pos_save_timer = None
self.__is_fullscreen = False
self.__is_maximized = False
self.__mapped_once = False
self.__initial_xy = None
self.connect("realize", self.__on_realize)
self.connect("map", self.__on_map)
self.connect("configure-event", self.__on_configure_event)
self.connect("window-state-event", self.__on_window_state_event)
@property
def __pos(self):
lm = self.layout_manager
role = self.get_role()
assert role in lm.prefs, 'Window %r is not mentioned in DEFAULT_CONFIG (application.py)' % role
return lm.prefs[role]
def __on_realize(self, widget):
xy = set_initial_window_position(self, self.__pos)
self.__initial_xy = xy
def __force_initial_xy(self):
"""Revolting hack to force the initial x,y position after mapping.
It's cosmetically necessary to do this for tool windows at least, since
otherwise snapping out an initially docked window using the button can
look really weird if the WM forces a position on you (most *ix ones
do), and we really do have a better idea than the WM about what the
user meant. The WM is given a sporting chance to help position the
main-window sensibly though.
"""
role = self.get_role()
if role == 'main-window':
return
try:
x, y = self.__initial_xy
except TypeError:
return
self.move(x, y)
def __on_map(self, widget):
parent = self.get_transient_for()
if parent is self.layout_manager.main_window:
# The following was causing too much wierdness. Nice idea, but
# maybe not. See https://gna.org/bugs/?18293
# self.window.set_accept_focus(False)
# Prevent all saved-position subwindows from taking keyboard
# focus from the main window (in Metacity) by presenting it
# again. https://gna.org/bugs/?17899
gobject.idle_add(parent.present)
## The alternative is:
# gobject.idle_add(self.window.raise_)
# gobject.idle_add(parent.window.focus)
## but that doesn't seem to be necessary.
if self.__mapped_once:
return
self.__mapped_once = True
gobject.idle_add(self.__force_initial_xy)
def __on_window_state_event(self, widget, event):
# Respond to changes of the fullscreen or maximized state only
interesting = gdk.WINDOW_STATE_MAXIMIZED | gdk.WINDOW_STATE_FULLSCREEN
if not event.changed_mask & interesting:
return
state = event.new_window_state
self.__is_maximized = state & gdk.WINDOW_STATE_MAXIMIZED
self.__is_fullscreen = state & gdk.WINDOW_STATE_FULLSCREEN
def __on_configure_event(self, widget, event):
"""Store the current size of the window for future launches.
"""
# Save the new position in the prefs...
if not hasattr(self, 'get_window'):
return
f_ex = self.get_window().get_frame_extents()
x = max(0, f_ex.x)
y = max(0, f_ex.y)
conf_pos = dict(x=x, y=y, w=event.width, h=event.height)
self.__last_conf_pos = conf_pos
if self.get_role() == 'main-window':
# ... however, wait for a bit so window-state-event has a chance to
# fire first if the window can be meaningfully fullscreened. Compiz
# in particular enjoys firing up to three configure-events (at
# various sizes) before the window-state-event describing the
# fullscreen.
if not self.__pos_save_timer:
self.__pos_save_timer \
= gobject.timeout_add_seconds(2, self.__save_position_cb)
else:
# Save the position now for non-main windows
self.__save_position_cb()
def __save_position_cb(self):
if not (self.__is_maximized or self.__is_fullscreen):
self.__pos.update(self.__last_conf_pos)
self.__pos_save_timer = None
return False
class MainWindow (WindowWithSavedPosition):
"""Mixin for main gtk.Windows in a layout.
Contains slots and initialisation stuff for various widget slots, which
can be provided by the layout manager's factory callable. These are:
main-menubar
main-toolbar
main-widget
main-statusbar
"""
def __init__(self, layout_manager):
"""Mixin constructor: initialise as a gtk.Window vefore calling.
This builds the sidebar and packs the main UI with pieces provided
either by the factory or by overriding the various init_*() methods.
This also sets up the window with an initial position and configures
it to save its position and sidebar width when reconfigured to the
LayoutManager's prefs.
"""
assert isinstance(self, gtk.Window)
WindowWithSavedPosition.__init__(self)
self.layout_manager = layout_manager
self.set_role("main-window")
self.menubar = None; self.init_menubar()
self.toolbar = None; self.init_toolbar()
self.statusbar = None; self.init_statusbar()
self.main_widget = None; self.init_main_widget()
self.sidebar = Sidebar(layout_manager)
self.hpaned = gtk.HPaned()
self.hpaned_position_loaded = False
self.hpaned.pack1(self.main_widget, True, False)
self.hpaned.pack2(self.sidebar, False, False)
self.layout_vbox = gtk.VBox()
if self.menubar is not None:
self.layout_vbox.pack_start(self.menubar, False, False)
if self.toolbar is not None:
self.layout_vbox.pack_start(self.toolbar, False, False)
self.layout_vbox.pack_start(self.hpaned, True, True)
if self.statusbar is not None:
self.layout_vbox.pack_start(self.statusbar, False, False)
self.add(self.layout_vbox)
self.last_conf_size = None
self.connect("configure-event", self.__on_configure_event)
self.sidebar.connect("size-allocate", self.__on_sidebar_size_allocate)
self.connect("map-event", self.__on_map_event)
def __on_map_event(self, widget, event):
if self.sidebar.is_empty():
self.sidebar.hide()
def init_menubar(self):
self.menubar = self.layout_manager.get_widget_by_role("main-menubar")
def init_toolbar(self):
self.toolbar = self.layout_manager.get_widget_by_role("main-toolbar")
def init_statusbar(self):
self.statusbar = self.layout_manager.get_widget_by_role("main-statusbar")
def init_main_widget(self):
self.main_widget = self.layout_manager.get_widget_by_role("main-widget")
def __on_configure_event(self, widget, event):
self.last_conf_size = (event.width, event.height)
def __on_sidebar_size_allocate(self, sidebar, allocation):
lm = self.layout_manager
role = self.get_role()
if not role in lm.prefs:
lm.prefs[role] = {}
if self.hpaned_position_loaded:
# Save the sidebar's width each time space is allocated to it.
# Responds to the user adjusting the HPaned's divider position.
sbwidth = allocation.width
self.layout_manager.prefs["main-window"]["sbwidth"] = sbwidth
self.layout_manager.main_window.sidebar.set_tool_widths(sbwidth)
else:
# Except, ugh, the first time. If the position isn't loaded yet,
# load the main-window's sbwidth from the settings.
if self.last_conf_size:
width, height = self.last_conf_size
sbwidth = lm.prefs[role].get("sbwidth", None)
if sbwidth is not None:
handle_size = style_get_property(self.hpaned, "handle-size")
pos = width - handle_size - sbwidth
self.hpaned.set_position(pos)
self.hpaned.queue_resize()
self.hpaned_position_loaded = True
gtk.rc_parse_string ("""
style "small-stock-image-button-style" {
GtkWidget::focus-padding = 0
GtkWidget::focus-line-width = 0
xthickness = 0
ythickness = 0
}
widget "*.small-stock-image-button"
style "small-stock-image-button-style"
""")
class SmallImageButton (gtk.Button):
"""A small button containing an image.
Instances are used for the close button and snap out buttons in a
ToolDragHandle.
"""
ICON_SIZE = gtk.ICON_SIZE_MENU
def __init__(self, stock_id=None, tooltip=None):
gtk.Button.__init__(self)
self.image = None
if stock_id is not None:
self.set_image_from_stock(stock_id)
else:
self.set_image_from_stock(gtk.STOCK_MISSING_IMAGE)
self.set_name("small-stock-image-button")
self.set_relief(gtk.RELIEF_NONE)
self.set_property("can-focus", False)
if tooltip is not None:
self.set_tooltip_text(tooltip)
self.connect("style-set", self.on_style_set)
def set_image_from_stock(self, stock_id):
if self.image:
self.remove(self.image)
self.image = gtk.image_new_from_stock(stock_id, self.ICON_SIZE)
self.add(self.image)
self.show_all()
# TODO: support image.set_from_icon_name maybe
def on_style_set(self, widget, prev_style):
settings = self.get_settings()
size_info = gtk.icon_size_lookup_for_settings(settings,
gtk.ICON_SIZE_MENU)
if size_info:
if pygtkcompat.USE_GTK3:
valid, w, h = size_info
else:
w, h = size_info
valid = True
if valid:
self.set_size_request(w+4, h+4)
class ToolResizeGrip (gtk.DrawingArea):
"""A draggable bar for resizing a Tool vertically."""
AREA_LEFT = 0
AREA_MIDDLE = 1
AREA_RIGHT = 2
handle_size = style_get_property(gtk.HPaned(), "handle-size") + 2
corner_width = 4*handle_size
window_edge_map = {
AREA_RIGHT: gdk.WINDOW_EDGE_SOUTH_EAST,
AREA_MIDDLE: gdk.WINDOW_EDGE_SOUTH,
AREA_LEFT: gdk.WINDOW_EDGE_SOUTH_WEST,
}
floating_cursor_map = {
AREA_LEFT: gdk.Cursor(gdk.BOTTOM_LEFT_CORNER),
AREA_MIDDLE: gdk.Cursor(gdk.BOTTOM_SIDE),
AREA_RIGHT: gdk.Cursor(gdk.BOTTOM_RIGHT_CORNER),
}
nonfloating_cursor = gdk.Cursor(gdk.SB_V_DOUBLE_ARROW)
def __init__(self, tool):
gtk.DrawingArea.__init__(self)
self.tool = tool
self.set_size_request(4*self.corner_width, self.handle_size)
self.connect("configure-event", self.on_configure_event)
if pygtkcompat.USE_GTK3:
self.connect("draw", self.on_draw)
else:
self.connect("expose-event", self.on_expose_event)
self.connect("button-press-event", self.on_button_press_event)
self.connect("button-release-event", self.on_button_release_event)
self.connect("motion-notify-event", self.on_motion_notify_event)
self.connect("leave-notify-event", self.on_leave_notify_event)
self.width = self.height = self.handle_size
mask = gdk.BUTTON_PRESS_MASK | gdk.BUTTON_RELEASE_MASK \
| gdk.LEAVE_NOTIFY_MASK | gdk.POINTER_MOTION_MASK
self.set_events(mask)
self.resize = None
def on_configure_event(self, widget, event):
self.width = event.width
self.height = event.height
def on_draw(self, widget, cr):
# FIXME: implement
pass
def on_expose_event(self, widget, event):
gdk_window = self.get_window()
gdk_window.clear()
gdk_window.begin_paint_rect(event.area)
x = (self.width - self.handle_size) / 2
y = (self.height - self.handle_size) / 2
state = self.get_state()
self.style.paint_handle(gdk_window, state,
gtk.SHADOW_NONE, event.area, self, 'paned',
0, 0, self.width, self.height,
gtk.ORIENTATION_HORIZONTAL)
gdk_window.end_paint()
def get_area(self, x, y):
if self.tool.floating:
if x <= self.corner_width:
return self.AREA_LEFT
elif x >= self.width - self.corner_width:
return self.AREA_RIGHT
return self.AREA_MIDDLE
def on_button_press_event(self, widget, event):
if event.button != 1:
return
if self.tool.floating:
area = self.get_area(event.x, event.y)
win = self.tool.floating_window.get_window()
edge = self.window_edge_map[area]
win.begin_resize_drag(edge, event.button,
int(event.x_root), int(event.y_root),
event.time)
else:
min_w, min_h = self.tool.get_minimum_size()
lm = self.tool.layout_manager
max_w, max_h = lm.main_window.sidebar.max_tool_size()
min_w = max_w
alloc = self.tool.get_allocation()
w = alloc.width
h = alloc.height
self.resize = event.x_root, event.y_root, w, h, \
min_w, min_h, max_w, max_h
self.grab_add()
def on_button_release_event(self, widget, event):
self.resize = None
self.grab_remove()
gdk_window = self.get_window()
gdk_window.set_cursor(None)
def get_cursor(self, area):
if self.tool.floating:
cursor = self.floating_cursor_map.get(area)
else:
cursor = self.nonfloating_cursor
return cursor
def on_motion_notify_event(self, widget, event):
gdk_window = self.get_window()
if not self.resize:
area = self.get_area(event.x, event.y)
gdk_window.set_cursor(self.get_cursor(area))
return
assert not self.tool.floating
(ptr_x_root0, ptr_y_root0, w0, h0,
min_w, min_h, max_w, max_h) = self.resize
cursor = self.nonfloating_cursor
gdk_window.set_cursor(cursor)
dh = event.y_root - ptr_y_root0
h = int(min(max(min_h, h0+dh), max_h))
w = -1 # constrained horizontally anyway, better to not care
self.tool.set_size_request(w, h)
self.tool.queue_resize()
def on_leave_notify_event(self, widget, event):
gdk_window = self.get_window()
gdk_window.set_cursor(None)
class FoldOutArrow (gtk.Button):
TEXT_EXPANDED = _("Collapse")
TEXT_COLLAPSED = _("Expand")
def __init__(self, tool):
gtk.Button.__init__(self)
self.tool = tool
self.set_name("small-stock-image-button")
self.set_relief(gtk.RELIEF_NONE)
self.set_property("can-focus", False)
self.arrow = gtk.Arrow(gtk.ARROW_DOWN, gtk.SHADOW_NONE)
self.set_tooltip_text(self.TEXT_EXPANDED)
self.add(self.arrow)
self.connect("clicked", self.on_click)
def on_click(self, *a):
self.tool.set_rolled_up(not self.tool.rolled_up)
def set_arrow(self, rolled_up):
if rolled_up:
self.arrow.set(gtk.ARROW_RIGHT, gtk.SHADOW_NONE)
self.set_tooltip_text(self.TEXT_COLLAPSED)
else:
self.arrow.set(gtk.ARROW_DOWN, gtk.SHADOW_NONE)
self.set_tooltip_text(self.TEXT_EXPANDED)
def draw_subtle_gradient(widget):
# Draw a subtle vertical gradient over an entire widget
state = widget.get_state()
alloc = widget.get_allocation()
w = alloc.width
h = alloc.height
def _col2rgba(col, alpha=0.2):
return col.red_float, col.green_float, col.blue_float, alpha
light_rgba = _col2rgba(widget.style.light[state])
mid_rgba = _col2rgba(widget.style.bg[state])
dark_rgba = _col2rgba(widget.style.dark[state])
gdk_window = widget.get_window()
cr = gdk_window.cairo_create()
lg = cairo.LinearGradient(0, 0, 0, h)
if state == gtk.STATE_ACTIVE:
lg.add_color_stop_rgba(0.0, *dark_rgba)
lg.add_color_stop_rgba(0.9, *dark_rgba)
lg.add_color_stop_rgba(1.0, *mid_rgba)
else:
lg.add_color_stop_rgba(0.0, *light_rgba)
lg.add_color_stop_rgba(0.5, *mid_rgba)
lg.add_color_stop_rgba(1.0, *dark_rgba)
cr.set_source(lg)
cr.paint()
class ToolDragHandle (gtk.EventBox):
"""A draggable handle for repositioning a Tool.
"""
min_drag_distance = 10
spacing = 2
def __init__(self, tool, stock_id, label_text):
gtk.EventBox.__init__(self)
self.stock_id = stock_id
self.tool = tool
self.frame = frame = gtk.Frame()
frame.set_shadow_type(gtk.SHADOW_OUT)
self.hbox = hbox = gtk.HBox(spacing=self.spacing)
self.hbox.set_border_width(self.spacing)
self.img = gtk.image_new_from_stock(stock_id, gtk.ICON_SIZE_BUTTON)
hbox.pack_start(self.img, False, False)
self.roll_up_button = FoldOutArrow(self.tool)
hbox.pack_start(self.roll_up_button, False, False)
self.label = label = gtk.Label(label_text)
self.label.set_alignment(0.0, 0.5)
self.label.set_ellipsize(pango.ELLIPSIZE_END)
hbox.pack_start(label, True, True)
self.snap_button = SmallImageButton(tooltip=_("Snap out"))
self.snap_button.connect("clicked", tool.on_snap_button_pressed)
self.close_button = SmallImageButton(gtk.STOCK_CLOSE, _("Close"))
self.close_button.connect("clicked", tool.on_close_button_pressed)
hbox.pack_start(self.snap_button, False, False)
hbox.pack_start(self.close_button, False, False)
frame.add(hbox)
self.add(frame)
self.connect("button-press-event", self.on_button_press_event)
self.connect("button-release-event", self.on_button_release_event)
self.connect("motion-notify-event", self.on_motion_notify_event)
self.connect("enter-notify-event", self.on_enter_notify_event)
self.connect("leave-notify-event", self.on_leave_notify_event)
# Drag initiation
self.set_events(gdk.BUTTON_PRESS_MASK | gdk.BUTTON_RELEASE_MASK)
self.button_press_xy = None
self.in_reposition_drag = False
# Floating status
self.set_floating(False)
if pygtkcompat.USE_GTK3:
pass #FIXME: implement
else:
self.frame.connect("expose-event", self.on_frame_expose_event)
def on_frame_expose_event(self, widget, event):
draw_subtle_gradient(widget)
return False # let the normal handler draw the frame outline too
def set_floating(self, floating):
if floating:
stock_id = gtk.STOCK_GOTO_LAST
if self.roll_up_button in self.hbox:
self.roll_up_button.hide()
self.hbox.remove(self.roll_up_button)
else:
stock_id = gtk.STOCK_GOTO_FIRST
if self.roll_up_button not in self.hbox:
self.hbox.pack_start(self.roll_up_button, False, False)
self.hbox.reorder_child(self.roll_up_button, 1)
self.roll_up_button.show_all()
self.queue_resize()
self.snap_button.set_image_from_stock(stock_id)
def set_rolled_up(self, rolled_up):
self.roll_up_button.set_arrow(rolled_up)
def on_button_press_event(self, widget, event):
if event.button != 1:
return
if event.type == gdk._2BUTTON_PRESS:
if not self.tool.floating:
self.tool.set_rolled_up(not self.tool.rolled_up)
self._reset()
elif event.type == gdk.BUTTON_PRESS:
self.set_state(gtk.STATE_ACTIVE)
gdk_window = self.get_window()
gdk_window.set_cursor(gdk.Cursor(gdk.FLEUR))
self.button_press_xy = event.x, event.y
def on_button_release_event(self, widget, event):
self._reset()
def _reset(self):
self.button_press_xy = None
self.set_state(gtk.STATE_NORMAL)
gdk_window = self.get_window()
if gdk_window:
gdk_window.set_cursor(None)
def on_motion_notify_event(self, widget, event):
if not self.button_press_xy:
return False
if not event.state & gdk.BUTTON1_MASK:
return
lm = self.tool.layout_manager
ix, iy = self.button_press_xy
dx, dy = event.x - ix, event.y - iy
dd = sqrt(dx**2 + dy**2)
if dd > self.min_drag_distance:
self.start_reposition_drag()
def start_reposition_drag(self): # XXX: move to Tool?
"""Begin repositioning this tool."""
lm = self.tool.layout_manager
ix, iy = self.button_press_xy
self.button_press_xy = None
gdk_window = self.get_window()
gdk_window.set_cursor(gdk.Cursor(gdk.FLEUR))
self.set_state(gtk.STATE_ACTIVE)
self.tool.layout_manager.drag_state.begin(self.tool, ix, iy)
def on_reposition_drag_finished(self): # XXX: move to Tool?
"""Called when repositioning has finished."""
self._reset()
def on_leave_notify_event(self, widget, event):
gdk_window = self.get_window()
gdk_window.set_cursor(None)
self.set_state(gtk.STATE_NORMAL)
def on_enter_notify_event(self, widget, event):
gdk_window = self.get_window()
gdk_window.set_cursor(gdk.Cursor(gdk.HAND2))
#if not self.in_reposition_drag:
# self.set_state(gtk.STATE_PRELIGHT)
class ToolSnapBackBar (gtk.DrawingArea):
ARROW_SIZE = 10
TEAR_LENGTH = 5
def __init__(self, tool):
gtk.DrawingArea.__init__(self)
self.tool = tool
self.set_size_request(-1, self.ARROW_SIZE)
if pygtkcompat.USE_GTK3:
pass #FIXME: implement
else:
self.connect("expose-event", self.on_expose_event)
self.connect("button-press-event", self.on_button_down)
self.connect("button-release-event", self.on_button_up)
self.connect("enter-notify-event", self.on_enter)
self.connect("leave-notify-event", self.on_leave)
self.add_events(gdk.BUTTON_PRESS_MASK|gdk.BUTTON_RELEASE_MASK)
self.add_events(gdk.ENTER_NOTIFY_MASK|gdk.LEAVE_NOTIFY_MASK)
self._button = None
def on_click(self, event):
if event.button != 1:
return
self.tool.set_floating(False)
def on_button_down(self, widget, event):
self._button = event.button
self.set_state(gtk.STATE_ACTIVE)
def on_button_up(self, widget, event):
if event.button == self._button \
and self.get_state() == gtk.STATE_ACTIVE:
self.on_click(event)
self.set_state(gtk.STATE_NORMAL)
self._button = None
def on_enter(self, widget, event):
if self._button:
self.set_state(gtk.STATE_ACTIVE)
else:
self.set_state(gtk.STATE_PRELIGHT)
self.queue_draw()
def on_leave(self, widget, event):
self.set_state(gtk.STATE_NORMAL)
def on_expose_event(self, widget, event):
alloc = self.get_allocation()
w = alloc.width
h = alloc.height
sty = self.get_style()
state = self.get_state()
if state == gtk.STATE_ACTIVE:
shadow_type = gtk.SHADOW_IN
elif state == gtk.STATE_PRELIGHT:
shadow_type = gtk.SHADOW_OUT
else:
shadow_type = gtk.SHADOW_NONE
#sty.paint_box(self.window, state, shadow_type, event.area,
# self, None, 0, 0, w, h)
draw_subtle_gradient(widget)
gdk_window = self.get_window()
sty.paint_arrow(gdk_window, state, gtk.SHADOW_IN, event.area,
self, "tearoffmenuitem", gtk.ARROW_RIGHT, True, w-h, 0, h, h)
right_max = w - h
x = self.TEAR_LENGTH
while x < right_max:
x1 = x
x2 = min(x+self.TEAR_LENGTH, right_max)
sty.paint_hline(gdk_window, gtk.STATE_NORMAL, event.area,
widget, "tearoffmenuitem",
x1, x2, (h - sty.ythickness)//2)
x += 2 * self.TEAR_LENGTH
# cribbed from http://git.gnome.org/browse/gtk+/tree/gtk/gtktearoffmenuitem.c?id=5361490db88974b529bf5a1ba79711fcb1c7249b
class ToolWindow (gtk.Window, ElasticContainer, WindowWithSavedPosition):
"""Window containing a Tool in the floating state.
"""
def __init__(self, title, role, layout_manager):
gtk.Window.__init__(self)
ElasticContainer.__init__(self)
WindowWithSavedPosition.__init__(self)
self.layout_manager = layout_manager
self.set_transient_for(layout_manager.main_window)
self.set_type_hint(gdk.WINDOW_TYPE_HINT_UTILITY)
self.set_focus_on_map(False)
self.role = role
self.set_role(role)
self.set_title(title)
self.tool = None
self.connect("configure-event", self.on_configure_event)
self.pre_hide_pos = None
## More of a reminder to myself than anything else.
#self.set_opacity(0.5)
# We could make them ghost on focus-in and focus-out like Inkscape's
# new setup. Potentially rather annoying though unless done right.
# Animated, fading in fast and fading out slow would probably be best.
def add(self, tool):
self.tool = tool
gtk.Window.add(self, tool)
def remove(self, tool):
self.tool = None
gtk.Window.remove(self, tool)
def on_configure_event(self, widget, event):
if self.pre_hide_pos:
return
role = self.role
lm = self.layout_manager
if not lm.prefs.get(role, False):
lm.prefs[role] = {}
lm.prefs[role]['floating'] = True
def show(self):
"""Shows or re-shows the window.
If a previous position was set by hide(), it will be restored.
"""
gtk.Window.show(self)
if self.pre_hide_pos:
self.move(*self.pre_hide_pos)
self.pre_hide_pos = None
def show_all(self):
"""Shows or re-shows the window and all its descendents.
If a previous position was set by hide(), it will be restored.
"""
gtk.Window.show_all(self)
if self.pre_hide_pos:
self.move(*self.pre_hide_pos)
self.pre_hide_pos = None
def hide(self):
"""Hides the window, remembering its position.
"""
self.pre_hide_pos = self.get_position()
gtk.Window.hide(self)
def place(self, x, y, w, h):
"""Places a window at a position, either now or when mapped.
This is intended to be called before a show() or show_all() by
code that lets the user pick a position for a tool window before it's
shown: for example when snapping a tool free from the sidebar using
the preview window.
The pre-hide position will be forgotten and not used by the override
for show() or show_all().
"""
self.pre_hide_pos = None
# Constrain x and y so negative positions passed in don't look like
# the funky right or bottom edge positioning magic (to the realize
# handler; move() doesn't care, but be symmetrical in behaviour).
x = max(x, 0)
y = max(y, 0)
if self.get_window() is not None:
# It's mapped, so this will probably work even if the window
# is not viewable right now.
self.move(x, y)
self.resize(w, h)
else:
# No window yet, not mapped.
# Update prefs ready for the superclass's realize handler.
role = self.role
lm = self.layout_manager
if not lm.prefs.get(role, False):
lm.prefs[role] = {}
new_size = dict(x=x, y=y, w=w, h=h)
lm.prefs[role].update(new_size)
class Tool (gtk.VBox, ElasticContainer):
"""Container for a dockable tool widget.
The widget may be packed into a Sidebar, or snapped out into its own
floating ToolWindow.
"""
def __init__(self, widget, role, title, stock_id, layout_manager):
gtk.VBox.__init__(self)
ElasticContainer.__init__(self)
self.role = role
self.widget = widget
self.layout_manager = layout_manager
self.handle = ToolDragHandle(self, stock_id, title)
self.stock_id = stock_id
self.snap_back_bar = ToolSnapBackBar(self)
self.widget_frame = frame = gtk.Frame()
frame.set_shadow_type(gtk.SHADOW_IN)
frame.add(widget)
self.pack_start(frame, True, True)
self.resize_grip = ToolResizeGrip(self)
self.resize_grip_frame = gtk.Frame()
self.resize_grip_frame.set_shadow_type(gtk.SHADOW_OUT)
self.resize_grip_frame.add(self.resize_grip)
self.pack_start(self.resize_grip_frame, False, False)
self.floating_window = ToolWindow(title, role, layout_manager)
self.floating_window.connect("delete-event", self.on_floating_window_delete_event)
self.layout_manager.window_group.add_window(self.floating_window)
self.floating = layout_manager.get_window_floating_by_role(role)
self.hidden = layout_manager.get_window_hidden_by_role(role)
self.rolled_up = False
self.rolled_up_prev_size = None
self.connect("size-allocate", self.on_size_allocate)
self.connect("style-set", self.on_style_set)
# Workaround for "widget" being an unsettable field in PyGI+GTK3.
# Hopefully this won't break anything and we won't need anything more.
@property
def widget(self):
return self._widget
@widget.setter
def widget(self, w):
self._widget = w
def on_size_allocate(self, widget, allocation):
if self.rolled_up:
return
lm = self.layout_manager
if self not in lm.main_window.sidebar.tools_vbox:
return
if not lm.prefs.get(self.role, False):
lm.prefs[self.role] = {}
lm.prefs[self.role]["sbheight"] = allocation.height
def on_style_set(self, widget, oldstyle):
"""Updates the floating window's icon in response to ``style-set``.
"""
sizes = (gtk.ICON_SIZE_MENU,
gtk.ICON_SIZE_SMALL_TOOLBAR, gtk.ICON_SIZE_LARGE_TOOLBAR,
gtk.ICON_SIZE_BUTTON, gtk.ICON_SIZE_DND, gtk.ICON_SIZE_DIALOG)
pixbufs = []
for size in sizes:
pixbuf = widget.render_icon(self.stock_id, size, None)
if pixbuf is not None:
pixbufs.append(pixbuf)
if pixbufs != []:
if pygtkcompat.USE_GTK3:
self.floating_window.set_icon_list(pixbufs)
else:
self.floating_window.set_icon_list(*pixbufs)
def on_floating_window_delete_event(self, window, event):
self.set_hidden(True)
return True # Suppress ordinary deletion. We'll be wanting it again.
def set_show_resize_grip(self, show):
widget = self.resize_grip_frame
if not show:
if widget in self:
widget.hide()
self.remove(widget)
else:
if widget not in self:
self.pack_start(widget, False, False)
self.reorder_child(widget, -1)
widget.show()
def set_show_widget_frame(self, show):
widget = self.widget_frame
if not show:
if widget in self:
widget.hide()
self.remove(widget)
else:
if widget not in self:
self.pack_start(widget, True, True)
self.reorder_child(widget, 1)
widget.show()
def restore_sbheight(self):
"""Restore the height of the tool when docked."""
lm = self.layout_manager
role = self.role
sbheight = lm.prefs.get(role, {}).get("sbheight", None)
if sbheight is not None:
self.set_size_request(-1, sbheight)
def set_floating(self, floating):
"""Flips the widget beween floating and non-floating, reparenting it.
"""
floating = bool(floating)
self.handle.set_floating(floating)
self.set_rolled_up(False)
# Clear any explicit size requests so that the frame is able to adopt a
# natural size again.
for wid in (self.handle, self):
if wid.get_visible():
wid.set_size_request(-1, -1)
wid.queue_resize()
parent = self.get_parent()
if parent is not None:
parent.remove(self)
lm = self.layout_manager
if lm.prefs.get(self.role, None) is None:
lm.prefs[self.role] = {}
if not floating:
new_item0 = self.handle
old_item0 = self.snap_back_bar
if lm.main_window.sidebar.is_empty():
lm.main_window.sidebar.show_all()
sbindex = lm.prefs[self.role].get("sbindex", None)
lm.main_window.sidebar.add_tool(self, index=sbindex)
self.floating_window.hide()
self.restore_sbheight()
lm.main_window.sidebar.reassign_indices()
if self.resize_grip_frame not in self.get_children():
self.pack_start(self.resize_grip_frame, False, False)
self.resize_grip_frame.show_all()
self.resize_grip_frame.set_shadow_type(gtk.SHADOW_NONE)
else:
new_item0 = self.snap_back_bar
old_item0 = self.handle
self.floating_window.add(self)
# Defer the show_all(), seems to be needed when toggling on a
# hidden, floating window which hasn't yet been loaded.
gobject.idle_add(self.floating_window.show_all)
lm.main_window.sidebar.reassign_indices()
if lm.main_window.sidebar.is_empty():
lm.main_window.sidebar.hide()
if self.resize_grip_frame in self.get_children():
self.resize_grip_frame.hide()
self.remove(self.resize_grip_frame)
self.floating = lm.prefs[self.role]["floating"] = floating
# Display the appropriate widget in slot 0
if old_item0 in self.get_children():
old_item0.hide()
self.remove(old_item0)
if new_item0 not in self.get_children():
self.pack_start(new_item0, False, False)
self.reorder_child(new_item0, 0)
new_item0.show_all()
def set_hidden(self, hidden, temporary=False):
"""Sets a tool as hidden, hiding or showing it as appropriate.
Note that this does not affect whether the window is floating or not
when un-hidden it will restore to the same place in the UI it was
hidden.
If the `temporary` argument is true, the new state will not be saved in
the preferences.
"""
self.set_rolled_up(False)
role = self.role
lm = self.layout_manager
if not lm.prefs.get(role, False):
lm.prefs[role] = {}
if hidden:
self.hide()
parent = self.get_parent()
if parent is not None:
parent.remove(self)
if self.floating:
self.floating_window.hide()
else:
self.set_floating(self.floating)
# Which will restore it to the correct state
self.hidden = hidden
lm.notify_tool_visibility_observers(role=self.role, active=not hidden,
temporary=temporary)
if not temporary:
lm.prefs[role]["hidden"] = hidden
if lm.main_window.sidebar.is_empty():
lm.main_window.sidebar.hide()
else:
lm.main_window.sidebar.show_all()
def set_rolled_up(self, rolled_up):
resize_needed = False
if rolled_up:
if not self.rolled_up:
self.rolled_up = True
alloc = self.get_allocation()
self.rolled_up_prev_size = (alloc.width, alloc.height)
self.set_show_widget_frame(False)
self.set_show_resize_grip(False)
newalloc = self.handle.get_allocation()
self.set_size_request(newalloc.width, newalloc.height)
resize_needed = True
else:
if self.rolled_up:
self.rolled_up = False
self.set_show_widget_frame(True)
self.set_show_resize_grip(True)
self.set_size_request(*self.rolled_up_prev_size)
resize_needed = True
self.rolled_up_prev_size = None
# Since other handlers call this to unroll a window before moving it
# or hiding it, it's best to perform any necessary resizes now before
# returning. Otherwise sizes can become screwy when the operation
# is reversed.
if resize_needed:
self.queue_resize()
while gtk.events_pending():
gtk.main_iteration()
# Notify the indicator arrow
self.handle.set_rolled_up(rolled_up)
def on_close_button_pressed(self, window):
self.set_hidden(True)
def on_snap_button_pressed(self, window):
# Mouse position
display = pygtkcompat.gdk.display_get_default()
screen, ptr_x, ptr_y, _modmask = display.get_pointer()
if self.rolled_up:
self.set_rolled_up(False) # pending events will be processed
alloc = self.get_allocation()
w = alloc.width
h = alloc.height
handle_alloc = self.handle.get_allocation()
titlebar_h = handle_alloc.height
def handle_snap():
sidebar = self.layout_manager.main_window.sidebar
n = sidebar.num_tools()
m = 5
assert not self.floating
x = ptr_x - (w + (n*w/m)) # cascade effect
y = ptr_y + ((m - n) * (titlebar_h + 6))
self.floating_window.place(x, y, w, h)
self.set_floating(True)
self.handle.snap_button.set_state(gtk.STATE_NORMAL)
if sidebar.is_empty():
sidebar.hide()
return False
gobject.idle_add(handle_snap)
def get_preview_size(self):
alloc = self.get_allocation()
return alloc.width, alloc.height
def get_minimum_size(self):
min_w, min_h = 0, 0
for child in self.handle, self.resize_grip_frame, self.widget_frame:
child_min_w, child_min_h = child.size_request()
min_w = max(min_w, child_min_w)
min_h += child_min_h
return min_w, min_h
class ToolDragPreviewWindow (gtk.Window):
"""A shaped outline window showing where the current drag will move a Tool.
"""
def __init__(self, layout_manager):
gtk.Window.__init__(self, gtk.WINDOW_POPUP)
self.owner = layout_manager.main_window
#self.set_opacity(0.5)
self.set_decorated(False)
self.set_position(gtk.WIN_POS_MOUSE)
self.connect("map-event", self.on_map_event)
if pygtkcompat.USE_GTK3:
pass #FIXME: implement
else:
self.connect("expose-event", self.on_expose_event)
self.connect("configure-event", self.on_configure_event)
self.bg = None
self.set_default_size(1,1)
def show_all(self):
gtk.Window.show_all(self)
gdk_window = self.get_window()
gdk_window.move_resize(0, 0, 1, 1)
def on_map_event(self, window, event):
owner_win = self.owner.get_toplevel()
self.set_transient_for(owner_win)
# The first time we're mapped, set a background pixmap.
# Background pixmap, a checkerboard
gdk_window = self.get_window()
if self.bg is None:
if pygtkcompat.USE_GTK3:
# Until we have a non-Pixmap workaround.
return
self.bg = gdk.Pixmap(drawable=gdk_window, width=2, height=2)
cmap = gdk.colormap_get_system()
black = cmap.alloc_color(gdk.Color(0.0, 0.0, 0.0))
white = cmap.alloc_color(gdk.Color(1.0, 1.0, 1.0))
self.bg.set_colormap(cmap)
gc = self.bg.new_gc(black, white)
self.bg.draw_rectangle(gc, True, 0, 0, 2, 2)
gc = self.bg.new_gc(white, black)
self.bg.draw_points(gc, [(0,0), (1,1)])
gdk_window.set_back_pixmap(self.bg, False)
gdk_window.clear()
def on_configure_event(self, window, event):
# Shape the window
if pygtkcompat.USE_GTK3:
# Until we have a non-Region workaround.
return
w = event.width
h = event.height
r = gdk.Region()
s = 4
r.union_with_rect(gdk.Rectangle(0, 0, w, s))
r.union_with_rect(gdk.Rectangle(0, 0, s, h))
r.union_with_rect(gdk.Rectangle(0, h-s, w, s))
r.union_with_rect(gdk.Rectangle(w-s, 0, s, h))
gdk_window = self.get_window()
gdk_window.shape_combine_region(r, 0, 0)
def on_expose_event(self, window, event):
# Clear to the backing pixmap established earlier
if self.bg is not None:
gdk_window = self.get_window()
gdk_window.begin_paint_rect(event.area)
gdk_window.set_back_pixmap(self.bg, False)
gdk_window.clear()
gdk_window.end_paint()
class ToolDragState:
"""Manages visual state during tool repositioning.
The resize grip can largely take care of itself, and deploy its own grabs.
However when tools are repositioned, they get reparented between floating
windows and the sidebar and a grab on either tends to become confused. The
DragState object establishes whatever grabs are necessary for tools to be
repositioned; all they have to do is detect when the process starts and
call enter().
"""
def __init__(self, layout_manager):
self.layout_manager = layout_manager
self.insert_pos = None
self.preview = ToolDragPreviewWindow(layout_manager)
self.preview_size = None
self.tool = None # the box being dragged around & previewed
self.handle_pos = None
self.pointer_inside_sidebar = None
self.conn_ids = []
def connect_reposition_handlers(self):
"""Connect the event handlers used while repositioning tools.
"""
win = self.layout_manager.main_window
conn_id = win.connect("motion-notify-event",
self.on_reposition_motion_notify)
self.conn_ids.append(conn_id)
conn_id = win.connect("button-release-event",
self.on_reposition_button_release)
self.conn_ids.append(conn_id)
def disconnect_reposition_handlers(self):
"""Disconnect the handlers set up by connect_reposition_handlers().
"""
win = self.layout_manager.main_window
while self.conn_ids:
conn_id = self.conn_ids.pop()
win.disconnect(conn_id)
def begin(self, tool, handle_x, handle_y):
"""Begin repositioning a tool using its drag handle.
It's assumed the pointer button is held down at this point. The rest of
the procedure happens behind a pointer grab on the main window, and
ends when the button is released.
"""
lm = self.layout_manager
# Show the preview window
width, height = tool.get_preview_size()
self.preview.show_all()
self.preview_size = (width, height)
self.handle_pos = (handle_x, handle_y)
# Establish a pointer grab on the main window (which stays mapped
# throughout the drag).
main_win = lm.main_window
main_win_gdk = main_win.get_window()
events = gdk.BUTTON_PRESS_MASK | gdk.BUTTON_RELEASE_MASK \
| gdk.BUTTON1_MOTION_MASK
grab_status = gdk.pointer_grab(main_win_gdk, False, events,
None, gdk.Cursor(gdk.FLEUR), 0L)
if grab_status != gtk.gdk.GRAB_SUCCESS:
warn("Grab failed, aborting", RuntimeWarning, 2)
return
try:
self.tool = tool
self.connect_reposition_handlers()
except:
gdk.pointer_ungrab(gdk.CURRENT_TIME)
self.disconnect_reposition_handlers()
raise
def on_reposition_button_release(self, widget, event):
"""Ends the current tool reposition drag.
"""
gdk.pointer_ungrab(gdk.CURRENT_TIME)
self.disconnect_reposition_handlers()
self.end()
def on_reposition_motion_notify(self, widget, event):
"""Bulk of window shuffling within a tool reposition drag.
"""
x_root = event.x_root
y_root = event.y_root
w, h = self.preview_size
# Moving out of the box defined by the sidebar
# changes the mode of the current drag.
sidebar = self.layout_manager.main_window.sidebar
sb_left, sb_top = sidebar.get_window().get_origin()
sb_alloc = sidebar.get_allocation()
sb_right = sb_left + sb_alloc.width
sb_bottom = sb_top + sb_alloc.height
if (x_root < sb_left or x_root > sb_right
or y_root < sb_top or y_root > sb_bottom):
self.pointer_inside_sidebar = False
else:
self.pointer_inside_sidebar = True
# Move the preview window
if self.pointer_inside_sidebar:
tool = self.tool
ins = sidebar.insertion_point_at_pointer()
if ins is not None and ins != self.insert_pos:
self.insert_pos = ins
assert tool in sidebar.tools_vbox
sidebar.reorder_item(tool, ins)
sidebar.reassign_indices()
x, y = tool.handle.get_window().get_origin()
else:
ix, iy = self.handle_pos
x = int(x_root - ix)
y = int(y_root - iy)
self.handle_pos_root = (x, y)
self.preview.get_window().move_resize(x, y, w, h)
def end(self):
"""Invoked at the end of repositioning. Snapping out happens here.
"""
sidebar = self.layout_manager.main_window.sidebar
if not self.pointer_inside_sidebar:
# Set window position to that of the floating window
x, y = self.handle_pos_root
w, h = self.preview_size
self.tool.floating_window.place(x, y, w, h)
# Snap out
if self.tool in sidebar.tools_vbox:
self.tool.set_floating(True)
self.preview.hide()
self.tool.handle.on_reposition_drag_finished()
self.tool = None
self.handle_pos = None
self.insert_pos = None
self.pointer_inside_sidebar = None
self.preview_pos_root = (0, 0)
if sidebar.is_empty():
sidebar.hide()
class Sidebar (gtk.EventBox):
"""Vertical sidebar containing reorderable tools which can be snapped out.
"""
MIN_SIZE = 230
def __init__(self, layout_manager):
gtk.EventBox.__init__(self)
self.layout_manager = layout_manager
self.scrolledwin = gtk.ScrolledWindow()
self.scrolledwin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_ALWAYS)
self.add(self.scrolledwin)
self.tools_vbox = gtk.VBox()
self.scrolledwin.add_with_viewport(self.tools_vbox)
self.slack = gtk.EventBox() # needs its own window
self.tools_vbox.pack_start(self.slack, True, True)
self.set_size_request(self.MIN_SIZE, self.MIN_SIZE)
def add_tool(self, widget, index=None):
assert isinstance(widget, Tool)
if self.is_empty():
self.show()
self.tools_vbox.pack_start(widget, expand=False, fill=False)
if index is not None:
self.tools_vbox.reorder_child(widget, index)
self.reassign_indices()
self.tools_vbox.reorder_child(self.slack, -1)
def remove_tool(self, widget):
assert isinstance(widget, Tool)
self.reassign_indices()
self.tools_vbox.remove(widget)
if self.is_empty():
self.hide()
else:
self.reassign_indices()
def reorder_item(self, item, pos):
assert isinstance(item, Tool)
self.tools_vbox.reorder_child(item, pos)
self.tools_vbox.reorder_child(self.slack, -1)
self.reassign_indices()
def get_tools(self):
tools = []
for widget in self.tools_vbox:
if widget is self.slack:
continue
tools.append(widget)
return tools
def num_tools(self):
"""Returns the number of tools in the sidebar"""
return len(self.get_tools())
def is_empty(self):
"""True if there are no tools in the sidebar."""
return self.num_tools() == 0
def insertion_point_at_pointer(self):
"""Returns where in the sidebar a tool would be inserted.
Returns an integer position for passing to reorder_item(), or None.
Currently only tool drag handles are valid insertion points.
"""
display = self.get_display()
window_info = display.get_window_at_pointer()
if window_info is None:
return None
pointer_window = window_info[0]
current_tool = self.layout_manager.drag_state.tool
i = 0
for widget in self.tools_vbox:
if widget is self.slack:
if widget.get_window() is pointer_window:
return i
if isinstance(widget, Tool):
if widget is not current_tool:
dragger = widget.handle
if dragger.get_window() is pointer_window:
return i
i += 1
return None
def max_tool_size(self):
"""Returns the largest a packed tool is allowed to be.
"""
scrwin = self.scrolledwin
viewpt = scrwin.get_child()
sb_pad = 2 * style_get_property(scrwin, "scrollbar-spacing")
vp_alloc = viewpt.get_allocation()
max_size = (vp_alloc.width-sb_pad, vp_alloc.height-sb_pad)
return max_size
def reassign_indices(self):
"""Calculates and reassigns the "sbindex" prefs value.
"""
lm = self.layout_manager
i = 0
for tool in [t for t in self.tools_vbox if t is not self.slack]:
role = tool.role
if not lm.prefs.get(role, False):
lm.prefs[role] = {}
lm.prefs[role]["sbindex"] = i
i += 1
def set_tool_widths(self, width):
"""Constrain all packed tools' widths to a certain size.
"""
lm = self.layout_manager
max_w, max_h = self.max_tool_size()
for tool in [t for t in self.tools_vbox if t is not self.slack]:
natural_w, natural_h = tool.size_request()
req_w, req_h = tool.get_size_request()
if req_w == -1:
# Only constrain if the natual width is larger than permitted
if natural_w > max_w:
tool.set_size_request(max_w, req_h)
else:
if req_w > max_w:
if natural_w <= max_w:
tool.set_size_request(-1, req_h)
# Dubious. Could this lead to an infinite loop?
else:
tool.set_size_request(max_w, req_h)
def set_initial_window_position(win, pos):
"""Set the position of a gtk.Window, used during initial positioning.
This is used both for restoring a saved window position, and for the
application-wide defaults. The ``pos`` argument is a dict containing the
following optional keys
"w": <int>
"h": <int>
If positive, the size of the window.
If negative, size is calculated based on the size of the
monitor with the pointer on it, and x (or y) if given, e.g.
width = mouse_mon_w - abs(x) + abs(w) # or (if no x)
width = mouse_mon_w - (2 * abs(w))
The same is true of calulated heights.
"x": <int>
"y": <int>
If positive, the left/top of the window.
If negative, the bottom/right of the window: you MUST provide
a positive w,h if you do this!
If the window's calculated top-left would place it offscreen, it will be
placed in its default, window manager provided position. If its calculated
size is larger than the screen, the window will be given its natural size
instead.
Returns the final, chosen (x, y) pair for forcing the window position on
first map, or None if defaults are being used.
"""
MIN_USABLE_SIZE = 100
# Final calculated positions
final_x, final_y = None, None
final_w, final_h = None, None
# Positioning arguments
x = pos.get("x", None)
y = pos.get("y", None)
w = pos.get("w", None)
h = pos.get("h", None)
# Where the mouse is right now
display = pygtkcompat.gdk.display_get_default()
screen, ptr_x, ptr_y, _modmask = display.get_pointer()
if screen is None:
raise RuntimeError, "No cursor on the default screen. Eek."
screen_w = screen.get_width()
screen_h = screen.get_height()
assert screen_w > MIN_USABLE_SIZE
assert screen_h > MIN_USABLE_SIZE
if x is not None and y is not None:
if x >= 0:
final_x = x
else:
assert w is not None
assert w > 0
final_x = screen_w - w - abs(x)
if y >= 0:
final_y = y
else:
assert h is not None
assert h > 0
final_y = screen_h - h - abs(y)
if final_x < 0 or final_x > screen_w - MIN_USABLE_SIZE: final_x = None
if final_y < 0 or final_y > screen_h - MIN_USABLE_SIZE: final_h = None
if w is not None and h is not None:
final_w = w
final_h = h
if w < 0 or h < 0:
mon_num = screen.get_monitor_at_point(ptr_x, ptr_y)
mon_geom = screen.get_monitor_geometry(mon_num)
if w < 0:
if x is not None:
final_w = max(0, mon_geom.width - abs(x) - abs(w))
else:
final_w = max(0, mon_geom.width - 2*abs(w))
if h < 0:
if x is not None:
final_h = max(0, mon_geom.height - abs(y) - abs(h))
else:
final_h = max(0, mon_geom.height - 2*abs(h))
if final_w > screen_w or final_w < MIN_USABLE_SIZE: final_w = None
if final_h > screen_h or final_h < MIN_USABLE_SIZE: final_h = None
# TODO: check that the final position makes sense for the current
# screen (or monitor)
if None not in (final_w, final_h, final_x, final_y):
geom_str = "%dx%d+%d+%d" % (final_w, final_h, final_x, final_y)
win.parse_geometry(geom_str)
return final_x, final_y
if final_w and final_h:
win.set_default_size(final_w, final_h)
if final_x and final_y:
win.move(final_x, final_y)
return final_x, final_y
return None
|