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
| # Copyright (c) 2008, Guilherme Polo
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
"""
This contains a wrapper class for the tktable widget as well a class for using
tcl arrays that are, in some instances, required by tktable.
"""
__author__ = "Guilherme Polo <ggpolo@gmail.com>"
__all__ = ["ArrayVar", "Table"]
import Tkinter,os
def _setup_master(master):
if master is None:
if Tkinter._support_default_root:
master = Tkinter._default_root or Tkinter.Tk()
else:
raise RuntimeError("No master specified and Tkinter is "
"configured to not support default master")
return master
class ArrayVar(Tkinter.Variable):
"""Class for handling Tcl arrays.
An array is actually an associative array in Tcl, so this class supports
some dict operations.
"""
def __init__(self, master=None, name=None):
# Tkinter.Variable.__init__ is not called on purpose! I don't wanna
# see an ugly _default value in the pretty array.
self._master = _setup_master(master)
self._tk = self._master.tk
if name:
self._name = name
else:
self._name = 'PY_VAR%s' % id(self)
def __del__(self):
if bool(self._tk.call('info', 'exists', self._name)):
self._tk.globalunsetvar(self._name)
def __len__(self):
return int(self._tk.call('array', 'size', str(self)))
def __getitem__(self, key):
return self.get(key)
def __setitem__(self, key, value):
self.set(**{str(key): value})
def names(self):
return self._tk.call('array', 'names', self._name)
def get(self, key=None):
if key is None:
flatten_pairs = self._tk.call('array', 'get', str(self))
return dict(zip(flatten_pairs[::2], flatten_pairs[1::2]))
return self._tk.globalgetvar(str(self), str(key))
def set(self, **kw):
self._tk.call('array', 'set', str(self), Tkinter._flatten(kw.items()))
def unset(self, pattern=None):
"""Unsets all of the elements in the array. If pattern is given, only
the elements that match pattern are unset. """
self._tk.call('array', 'unset', str(self), pattern)
_TKTABLE_LOADED = False
class Table(Tkinter.Widget):
"""Create and manipulate tables."""
_switches = ('holddimensions', 'holdselection', 'holdtags', 'holdwindows',
'keeptitles', '-')
_tabsubst_format = ('%c', '%C', '%i', '%r', '%s', '%S', '%W')
_tabsubst_commands = ('browsecommand', 'browsecmd', 'command',
'selectioncommand', 'selcmd',
'validatecommand', 'valcmd')
def __init__(self, master=None, **kw):
master = _setup_master(master)
global _TKTABLE_LOADED
if not _TKTABLE_LOADED:
tktable_lib = os.environ.get('TKTABLE_LIBRARY')
if tktable_lib:
master.tk.eval('global auto_path; '
'lappend auto_path {%s}' % tktable_lib)
master.tk.call('package', 'require', 'Tktable')
_TKTABLE_LOADED = True
Tkinter.Widget.__init__(self, master, 'table', kw)
def _options(self, cnf, kw=None):
if kw:
cnf = Tkinter._cnfmerge((cnf, kw))
else:
cnf = Tkinter._cnfmerge(cnf)
res = ()
for k, v in cnf.iteritems():
if callable(v):
if k in self._tabsubst_commands:
v = "%s %s" % (self._register(v, self._tabsubst),
' '.join(self._tabsubst_format))
else:
v = self._register(v)
res += ('-%s' % k, v)
return res
def _tabsubst(self, *args):
if len(args) != len(self._tabsubst_format):
return args
tk = self.tk
c, C, i, r, s, S, W = args
e = Tkinter.Event()
e.widget = self
e.c = tk.getint(c)
e.i = tk.getint(i)
e.r = tk.getint(r)
e.C = "%d,%d" % (e.r, e.c)
e.s = s
e.S = S
try:
e.W = self._nametowidget(W)
except KeyError:
e.W = None
return (e,)
def _handle_switches(self, args):
args = args or ()
return tuple(('-%s' % x) for x in args if x in self._switches)
def activate(self, index):
"""Set the active cell to the one indicated by index."""
self.tk.call(self._w, 'activate', index)
def bbox(self, first, last=None):
"""Return the bounding box for the specified cell (range) as a
4-tuple of x, y, width and height in pixels. It clips the box to
the visible portion, if any, otherwise an empty tuple is returned."""
return self._getints(self.tk.call(self._w, 'bbox', first, last)) or ()
def clear(self, option, first=None, last=None):
"""This is a convenience routine to clear certain state information
managed by the table. first and last represent valid table indices.
If neither are specified, then the command operates on the whole
table."""
self.tk.call(self._w, 'clear', option, first, last)
def clear_cache(self, first=None, last=None):
"""Clear the specified section of the cache, if the table has been
keeping one."""
self.clear('cache', first, last)
def clear_sizes(self, first=None, last=None):
"""Clear the specified row and column areas of specific height/width
dimensions. When just one index is specified, for example 2,0, that
is interpreted as row 2 and column 0."""
self.clear('sizes', first, last)
def clear_tags(self, first=None, last=None):
"""Clear the specified area of tags (all row, column and cell tags)."""
self.clear('tags', first, last)
def clear_all(self, first=None, last=None):
"""Perform all of the above clear functions on the specified area."""
self.clear('all', first, last)
def curselection(self, value=None):
"""With no arguments, it returns the sorted indices of the currently
selected cells. Otherwise it sets all the selected cells to the given
value if there is an associated ArrayVar and the state is not
disabled."""
result = self.tk.call(self._w, 'curselection', value)
if value is None:
return result
def curvalue(self, value=None):
"""If no value is given, the value of the cell being edited (indexed
by active) is returned, else it is set to the given value. """
return self.tk.call(self._w, 'curvalue', value)
def delete_active(self, index1, index2=None):
"""Deletes text from the active cell. If only one index is given,
it deletes the character after that index, otherwise it deletes from
the first index to the second. index can be a number, insert or end."""
self.tk.call(self._w, 'delete', 'active', index1, index2)
def delete_cols(self, index, count=None, switches=None):
args = self._handle_switches(switches) + (index, count)
self.tk.call(self._w, 'delete', 'cols', *args)
def delete_rows(self, index, count=None, switches=None):
args = self._handle_switches(switches) + (index, count)
self.tk.call(self._w, 'delete', 'rows', *args)
def get(self, first, last=None):
"""Returns the value of the cells specified by the table indices
first and (optionally) last."""
return self.tk.call(self._w, 'get', first, last)
def height(self, row=None, **kwargs):
"""If row and kwargs are not given, a list describing all rows for
which a width has been set is returned.
If row is given, the height of that row is returnd.
If kwargs is given, then it sets the key/value pairs, where key is a
row and value represents the height for the row."""
if row is None and not kwargs:
pairs = self.tk.splitlist(self.tk.call(self._w, 'height'))
return dict(pair.split() for pair in pairs)
elif row:
return int(self.tk.call(self._w, 'height', str(row)))
args = Tkinter._flatten(kwargs.items())
self.tk.call(self._w, 'height', *args)
def hidden(self, *args):
"""When called without args, it returns all the hidden cells (those
cells covered by a spanning cell). If one index is specified, it
returns the spanning cell covering that index, if any. If multiple
indices are specified, it returns 1 if all indices are hidden cells,
0 otherwise."""
return self.tk.call(self._w, 'hidden', *args)
def icursor(self, arg=None):
"""If arg is not specified, return the location of the insertion
cursor in the active cell. Otherwise, set the cursor to that point in
the string.
0 is before the first character, you can also use insert or end for
the current insertion point or the end of the text. If there is no
active cell, or the cell or table is disabled, this will return -1."""
return self.tk.call(self._w, 'icursor', arg)
def index(self, index, rc=None):
"""Return the integer cell coordinate that corresponds to index in the
form row, col. If rc is specified, it must be either 'row' or 'col' so
only the row or column index is returned."""
res = self.tk.call(self._w, 'index', index, rc)
if rc is None:
return res
else:
return int(res)
def insert_active(self, index, value):
"""The value is a text string which is inserted at the index postion
of the active cell. The cursor is then positioned after the new text.
index can be a number, insert or end. """
self.tk.call(self._w, 'insert', 'active', index, value)
def insert_cols(self, index, count=None, switches=None):
args = self._handle_switches(switches) + (index, count)
self.tk.call(self._w, 'insert', 'cols', *args)
def insert_rows(self, index, count=None, switches=None):
args = self._handle_switches(switches) + (index, count)
self.tk.call(self._w, 'insert', 'rows', *args)
#def postscript(self, **kwargs):
# """Skip this command if you are under Windows.
#
# Accepted options:
# colormap, colormode, file, channel, first, fontmap, height,
# last, pageanchor, pageheight, pagewidth, pagex, pagey, rotate,
# width, x, y
# """
# args = ()
# for key, val in kwargs.iteritems():
# args += ('-%s' % key, val)
#
# return self.tk.call(self._w, 'postscript', *args)
def reread(self):
"""Rereads the old contents of the cell back into the editing buffer.
Useful for a key binding when <Escape> is pressed to abort the edit
(a default binding)."""
self.tk.call(self._w, 'reread')
def scan_mark(self, x, y):
self.tk.call(self._w, 'scan', 'mark', x, y)
def scan_dragto(self, x, y):
self.tk.call(self._w, 'scan', 'dragto', x, y)
def see(self, index):
self.tk.call(self._w, 'see', index)
def selection_anchor(self, index):
self.tk.call(self._w, 'selection', 'anchor', index)
def selection_clear(self, first, last=None):
self.tk.call(self._w, 'selection', 'clear', first, last)
def selection_includes(self, index):
return self.getboolean(self.tk.call(self._w, 'selection', 'includes',
index))
def selection_set(self, first, last=None):
self.tk.call(self._w, 'selection', 'set', first, last)
def set(self, rc=None, index=None, *args, **kwargs):
"""If rc is specified (either 'row' or 'col') then it is assumes that
args (if given) represents values which will be set into the
subsequent columns (if row is specified) or rows (for col).
If index is not None and args is not given, then it will return the
value(s) for the cell(s) specified.
If kwargs is given, assumes that each key in kwargs is a index in this
table and sets the specified index to the associated value. Table
validation will not be triggered via this method.
Note that the table must have an associated array (defined through the
variable option) in order to this work."""
if not args and index is not None:
if rc:
args = (rc, index)
else:
args = (index, )
return self.tk.call(self._w, 'set', *args)
if rc is None:
args = Tkinter._flatten(kwargs.items())
self.tk.call(self._w, 'set', *args)
else:
self.tk.call(self._w, 'set', rc, index, args)
def spans(self, index=None, **kwargs):
"""Manipulate row/col spans.
When called with no arguments, all known spans are returned as a dict.
When called with only the index, the span for that index only is
returned, if any. Otherwise kwargs is assumed to contain keys/values
pairs used to set spans. A span starts at the row,col defined by a key
and continues for the specified number of rows,cols specified by
its value. A span of 0,0 unsets any span on that cell."""
if kwargs:
args = Tkinter._flatten(kwargs.items())
self.tk.call(self._w, 'spans', *args)
else:
return self.tk.call(self._w, 'spans', index)
def tag_cell(self, tagname, *args):
return self.tk.call(self._w, 'tag', 'cell', tagname, *args)
def tag_cget(self, tagname, option):
return self.tk.call(self._w, 'tag', 'cget', tagname, '-%s' % option)
def tag_col(self, tagname, *args):
return self.tk.call(self._w, 'tag', 'col', tagname, *args)
def tag_configure(self, tagname, option=None, **kwargs):
"""Query or modify options associated with the tag given by tagname.
If no option is specified, a dict describing all of the available
options for tagname is returned. If option is specified, then the
command returns a list describing the one named option. Lastly, if
kwargs is given then it corresponds to option-value pairs that should
be modified."""
if option is None and not kwargs:
split1 = self.tk.splitlist(
self.tk.call(self._w, 'tag', 'configure', tagname))
result = {}
for item in split1:
res = self.tk.splitlist(item)
result[res[0]] = res[1:]
return result
elif option:
return self.tk.call(self._w, 'tag', 'configure', tagname,
'-%s' % option)
else:
args = ()
for key, val in kwargs.iteritems():
args += ('-%s' % key, val)
self.tk.call(self._w, 'tag', 'configure', tagname, *args)
def tag_delete(self, tagname):
self.tk.call(self._w, 'tag', 'delete', tagname)
def tag_exists(self, tagname):
return self.getboolean(self.tk.call(self._w, 'tag', 'exists', tagname))
def tag_includes(self, tagname, index):
return self.getboolean(self.tk.call(self._w, 'tag', 'includes',
tagname, index))
def tag_lower(self, tagname, belowthis=None):
self.tk.call(self._w, 'tag', 'lower', belowthis)
def tag_names(self, pattern=None):
return self.tk.call(self._w, 'tag', 'names', pattern)
def tag_raise(self, tagname, abovethis=None):
self.tk.call(self._w, 'tag', 'raise', tagname, abovethis)
def tag_row(self, tagname, *args):
return self.tk.call(self._w, 'tag', 'row', tagname, *args)
def validate(self, index):
"""Explicitly validates the specified index based on the current
callback set for the validatecommand option. Return 0 or 1 based on
whether the cell was validated."""
return self.tk.call(self._w, 'validate', index)
@property
def version(self):
"""Return tktable's package version."""
return self.tk.call(self._w, 'version')
def width(self, column=None, **kwargs):
"""If column and kwargs are not given, a dict describing all columns
for which a width has been set is returned.
If column is given, the width of that column is returnd.
If kwargs is given, then it sets the key/value pairs, where key is a
column and value represents the width for the column."""
if column is None and not kwargs:
pairs = self.tk.splitlist(self.tk.call(self._w, 'width'))
return dict(pair.split() for pair in pairs)
elif column is not None:
return int(self.tk.call(self._w, 'width', str(column)))
args = Tkinter._flatten(kwargs.items())
self.tk.call(self._w, 'width', *args)
def window_cget(self, index, option):
return self.tk.call(self._w, 'window', 'cget', index, option)
def window_configure(self, index, option=None, **kwargs):
"""Query or modify options associated with the embedded window given
by index. This should also be used to add a new embedded window into
the table.
If no option is specified, a dict describing all of the available
options for index is returned. If option is specified, then the
command returns a list describing the one named option. Lastly, if
kwargs is given then it corresponds to option-value pairs that should
be modified."""
if option is None and not kwargs:
return self.tk.call(self._w, 'window', 'configure', index)
elif option:
return self.tk.call(self._w, 'window', 'configure', index,
'-%s' % option)
else:
args = ()
for key, val in kwargs.iteritems():
args += ('-%s' % key, val)
self.tk.call(self._w, 'window', 'configure', index, *args)
def window_delete(self, *indexes):
self.tk.call(self._w, 'window', 'delete', *indexes)
def window_move(self, index_from, index_to):
self.tk.call(self._w, 'window', 'move', index_from, index_to)
def window_names(self, pattern=None):
return self.tk.call(self._w, 'window', 'names', pattern)
def xview(self, index=None):
"""If index is not given a tuple containing two fractions is returned,
each fraction is between 0 and 1. Together they describe the
horizontal span that is visible in the window.
If index is given the view in the window is adjusted so that the
column given by index is displayed at the left edge of the window."""
res = self.tk.call(self._w, 'xview', index)
if index is None:
return self._getdoubles(res)
def xview_moveto(self, fraction):
"""Adjusts the view in the window so that fraction of the total width
of the table text is off-screen to the left. The fraction parameter
must be a fraction between 0 and 1."""
self.tk.call(self._w, 'xview', 'moveto', fraction)
def xview_scroll(self, number, what):
"""Shift the view in the window left or right according to number and
what. The 'number' parameter must be an integer. The 'what' parameter
must be either units or pages or an abbreviation of one of these.
If 'what' is units, the view adjusts left or right by number cells on
the display; if it is pages then the view adjusts by number screenfuls.
If 'number' is negative then cells farther to the left become visible;
if it is positive then cells farther to the right become visible. """
self.tk.call(self._w, 'xview', 'scroll', number, what)
def yview(self, index=None):
"""If index is not given a tuple containing two fractions is returned,
each fraction is between 0 and 1. The first element gives the position
of the table element at the top of the window, relative to the table
as a whole. The second element gives the position of the table element
just after the last one in the window, relative to the table as a
whole.
If index is given the view in the window is adjusted so that the
row given by index is displayed at the top of the window."""
res = self.tk.call(self._w, 'yview', index)
if index is None:
return self._getdoubles(res)
def yview_moveto(self, fraction):
"""Adjusts the view in the window so that the element given by
fraction appears at the top of the window. The fraction parameter
must be a fraction between 0 and 1."""
self.tk.call(self._w, 'yview', 'moveto', fraction)
def yview_scroll(self, number, what):
"""Adjust the view in the window up or down according to number and
what. The 'number' parameter must be an integer. The 'what' parameter
must be either units or pages or an abbreviation of one of these.
If 'what' is units, the view adjusts up or down by number cells; if it
is pages then the view adjusts by number screenfuls.
If 'number' is negative then earlier elements become visible; if it
is positive then later elements become visible. """
self.tk.call(self._w, 'yview', 'scroll', number, what)
# Sample test taken from tktable cvs, original tktable python wrapper
def sample_test():
from Tkinter import Tk, Label, Button
def test_cmd(event):
if event.i == 0:
return '%i, %i' % (event.r, event.c)
else:
return 'set'
def browsecmd(event):
print "event:", event.__dict__
print "curselection:", test.curselection()
print "active cell index:", test.index('active')
print "active:", test.index('active', 'row')
print "anchor:", test.index('anchor', 'row')
root = Tk()
var = ArrayVar(root)
for y in range(-1, 4):
for x in range(-1, 5):
index = "%i,%i" % (y, x)
var[index] = index
label = Label(root, text="Proof-of-existence test for Tktable")
label.pack(side = 'top', fill = 'x')
quit = Button(root, text="QUIT", command=root.destroy)
quit.pack(side = 'bottom', fill = 'x')
test = Table(root,
rows=10,
cols=5,
state='disabled',
width=6,
height=6,
titlerows=1,
titlecols=1,
roworigin=-1,
colorigin=-1,
selectmode='browse',
selecttype='row',
rowstretch='unset',
colstretch='last',
browsecmd=browsecmd,
flashmode='on',
variable=var,
usecommand=0,
command=test_cmd)
test.pack(expand=1, fill='both')
test.tag_configure('sel', background = 'yellow')
test.tag_configure('active', background = 'blue')
test.tag_configure('title', anchor='w', bg='red', relief='sunken')
root.mainloop()
if __name__ == '__main__':
sample_test() |
Partager