/usr/share/inkscape/extensions/sozi.py is in sozi 12.05-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 | #!/usr/bin/env python2
# Sozi - A presentation tool using the SVG standard
#
# Copyright (C) 2010-2012 Guillaume Savaton
#
# This program is dual licensed under the terms of the MIT license
# or the GNU General Public License (GPL) version 3.
# A copy of both licenses is provided in the doc/ folder of the
# official release of Sozi.
#
# See http://sozi.baierouge.fr/wiki/en:license for details.
# These lines are only needed if you don't put the script directly into
# the installation directory
import sys
# Unix
sys.path.append('/usr/share/inkscape/extensions')
# OS X
sys.path.append('/Applications/Inkscape.app/Contents/Resources/extensions')
# Windows
sys.path.append('C:\Program Files\Inkscape\share\extensions')
# We will use the inkex module with the predefined Effect base class.
import inkex
import pygtk
pygtk.require("2.0")
import gtk
import re
import sozi_upgrade
class SoziField:
"""
A field is a wrapper for a GTK input control mapped to a Sozi frame attribute.
Provide a subclass of SoziField for each type of GTK control.
"""
def __init__(self, parent, attr, label, container_widget, input_widget, default_value, focus_events=True):
"""
Initialize a new field.
- parent: the UI object that contains the current field
- attr: the frame attribute that corresponds to the current field
- label: the human-readable text that describes the current field
- container_widget: the GTK widget that will contain the current field
- input_widget: the GTK input control for the current field
- default_value: the default value of the current field
- focus_events: True if the GTK input control handles focus events, False otherwise
"""
self.parent = parent
self.ns_attr = inkex.addNS(attr, "sozi")
self.label = label
self.container_widget = container_widget
self.input_widget = input_widget
self.default_value = unicode(default_value)
if focus_events:
self.input_widget.connect("focus-out-event", self.on_focus_out)
else:
self.input_widget.connect("changed", self.on_focus_out)
self.last_value = None
self.current_frame = None
def set_value(self, value):
"""
Fill the GTK control for the current field with the given value.
The value must be provided as a string.
Implemented by subclasses.
"""
pass
def get_value(self):
"""
Return the value of the GTK control for the current field.
The value is returned as a string.
Implemented by subclasses.
"""
pass
def reset_last_value(self):
self.last_value = self.get_value()
def write_if_needed(self):
"""
Write the value of the current field to the SVG document.
This operation is performed if all these conditions are met:
- the current field shows a property of an existing frame
- this frame has not been removed from the document
- the value of the current field has changed since it was last written
The write operation is delegated to a SoziFieldAction object.
"""
if self.current_frame is not None and self.current_frame in self.parent.effect.frames and self.last_value != self.get_value():
self.parent.do_action(SoziFieldAction(self))
self.reset_last_value()
def set_with_frame(self, frame):
"""
Set the value of the current field with the corresponding attribute of the given frame.
If frame is None, the field is filled with its default value and edition is inhibited.
The previous value of the field is written to the document if needed.
"""
self.write_if_needed()
self.current_frame = frame
if frame is not None and self.ns_attr in frame["frame_element"].attrib:
self.last_value = frame["frame_element"].attrib[self.ns_attr]
else:
self.last_value = self.default_value
self.set_value(self.last_value)
self.input_widget.set_sensitive(frame is not None)
def on_focus_out(self, widget, event=None):
"""
Event handler, called each time the current field loses focus.
"""
self.write_if_needed()
class SoziTextField(SoziField):
"""
A wrapper for a GTK Entry mapped to a Sozi frame attribute.
"""
def __init__(self, parent, attr, label, default_value):
"""
Initialize a new text field.
See class SoziField for initializer arguments.
"""
SoziField.__init__(self, parent, attr, label, gtk.HBox(), gtk.Entry(), default_value)
self.container_widget.add(gtk.Label(label))
self.container_widget.add(self.input_widget)
def set_value(self, value):
self.input_widget.set_text(value)
def get_value(self):
return unicode(self.input_widget.get_text())
class SoziComboField(SoziField):
"""
A wrapper for a GTK ComboBox with text items mapped to a Sozi frame attribute.
"""
def __init__(self, parent, attr, label, items, default_value):
"""
Initialize a new combo field.
- items: the list of items in the combo box
See class SoziField for other initializer arguments.
"""
SoziField.__init__(self, parent, attr, label, gtk.HBox(), gtk.combo_box_new_text(), default_value, False)
self.items = items
for text in items:
self.input_widget.append_text(text)
self.container_widget.add(gtk.Label(label))
self.container_widget.add(self.input_widget)
def set_value(self, value):
self.input_widget.set_active(self.items.index(value))
def get_value(self):
return unicode(self.items[self.input_widget.get_active()])
class SoziCheckButtonField(SoziField):
"""
A wrapper for a GTK CheckButton mapped to a Sozi frame attribute.
"""
def __init__(self, parent, attr, label, default_value):
"""
Initialize a new check button field.
See class SoziField for initializer arguments.
"""
button = gtk.CheckButton(label)
SoziField.__init__(self, parent, attr, label, button, button, default_value)
def set_value(self, value):
self.input_widget.set_active(value == "true")
def get_value(self):
return unicode("true" if self.input_widget.get_active() else "false")
class SoziSpinButtonField(SoziField):
"""
A wrapper for a GTK SpinButton mapped to a Sozi frame attribute.
"""
def __init__(self, parent, attr, label, min_value, max_value, default_value, factor=1, digits=0, increments=1):
"""
Initialize a new spin button field.
- label: label for the field
- min_value: the minimum float value for the current field
- max_value: the maximum float value for the current field
- default_value: the default_value
- factor : eg: factor 1000 -> comboBox=1.3s ; sozi_svg=1300
- decimals: number of decimals to display, eg: 2=> 1.00 or 0=> 1
- increments: step between 2 number when clic left on a arrow.
See class SoziField for other initializer arguments.
"""
factor = float(factor)
min_value = min_value * factor
max_value = max_value * factor
default_value = default_value * factor
SoziField.__init__(self, parent, attr, label, gtk.HBox(), gtk.SpinButton(digits=digits), default_value)
self.input_widget.set_range(min_value, max_value)
# def set_increments(step, page)
# step : increment applied for each left mousebutton press.
# page : increment applied for each middle mousebutton press.
self.input_widget.set_increments(increments, increments * 2)
self.input_widget.set_numeric(True)
self.container_widget.pack_start(gtk.Label(label))
self.container_widget.pack_start(self.input_widget)
self.factor = factor
def set_value(self, value):
self.input_widget.set_value(float(value) / self.factor)
def get_value(self):
return unicode(float(self.input_widget.get_value()) * self.factor)
def on_focus_out(self, widget, event=None):
self.input_widget.update()
SoziField.on_focus_out(self, widget, event)
class SoziAction:
"""
A wrapper for UI actions.
Action objects can be executed, undone and redone.
They can be stored in undo and redo stacks.
"""
def __init__(self, undo_description, redo_description):
"""
Initialize a new action.
- undo_description: a human-readable text that describes the undo action
- redo_description: a human-readable text that describes the redo action
"""
self.undo_description = undo_description
self.redo_description = redo_description
def do(self):
"""
Execute the current action.
Implemented by subclasses.
"""
pass
def undo(self):
"""
Undo the current action.
Implemented by subclasses.
"""
pass
def redo(self):
"""
Redo the current action.
The default implementation simply calls the do() method on the current action.
Override this method to provide a specific implementation.
"""
self.do()
class SoziFieldAction(SoziAction):
"""
A wrapper for a field modification action.
Executing a field action will write the field value to the SVG document.
"""
def __init__(self, field):
"""
Initialize a new field action for the given field.
The action object saves a copy of the previous and current values of the field.
"""
index = field.parent.effect.frames.index(field.current_frame)
SoziAction.__init__(self,
"Restore " + field.label + " in frame " + str(index + 1),
"Change " + field.label + " in frame " + str(index + 1)
)
self.field = field
self.frame = field.current_frame
self.last_value = field.last_value
self.value = field.get_value()
def do(self):
"""
Write the new value of the field to the current frame.
"""
self.frame["frame_element"].set(self.field.ns_attr, self.value)
def undo(self):
"""
Restore the previous value of the field in the frame and in the UI.
If needed, select the frame that was active when the field was modified.
"""
self.frame["frame_element"].set(self.field.ns_attr, self.last_value)
if self.field.current_frame is self.frame:
self.field.set_value(self.last_value)
self.field.reset_last_value()
else:
self.field.parent.select_frame(self.frame)
def redo(self):
"""
Write the new value of the field to the frame and to the UI.
If needed, select the frame that was active when the field was modified.
"""
self.do()
if self.field.current_frame is self.frame:
self.field.set_value(self.value)
self.field.reset_last_value()
else:
self.field.parent.select_frame(self.frame)
class SoziCreateAction(SoziAction):
"""
A wrapper for a frame creation action.
"""
def __init__(self, ui):
"""
Initialize a new frame creation action.
- ui: an instance of SoziUI
"""
# The new frame will be added at the end of the presentation
new_frame_number = str(len(ui.effect.frames) + 1)
SoziAction.__init__(self,
"Remove frame " + new_frame_number,
"Recreate frame " + new_frame_number)
self.ui = ui
def do(self):
"""
Create a new frame and select it in the frame list.
"""
self.ui.fill_form(None)
# The new frame is a copy of the currently selected frame
frame = self.ui.effect.create_new_frame(None)
for field in self.ui.fields.itervalues():
frame["frame_element"].set(field.ns_attr, field.get_value())
self.ui.effect.add_frame(frame)
self.ui.append_frame_title(-1)
self.ui.select_index(-1)
def undo(self):
"""
Remove the created frame and select the previously selected frame.
"""
self.ui.remove_last_frame_title()
self.ui.effect.delete_frame(-1)
class SoziDeleteAction(SoziAction):
"""
A wrapper for a frame delete action.
"""
def __init__(self, ui):
"""
Initialize a new frame delete action.
- ui: an instance of SoziUI
"""
index = ui.get_selected_index()
SoziAction.__init__(self,
"Restore frame " + str(index + 1),
"Remove frame " + str(index + 1))
self.ui = ui
self.index = index
self.frame = ui.effect.frames[index]
model = self.ui.list_view.get_model()
self.row = model.get(model.get_iter(index), 0, 1, 2)
def do(self):
"""
Remove the current frame and select the next one in the frame list.
"""
self.ui.effect.delete_frame(self.index)
self.ui.remove_frame_title(self.index)
# If the removed frame was the last, and if the frame list is not empty,
# select the last frame
if self.index > 0 and self.index >= len(self.ui.effect.frames):
self.ui.select_index(-1)
def undo(self):
"""
Add the removed frame and select it.
"""
self.ui.effect.insert_frame(self.index, self.frame)
self.ui.insert_row(self.index, self.row)
class SoziDuplicateAction(SoziAction):
"""
A wrapper for a frame creation action.
"""
def __init__(self, ui):
"""
Initialize a new frame creation action.
- ui: an instance of SoziUI
"""
# The new frame will be added at the end of the presentation
new_frame_number = str(len(ui.effect.frames) + 1)
SoziAction.__init__(self,
"Remove frame " + new_frame_number,
"Recreate frame " + new_frame_number)
self.ui = ui
# The new frame is a copy of the currently selected frame
self.index = ui.get_selected_index()
self.frame = ui.effect.create_new_frame(self.index)
for field in ui.fields.itervalues():
self.frame["frame_element"].set(field.ns_attr, field.get_value())
def do(self):
"""
Create a new frame and select it in the frame list.
"""
self.ui.effect.add_frame(self.frame)
self.ui.append_frame_title(-1)
self.ui.select_index(-1)
def undo(self):
"""
Remove the created frame and select the previously selected frame.
"""
self.ui.remove_last_frame_title()
self.ui.effect.delete_frame(-1)
if self.index is not None:
self.ui.select_index(self.index)
class SoziReorderAction(SoziAction):
"""
A wrapper for a frame reordering action.
"""
def __init__(self, ui, down):
"""
Initialize a new frame reorder action.
- ui: an instance of SoziUI
"""
index = ui.get_selected_index()
if down:
index_other = index + 1
else:
index_other = index - 1
SoziAction.__init__(self,
"Move frame " + str(index_other + 1) + (" up" if down else " down"),
"Move frame " + str(index + 1) + (" down" if down else " up"))
self.ui = ui
self.index = index
self.index_other = index_other
def move(self, first, second):
# Swap frames in the document
self.ui.effect.swap_frames(first, second)
# Swap frame numbers in current and other rows
model = self.ui.list_view.get_model()
iter_first = model.get_iter(first)
iter_second = model.get_iter(second)
model.set(iter_first, 0, second + 1)
model.set(iter_second, 0, first + 1)
# Move selected row
if first < second:
model.move_after(iter_first, iter_second)
else:
model.move_before(iter_first, iter_second)
self.ui.list_view.scroll_to_cell(second)
# Update up/down button sensitivity
self.ui.up_button.set_sensitive(second > 0)
self.ui.down_button.set_sensitive(second < len(self.ui.effect.frames) - 1)
def do(self):
"""
Swap current frame and next/previous frame.
"""
self.move(self.index, self.index_other)
def undo(self):
"""
Swap frames back.
"""
self.move(self.index_other, self.index)
self.ui.select_index(self.index)
def redo(self):
"""
Swap frames again.
"""
self.do()
self.ui.select_index(self.index_other)
class SoziUI:
"""
The user interface of Sozi.
"""
PROFILES = ["linear",
"accelerate", "strong-accelerate",
"decelerate", "strong-decelerate",
"accelerate-decelerate", "strong-accelerate-decelerate",
"decelerate-accelerate", "strong-decelerate-accelerate"]
def __init__(self, effect):
"""
Create a new window with the frame edition form.
- effect: the effect instance given by Inkscape
"""
self.effect = effect
self.undo_stack = []
self.redo_stack = []
self.window = gtk.Window(gtk.WINDOW_TOPLEVEL)
self.window.connect("destroy", self.on_destroy)
self.window.connect("key-press-event", self.on_key_press)
self.window.set_title("Sozi")
self.window.set_icon_from_file(__file__ + ".png")
self.window.set_border_width(5)
# Enable icons on stock buttons
#gtk.settings_get_default().set_long_property("gtk-button-images", True, "Sozi")
# Create fields for frame information
self.fields = {
"title": SoziTextField(self, "title", "Title", "New frame"),
"hide": SoziCheckButtonField(self, "hide", "Hide", "true"),
"clip": SoziCheckButtonField(self, "clip", "Clip", "true"),
"timeout-enable": SoziCheckButtonField(self, "timeout-enable", "Timeout enable", "false"),
"timeout-ms": SoziSpinButtonField(self, "timeout-ms", "Timeout (s)", 0, 3600, 5, factor=1000, digits=2, increments=0.2),
"transition-duration-ms": SoziSpinButtonField(self, "transition-duration-ms", "Duration (s)", 0, 3600, 1, factor=1000, digits=2, increments=0.1),
"transition-zoom-percent": SoziSpinButtonField(self, "transition-zoom-percent", "Zoom (%)", -100, 100, 0, increments=5),
"transition-profile": SoziComboField(self, "transition-profile", "Profile", SoziUI.PROFILES, SoziUI.PROFILES[0])
}
# Undo/redo widgets
self.undo_button = gtk.ToolButton(gtk.STOCK_UNDO)
self.undo_button.set_sensitive(False)
self.undo_button.set_label("Annuler")
self.undo_button.connect("clicked", self.on_undo)
self.redo_button = gtk.ToolButton(gtk.STOCK_REDO)
self.redo_button.set_sensitive(False)
self.redo_button.connect("clicked", self.on_redo)
toolBar = gtk.Toolbar()
toolBar.set_style(gtk.TOOLBAR_ICONS)
toolBar.set_icon_size(gtk.ICON_SIZE_SMALL_TOOLBAR)
toolBar.add(self.undo_button)
toolBar.add(self.redo_button)
# Frame properties
frame_box = gtk.VBox(spacing=0)
frame_box.pack_start(self.fields["title"].container_widget, expand=False)
frame_box.pack_start(self.fields["hide"].container_widget, expand=False)
frame_box.pack_start(self.fields["clip"].container_widget, expand=False)
frame_box.pack_start(self.fields["timeout-enable"].container_widget, expand=False)
frame_box.pack_start(self.fields["timeout-ms"].container_widget, expand=False)
frame_group = gtk.Frame()
# fixme, spaces are here for set width of list..
frame_label=gtk.Label("<b>Frame properties</b> ")
frame_label.set_use_markup(True) # enable bold with <b>
frame_group.set_label_widget(frame_label)
frame_group.add(frame_box)
# Transition properties
transition_box = gtk.VBox(spacing=5)
transition_box.pack_start(self.fields["transition-duration-ms"].container_widget, expand=False)
transition_box.pack_start(self.fields["transition-zoom-percent"].container_widget, expand=False)
transition_box.pack_start(self.fields["transition-profile"].container_widget, expand=False)
transition_group = gtk.Frame("Transition")
transition_label=gtk.Label("<b>Transition</b> ")
transition_label.set_use_markup(True) # enable bold with <b>
transition_group.set_label_widget(transition_label)
transition_group.add(transition_box)
# Fill right pane
right_pane = gtk.VBox(spacing=5)
right_pane.pack_start(frame_group, expand=False)
right_pane.pack_start(transition_group, expand=False)
# Create frame list
list_renderer = gtk.CellRendererText()
list_renderer.set_property("background", "white")
sequence_column = gtk.TreeViewColumn("Seq.", list_renderer, text=0, foreground=2)
title_column = gtk.TreeViewColumn("Title", list_renderer, text=1, foreground=2)
store = gtk.ListStore(int, str, str)
self.list_view = gtk.TreeView(store)
self.list_view.append_column(sequence_column)
self.list_view.append_column(title_column)
list_scroll = gtk.ScrolledWindow()
list_scroll.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
list_scroll.add(self.list_view)
selection = self.list_view.get_selection()
selection.set_mode(gtk.SELECTION_SINGLE) # TODO multiple selection
selection.set_select_function(self.on_selection_changed)
# Create "new" button
# This button is enabled only if an element is selected in Inkscape
self.new_button = gtk.ToolButton()
if len(effect.selected) > 0:
# The tooltip of the "new" button will show the tag of the SVG element
# selected in Inkscape, removing the namespace URI if present
self.new_button.set_tooltip_text("Create a new frame using the selected '" +
re.sub("{.*}", "", effect.selected.values()[0].tag) + "'")
else:
self.new_button.set_sensitive(False)
self.new_button.set_stock_id(gtk.STOCK_ADD)
self.new_button.connect("clicked", self.on_create_new_frame)
# Create "delete" and "duplicate" buttons
# These buttons are disabled until a frame is selected
self.delete_button = gtk.ToolButton()
self.delete_button.set_tooltip_text("Delete the current frame")
self.delete_button.set_stock_id(gtk.STOCK_REMOVE)
self.delete_button.connect("clicked", self.on_delete_frame)
self.delete_button.set_sensitive(False)
self.duplicate_button = gtk.ToolButton()
self.duplicate_button.set_tooltip_text("Duplicate the current frame")
self.duplicate_button.set_stock_id(gtk.STOCK_COPY)
self.duplicate_button.connect("clicked", self.on_duplicate_frame)
self.duplicate_button.set_sensitive(False)
# Create up/down buttons
# These buttons are disabled until a frame is selected
self.up_button = gtk.ToolButton()
self.up_button.set_tooltip_text("Move the current frame up")
self.up_button.set_stock_id(gtk.STOCK_GO_UP)
self.up_button.connect("clicked", self.on_move_frame_up)
self.up_button.set_sensitive(False)
self.down_button = gtk.ToolButton()
self.down_button.set_tooltip_text("Move the current frame down")
self.down_button.set_stock_id(gtk.STOCK_GO_DOWN)
self.down_button.connect("clicked", self.on_move_frame_down)
self.down_button.set_sensitive(False)
listToolBar = gtk.Toolbar()
listToolBar.set_icon_size(1)
listToolBar.add(self.new_button)
listToolBar.add(self.delete_button)
listToolBar.add(self.duplicate_button)
listToolBar.add(self.up_button)
listToolBar.add(self.down_button)
# Fill left pane
left_pane_content = gtk.VBox(spacing=0)
left_pane_content.pack_start(list_scroll, expand=True, fill=True)
left_pane_content.pack_end(listToolBar, expand=False)
list_group = gtk.Frame()
# fixme, spaces are here for set width of list..
list_frame_label=gtk.Label("<b>Frame list</b> ")
list_frame_label.set_use_markup(True) # enable bold with <b>
list_group.set_label_widget(list_frame_label)
list_group.add(left_pane_content)
left_pane = list_group
hbox = gtk.HBox(spacing=5)
hbox.pack_start(left_pane)
hbox.pack_start(right_pane)
# button Bar
cancel_button = gtk.Button(stock=gtk.STOCK_CANCEL)
cancel_button.set_tooltip_text("Cancel all changes and go back to Inkscape")
cancel_button.connect("clicked", self.on_full_undo)
ok_button = gtk.Button(stock=gtk.STOCK_OK)#or Apply
ok_button.set_tooltip_text("Apply changes and go back to Inkscape")
ok_button.connect("clicked", gtk.main_quit)
buttonBar = gtk.HBox(spacing=10)
buttonBar.pack_end(ok_button, False, False)
buttonBar.pack_end(cancel_button, False, False)
statusBar = gtk.Statusbar()
#statusBar.push(statusBar.getContexteId("a"),"Etat initial")
vbox = gtk.VBox(spacing=5)
vbox.pack_start(toolBar)
vbox.add(hbox)
vbox.add(buttonBar)
vbox.pack_end(statusBar)
self.window.add(vbox)
self.window.show_all()
# If an element is selected in Inkscape, and if it corresponds to
# one or more existing frames, select the first matching frame.
# If no element is selected in Inkscape, if at least one frame exists
# in the document, select the first frame.
selected_frame = None
if len(effect.selected) > 0:
for f in effect.frames:
if f["svg_element"].attrib["id"] in effect.selected:
selected_frame = f
break
elif len(effect.frames) > 0:
selected_frame = effect.frames[0]
# Fill frame list
for i in range(len(effect.frames)):
self.append_frame_title(i)
# Select current frame in frame list and fill form
if selected_frame is not None:
index = effect.frames.index(selected_frame)
self.list_view.get_selection().select_path((index,))
self.list_view.scroll_to_cell(index)
else:
self.fill_form(None)
gtk.main()
def append_frame_title(self, index):
"""
Append the title of the frame at the given index to the frame list view.
This method is used when filling the list view initially or when creating
a new frame.
"""
# A negative index is counted back from the end of the frame list.
# This is not needed for Python arrays, but we need to show the corect
# frame number in the list view.
if (index < 0):
index += len(self.effect.frames)
frame = self.effect.frames[index]
# Get the title of the frame
title_attr = inkex.addNS("title", "sozi")
if title_attr in frame["frame_element"].attrib:
title = frame["frame_element"].attrib[title_attr]
else:
title = "Untitled"
# The text color will show whether the current frame
# corresponds to the selected object in Inkscape
if frame["svg_element"] in self.effect.selected.values():
color = "#ff0000"
else:
color = "#000000"
self.list_view.get_model().append([index + 1, title, color])
def insert_row(self, index, row):
"""
Insert a row in the frame list view.
This method is used when undoing a frame deletion.
"""
model = self.list_view.get_model()
model.insert(index, row)
# Renumber frames in list view
for i in range(index + 1, len(self.effect.frames)):
model.set(model.get_iter(i), 0, i + 1)
# Select the inserted frame
self.select_index(index)
def remove_last_frame_title(self):
"""
Remove the title of the last frame in the list view.
This method is used when undoing the creation of a new frame.
"""
model = self.list_view.get_model()
model.remove(model.get_iter(len(self.effect.frames) - 1))
def remove_frame_title(self, index):
"""
Remove the title of the frame at the given index from the list view.
This method is used when deleting a frame.
"""
model = self.list_view.get_model()
iter = model.get_iter(index)
if model.remove(iter):
self.list_view.get_selection().select_iter(iter)
# Renumber frames
for i in range(index, len(self.effect.frames)):
model.set(model.get_iter(i), 0, i + 1)
else:
self.fill_form(None)
def fill_form(self, frame):
"""
Fill all fields with the values of the attributes of the given frame.
"""
for field in self.fields.itervalues():
field.set_with_frame(frame)
self.duplicate_button.set_sensitive(frame is not None )
self.delete_button.set_sensitive(frame is not None)
def get_selected_index(self):
"""
Return the index of the currently selected frame.
None is returned if no frame is selected.
"""
selection = self.list_view.get_selection()
model, iter = selection.get_selected()
if iter:
return model.get_path(iter)[0]
else:
return None
def select_index(self, index):
"""
Select the frame at the given index.
A negative index is counted back from the end of the frame list.
"""
if (index < 0):
index += len(self.effect.frames)
self.list_view.get_selection().select_path((index,))
self.list_view.scroll_to_cell(index)
def select_frame(self, frame):
"""
Select the given frame in the frame list.
"""
self.select_index(self.effect.frames.index(frame))
def on_create_new_frame(self, widget):
"""
Event handler: click on button "create new frame".
"""
self.do_action(SoziCreateAction(self))
def on_delete_frame(self, widget):
"""
Event handler: click on button "Delete frame".
"""
self.do_action(SoziDeleteAction(self))
def on_duplicate_frame(self, widget):
"""
"""
self.do_action(SoziDuplicateAction(self))
def on_move_frame_up(self, widget):
"""
Event handler: click on button "Move frame up".
"""
self.do_action(SoziReorderAction(self, False))
def on_move_frame_down(self, widget):
"""
Event handler: click on button "Move frame down".
"""
self.do_action(SoziReorderAction(self, True))
def on_selection_changed(self, path):
"""
Event handler: selection changed in frame list view.
This event can be triggered either due to a user action
or due to a programmatic selection change.
"""
if self.list_view.get_selection().path_is_selected(path):
# If the selection change happens on a selected row
# then the action is a deselection
frame = None
self.up_button.set_sensitive(False)
self.down_button.set_sensitive(False)
self.delete_button.set_sensitive(False)
else:
# If the selection change happens on a non-selected row
# then the action is a selection
index = path[0]
frame = self.effect.frames[index]
self.up_button.set_sensitive(index > 0)
self.down_button.set_sensitive(index < len(self.effect.frames) - 1)
self.delete_button.set_sensitive(True)
# Show the properties of the selected frame,
# or default values if no frame is selected.
self.fill_form(frame)
# Success: highlight or clear the affected row in the frame list
return True
def on_key_press(self, widget, event):
if event.state & gtk.gdk.CONTROL_MASK:
if event.keyval == gtk.keysyms.z:
self.window.set_focus(None)
self.on_undo()
elif event.keyval == gtk.keysyms.y:
self.on_redo()
def do_action(self, action):
"""
Execute the given action and push it to the undo stack.
The redo stack is emptied.
"""
action.do()
self.undo_stack.append(action)
self.redo_stack = []
self.finalize_action(action)
def on_undo(self, widget=None):
"""
Event handler: click on button "Undo".
Undo the action at the top of the undo stack and push it to the redo stack.
"""
if self.undo_stack:
action = self.undo_stack.pop()
self.redo_stack.append(action)
action.undo()
self.finalize_action(action)
def on_full_undo(self, widget=None):
"""
Event handler: click on button "Cancel".
Undo all actions.
"""
while self.undo_stack:
self.on_undo()
gtk.main_quit()
def on_redo(self, widget=None):
"""
Event handler: click on button "Redo".
Execute the action at the top of the redo stack and push it to the undo stack.
"""
if self.redo_stack:
action = self.redo_stack.pop()
self.undo_stack.append(action)
action.redo()
self.finalize_action(action)
def finalize_action(self, action):
"""
Update the UI after an action has been executed or undone.
"""
# Update the frame list view if the "title" field of a frame has changed.
if isinstance(action, SoziFieldAction) and action.field is self.fields["title"]:
index = self.effect.frames.index(action.frame)
model = self.list_view.get_model()
model.set(model.get_iter(index), 1, action.frame["frame_element"].get(action.field.ns_attr))
# Update the status of the "Undo" button
if self.undo_stack:
self.undo_button.set_tooltip_text(self.undo_stack[-1].undo_description)
else:
self.undo_button.set_tooltip_text("")
self.undo_button.set_sensitive(bool(self.undo_stack))
# Update the status of the "Redo" button
if self.redo_stack:
self.redo_button.set_tooltip_text(self.redo_stack[-1].redo_description)
else:
self.redo_button.set_tooltip_text("")
self.redo_button.set_sensitive(bool(self.redo_stack))
def on_destroy(self, widget):
"""
Event handler: close the Sozi window.
"""
gtk.main_quit()
class Sozi(inkex.Effect):
NS_URI = u"http://sozi.baierouge.fr"
def __init__(self):
inkex.Effect.__init__(self)
inkex.NSS[u"sozi"] = Sozi.NS_URI
self.frames = []
def effect(self):
sozi_upgrade.upgrade_or_install(self)
self.analyze_document()
self.ui = SoziUI(self)
def analyze_document(self):
"""
Analyze the document and collect information about the presentation.
Frames with no corresponding SVG element are removed.
Frames numbers are updated if needed.
FIXME this method currently does not support frames with layers
"""
# Get list of valid frame elements and remove orphan frames
refid_attr = inkex.addNS("refid", "sozi")
self.frames = []
for f in self.document.xpath("//sozi:frame", namespaces=inkex.NSS):
if refid_attr in f.attrib:
e = self.document.xpath("//svg:*[@id='" + f.attrib[refid_attr] + "']", namespaces=inkex.NSS)
if len(e) == 0:
self.document.getroot().remove(f)
else:
self.frames.append(
{
"frame_element": f,
"svg_element": e[0]
}
)
else:
# Frame elements with layers do not always contain a "refid" attribute.
# FIXME add the frame only if it contains valid layer elements
self.frames.append(
{
"frame_element": f,
"svg_element": None
}
)
# Sort frames by sequence attribute
sequence_attr = inkex.addNS("sequence", "sozi")
self.frames = sorted(self.frames, key=lambda f:
int(f["frame_element"].attrib[sequence_attr]) if sequence_attr in f["frame_element"].attrib else len(self.frames))
# Renumber frames
for i, f in enumerate(self.frames):
f["frame_element"].set(inkex.addNS("sequence", "sozi"), unicode(i + 1))
def swap_frames(self, first, second):
"""
Swap frames with the given indices.
"""
# Swap frames in SVG document
sequence_attr = inkex.addNS("sequence", "sozi")
self.frames[first]["frame_element"].set(sequence_attr, unicode(second + 1))
self.frames[second]["frame_element"].set(sequence_attr, unicode(first + 1))
# Swap frames in frame list
self.frames[first], self.frames[second] = self.frames[second], self.frames[first]
def create_new_frame(self, index):
"""
Create a new frame using the SVG element of the frame at the given index.
The new frame is not added to the document.
"""
if index is not None:
svg_element = self.frames[index]["svg_element"]
else:
svg_element = self.selected.values()[0]
frame_element = inkex.etree.Element(inkex.addNS("frame", "sozi"))
frame_element.set(inkex.addNS("refid", "sozi"), svg_element.attrib["id"]) # TODO check namespace?
frame_element.set(inkex.addNS("sequence", "sozi"), unicode(len(self.frames)+1))
frame_element.set("id", self.uniqueId("frame" + unicode(len(self.frames)+1)))
frame = {
"frame_element": frame_element,
"svg_element": svg_element
}
return frame
def add_frame(self, frame):
"""
Add the given frame to the document.
"""
self.document.getroot().append(frame["frame_element"])
self.frames.append(frame)
def insert_frame(self, index, frame):
"""
Insert the given frame at the given index.
"""
self.document.getroot().append(frame["frame_element"])
self.frames.insert(index, frame)
self.renumber_from_index(index)
def delete_frame(self, index):
"""
Remove the frame at the given index from the document.
"""
self.document.getroot().remove(self.frames[index]["frame_element"])
del self.frames[index]
self.renumber_from_index(index)
def renumber_from_index(self, index):
if index >= 0:
for i in range(index, len(self.frames)):
self.frames[i]["frame_element"].set(inkex.addNS("sequence", "sozi"), unicode(i + 1))
# Create effect instance
effect = Sozi()
effect.affect()
|