home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 December / PCWorld_2000-12_cd.bin / Komunikace / Comanche / comanche.exe / lib / iwidgets3.0.0 / scripts / scrolledtext.itk < prev    next >
Text File  |  1999-02-24  |  17KB  |  483 lines
  1. #
  2. # Scrolledtext
  3. # ----------------------------------------------------------------------
  4. # Implements a scrolled text widget with additional options to manage
  5. # the vertical scrollbar.  This includes options to control the method
  6. # in which the scrollbar is displayed, i.e. statically or  dynamically.
  7. # Options also exist for adding a label to the scrolled text area and
  8. # controlling its position.  Import/export of methods are provided for 
  9. # file I/O.
  10. #
  11. # ----------------------------------------------------------------------
  12. #  AUTHOR: Mark L. Ulferts              EMAIL: mulferts@austin.dsccc.com
  13. #
  14. #  @(#) $Id: scrolledtext.itk,v 1.1 1998/07/27 18:53:16 stanton Exp $
  15. # ----------------------------------------------------------------------
  16. #            Copyright (c) 1995 DSC Technologies Corporation
  17. # ======================================================================
  18. # Permission to use, copy, modify, distribute and license this software 
  19. # and its documentation for any purpose, and without fee or written 
  20. # agreement with DSC, is hereby granted, provided that the above copyright 
  21. # notice appears in all copies and that both the copyright notice and 
  22. # warranty disclaimer below appear in supporting documentation, and that 
  23. # the names of DSC Technologies Corporation or DSC Communications 
  24. # Corporation not be used in advertising or publicity pertaining to the 
  25. # software without specific, written prior permission.
  26. # 
  27. # DSC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 
  28. # ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, AND NON-
  29. # INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND THE
  30. # AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE MAINTENANCE, 
  31. # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. IN NO EVENT SHALL 
  32. # DSC BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR 
  33. # ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 
  34. # WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTUOUS ACTION,
  35. # ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 
  36. # SOFTWARE.
  37. # ======================================================================
  38.  
  39. #
  40. # Usual options.
  41. #
  42. itk::usual Scrolledtext {
  43.     keep -activebackground -activerelief -background -borderwidth -cursor \
  44.      -elementborderwidth -foreground -highlightcolor -highlightthickness \
  45.      -insertbackground -insertborderwidth -insertofftime -insertontime \
  46.      -insertwidth -jump -labelfont -selectbackground -selectborderwidth \
  47.      -selectforeground -textbackground -textfont -troughcolor 
  48. }
  49.  
  50. # ------------------------------------------------------------------
  51. #                           SCROLLEDTEXT
  52. # ------------------------------------------------------------------
  53. class iwidgets::Scrolledtext {
  54.     inherit iwidgets::Scrolledwidget
  55.  
  56.     constructor {args} {}
  57.     destructor {}
  58.  
  59.     itk_option define -width width Width 0
  60.     itk_option define -height height Height 0
  61.     itk_option define -visibleitems visibleItems VisibleItems 80x24
  62.  
  63.     public method bbox {index} 
  64.     public method childsite {} 
  65.     public method clear {} 
  66.     public method import {filename {index end}} 
  67.     public method export {filename} 
  68.     public method compare {index1 op index2} 
  69.     public method debug {args} 
  70.     public method delete {first {last {}}} 
  71.     public method dlineinfo {index} 
  72.     public method get {index1 {index2 {}}} 
  73.     public method index {index} 
  74.     public method insert {args} 
  75.     public method mark {option args} 
  76.     public method scan {option args} 
  77.     public method search {args} 
  78.     public method see {index} 
  79.     public method tag {option args} 
  80.     public method window {option args} 
  81.     public method xview {args} 
  82.     public method yview {args} 
  83. }
  84.  
  85. #
  86. # Provide a lowercased access method for the Scrolledtext class.
  87. # 
  88. proc ::iwidgets::scrolledtext {pathName args} {
  89.     uplevel ::iwidgets::Scrolledtext $pathName $args
  90. }
  91.  
  92. #
  93. # Use option database to override default resources of base classes.
  94. #
  95. option add *Scrolledtext.labelPos n widgetDefault
  96.  
  97. # ------------------------------------------------------------------
  98. #                        CONSTRUCTOR
  99. # ------------------------------------------------------------------
  100. body iwidgets::Scrolledtext::constructor {args} {
  101.     #
  102.     # Our -width and -height options are slightly different than
  103.     # those implemented by our base class, so we're going to
  104.     # remove them and redefine our own.
  105.     #
  106.     itk_option remove iwidgets::Scrolledwidget::width
  107.     itk_option remove iwidgets::Scrolledwidget::height
  108.  
  109.     #
  110.     # Create a clipping frame which will provide the border for
  111.     # relief display.
  112.     #
  113.     itk_component add clipper {
  114.     frame $itk_interior.clipper
  115.     } {
  116.     usual
  117.  
  118.     keep -borderwidth -relief -highlightthickness -highlightcolor
  119.     rename -highlightbackground -background background Background
  120.     }    
  121.     grid $itk_component(clipper) -row 0 -column 0 -sticky nsew
  122.     grid rowconfigure $_interior 0 -weight 1
  123.     grid columnconfigure $_interior 0 -weight 1
  124.  
  125.     # 
  126.     # Create the text area.
  127.     #
  128.     itk_component add text {
  129.     text $itk_component(clipper).text \
  130.         -width 1 -height 1 \
  131.             -xscrollcommand \
  132.         [code $this _scrollWidget $itk_interior.horizsb] \
  133.         -yscrollcommand \
  134.         [code $this _scrollWidget $itk_interior.vertsb] \
  135.             -borderwidth 0 -highlightthickness 0
  136.     } {
  137.     usual
  138.  
  139.     ignore -highlightthickness -highlightcolor -borderwidth
  140.  
  141.     keep -exportselection -padx -pady -setgrid \
  142.          -spacing1 -spacing2 -spacing3 -state -wrap
  143.  
  144.     rename -font -textfont textFont Font
  145.     rename -background -textbackground textBackground Background
  146.     }
  147.     grid $itk_component(text) -row 0 -column 0 -sticky nsew
  148.     grid rowconfigure $itk_component(clipper) 0 -weight 1
  149.     grid columnconfigure $itk_component(clipper) 0 -weight 1
  150.     
  151.     # 
  152.     # Configure the command on the vertical scroll bar in the base class.
  153.     #
  154.     $itk_component(vertsb) configure \
  155.     -command [code $itk_component(text) yview]
  156.  
  157.     #
  158.     # Configure the command on the horizontal scroll bar in the base class.
  159.     #
  160.     $itk_component(horizsb) configure \
  161.         -command [code $itk_component(text) xview]
  162.     
  163.     #
  164.     # Initialize the widget based on the command line options.
  165.     #
  166.     eval itk_initialize $args
  167. }
  168.  
  169. # ------------------------------------------------------------------
  170. #                           DESTURCTOR
  171. # ------------------------------------------------------------------
  172. body iwidgets::Scrolledtext::destructor {} {
  173. }
  174.  
  175. # ------------------------------------------------------------------
  176. #                             OPTIONS
  177. # ------------------------------------------------------------------
  178.  
  179. # ------------------------------------------------------------------
  180. # OPTION: -width
  181. #
  182. # Specifies the width of the scrolled text as an entire unit.
  183. # The value may be specified in any of the forms acceptable to 
  184. # Tk_GetPixels.  Any additional space needed to display the other
  185. # components such as labels, margins, and scrollbars force the text
  186. # to be compressed.  A value of zero along with the same value for 
  187. # the height causes the value given for the visibleitems option 
  188. # to be applied which administers geometry constraints in a different
  189. # manner.
  190. # ------------------------------------------------------------------
  191. configbody iwidgets::Scrolledtext::width {
  192.     if {$itk_option(-width) != 0} {
  193.     set shell [lindex [grid info $itk_component(clipper)] 1]
  194.  
  195.     #
  196.     # Due to a bug in the tk4.2 grid, we have to check the 
  197.     # propagation before setting it.  Setting it to the same
  198.     # value it already is will cause it to toggle.
  199.     #
  200.     if {[grid propagate $shell]} {
  201.         grid propagate $shell no
  202.     }
  203.     
  204.     $itk_component(text) configure -width 1
  205.     $shell configure \
  206.         -width [winfo pixels $shell $itk_option(-width)] 
  207.     } else {
  208.     configure -visibleitems $itk_option(-visibleitems)
  209.     }
  210. }
  211.  
  212. # ------------------------------------------------------------------
  213. # OPTION: -height
  214. #
  215. # Specifies the height of the scrolled text as an entire unit.
  216. # The value may be specified in any of the forms acceptable to 
  217. # Tk_GetPixels.  Any additional space needed to display the other
  218. # components such as labels, margins, and scrollbars force the text
  219. # to be compressed.  A value of zero along with the same value for 
  220. # the width causes the value given for the visibleitems option 
  221. # to be applied which administers geometry constraints in a different
  222. # manner.
  223. # ------------------------------------------------------------------
  224. configbody iwidgets::Scrolledtext::height {
  225.     if {$itk_option(-height) != 0} {
  226.     set shell [lindex [grid info $itk_component(clipper)] 1]
  227.  
  228.     #
  229.     # Due to a bug in the tk4.2 grid, we have to check the 
  230.     # propagation before setting it.  Setting it to the same
  231.     # value it already is will cause it to toggle.
  232.     #
  233.     if {[grid propagate $shell]} {
  234.         grid propagate $shell no
  235.     }
  236.     
  237.     $itk_component(text) configure -height 1
  238.     $shell configure \
  239.         -height [winfo pixels $shell $itk_option(-height)] 
  240.     } else {
  241.     configure -visibleitems $itk_option(-visibleitems)
  242.     }
  243. }
  244.  
  245. # ------------------------------------------------------------------
  246. # OPTION: -visibleitems
  247. #
  248. # Specified the widthxheight in characters and lines for the text.
  249. # This option is only administered if the width and height options
  250. # are both set to zero, otherwise they take precedence.  With the
  251. # visibleitems option engaged, geometry constraints are maintained
  252. # only on the text.  The size of the other components such as 
  253. # labels, margins, and scroll bars, are additive and independent, 
  254. # effecting the overall size of the scrolled text.  In contrast,
  255. # should the width and height options have non zero values, they
  256. # are applied to the scrolled text as a whole.  The text is 
  257. # compressed or expanded to maintain the geometry constraints.
  258. # ------------------------------------------------------------------
  259. configbody iwidgets::Scrolledtext::visibleitems {
  260.     if {[regexp {^[0-9]+x[0-9]+$} $itk_option(-visibleitems)]} {
  261.     if {($itk_option(-width) == 0) && \
  262.         ($itk_option(-height) == 0)} {
  263.         set chars [lindex [split $itk_option(-visibleitems) x] 0]
  264.         set lines [lindex [split $itk_option(-visibleitems) x] 1]
  265.         
  266.         set shell [lindex [grid info $itk_component(clipper)] 1]
  267.  
  268.         #
  269.         # Due to a bug in the tk4.2 grid, we have to check the 
  270.         # propagation before setting it.  Setting it to the same
  271.         # value it already is will cause it to toggle.
  272.         #
  273.         if {! [grid propagate $shell]} {
  274.         grid propagate $shell yes
  275.         }
  276.         
  277.         $itk_component(text) configure -width $chars -height $lines
  278.     }
  279.     
  280.     } else {
  281.     error "bad visibleitems option\
  282.         \"$itk_option(-visibleitems)\": should be\
  283.         widthxheight"
  284.     }
  285. }
  286.  
  287. # ------------------------------------------------------------------
  288. #                            METHODS
  289. # ------------------------------------------------------------------
  290.  
  291. # ------------------------------------------------------------------
  292. # METHOD: childsite
  293. #
  294. # Returns the path name of the child site widget.
  295. # ------------------------------------------------------------------
  296. body iwidgets::Scrolledtext::childsite {} {
  297.     return $itk_component(text)
  298. }
  299.  
  300. # ------------------------------------------------------------------
  301. # METHOD: bbox index
  302. #
  303. # Returns four element list describing the bounding box for the list
  304. # item at index
  305. # ------------------------------------------------------------------
  306. body iwidgets::Scrolledtext::bbox {index} {
  307.     return [$itk_component(text) bbox $index]
  308. }
  309.  
  310. # ------------------------------------------------------------------
  311. # METHOD clear 
  312. #
  313. # Clear the text area.
  314. # ------------------------------------------------------------------
  315. body iwidgets::Scrolledtext::clear {} {
  316.     $itk_component(text) delete 1.0 end
  317. }
  318.  
  319. # ------------------------------------------------------------------
  320. # METHOD import filename
  321. #
  322. # Load text from an existing file (import filename)
  323. # ------------------------------------------------------------------
  324. body iwidgets::Scrolledtext::import {filename {index end}} {
  325.     set f [open $filename r]
  326.     insert $index [read $f]
  327.     close $f
  328. }
  329.  
  330. # ------------------------------------------------------------------
  331. # METHOD export filename
  332. #
  333. # write text to a file (export filename)
  334. # ------------------------------------------------------------------
  335. body iwidgets::Scrolledtext::export {filename} {
  336.     set f [open $filename w]
  337.     
  338.     set txt [$itk_component(text) get 1.0 end]
  339.     puts $f $txt
  340.     
  341.     flush $f
  342.     close $f
  343. }
  344.  
  345. # ------------------------------------------------------------------
  346. # METHOD compare index1 op index2
  347. #
  348. # Compare indices according to relational operator.
  349. # ------------------------------------------------------------------
  350. body iwidgets::Scrolledtext::compare {index1 op index2} {
  351.     return [$itk_component(text) compare $index1 $op $index2]
  352. }
  353.  
  354. # ------------------------------------------------------------------
  355. # METHOD debug ?boolean?
  356. #
  357. # Activates consistency checks in B-tree code associated with text
  358. # widgets.
  359. # ------------------------------------------------------------------
  360. body iwidgets::Scrolledtext::debug {args} {
  361.     eval $itk_component(text) debug $args
  362. }
  363.  
  364. # ------------------------------------------------------------------
  365. # METHOD delete first ?last?
  366. #
  367. # Delete a range of characters from the text.
  368. # ------------------------------------------------------------------
  369. body iwidgets::Scrolledtext::delete {first {last {}}} {
  370.     $itk_component(text) delete $first $last
  371. }
  372.  
  373. # ------------------------------------------------------------------
  374. # METHOD dlineinfo index
  375. #
  376. # Returns a five element list describing the area occupied by the
  377. # display line containing index.
  378. # ------------------------------------------------------------------
  379. body iwidgets::Scrolledtext::dlineinfo {index} {
  380.     return [$itk_component(text) dlineinfo $index]
  381. }
  382.  
  383. # ------------------------------------------------------------------
  384. # METHOD get index1 ?index2?
  385. #
  386. # Return text from start index to end index.
  387. # ------------------------------------------------------------------
  388. body iwidgets::Scrolledtext::get {index1 {index2 {}}} {
  389.     return [$itk_component(text) get $index1 $index2]
  390. }
  391.  
  392. # ------------------------------------------------------------------
  393. # METHOD index index
  394. #
  395. # Return position corresponding to index.
  396. # ------------------------------------------------------------------
  397. body iwidgets::Scrolledtext::index {index} {
  398.     return [$itk_component(text) index $index]
  399. }
  400.  
  401. # ------------------------------------------------------------------
  402. # METHOD insert index chars ?tagList?
  403. #
  404. # Insert text at index.
  405. # ------------------------------------------------------------------
  406. body iwidgets::Scrolledtext::insert {args} {
  407.     eval $itk_component(text) insert $args
  408. }
  409.  
  410. # ------------------------------------------------------------------
  411. # METHOD mark option ?arg arg ...?
  412. #
  413. # Manipulate marks dependent on options.
  414. # ------------------------------------------------------------------
  415. body iwidgets::Scrolledtext::mark {option args} {
  416.     return [eval $itk_component(text) mark $option $args]
  417. }
  418.  
  419. # ------------------------------------------------------------------
  420. # METHOD scan option args
  421. #
  422. # Implements scanning on texts.
  423. # ------------------------------------------------------------------
  424. body iwidgets::Scrolledtext::scan {option args} {
  425.     eval $itk_component(text) scan $option $args
  426. }
  427.  
  428. # ------------------------------------------------------------------
  429. # METHOD search ?switches? pattern index ?varName?
  430. #
  431. # Searches the text for characters matching a pattern.
  432. # ------------------------------------------------------------------
  433. body iwidgets::Scrolledtext::search {args} {
  434.     return [eval $itk_component(text) search $args]
  435. }
  436.  
  437. # ------------------------------------------------------------------
  438. # METHOD see index
  439. #
  440. # Adjusts the view in the window so the character at index is 
  441. # visible.
  442. # ------------------------------------------------------------------
  443. body iwidgets::Scrolledtext::see {index} {
  444.     $itk_component(text) see $index
  445. }
  446.  
  447. # ------------------------------------------------------------------
  448. # METHOD tag option ?arg arg ...?
  449. #
  450. # Manipulate tags dependent on options.
  451. # ------------------------------------------------------------------
  452. body iwidgets::Scrolledtext::tag {option args} {
  453.     return [eval $itk_component(text) tag $option $args]
  454. }
  455.  
  456. # ------------------------------------------------------------------
  457. # METHOD window option ?arg arg ...?
  458. #
  459. # Manipulate embedded windows.
  460. # ------------------------------------------------------------------
  461. body iwidgets::Scrolledtext::window {option args} {
  462.     return [eval $itk_component(text) window $option $args]
  463. }
  464.  
  465. # ------------------------------------------------------------------
  466. # METHOD xview
  467. #
  468. # Changes x view in widget's window.
  469. # ------------------------------------------------------------------
  470. body iwidgets::Scrolledtext::xview {args} {
  471.     return [eval $itk_component(text) xview $args]
  472. }
  473.  
  474. # ------------------------------------------------------------------
  475. # METHOD yview
  476. #
  477. # Changes y view in widget's window.
  478. # ------------------------------------------------------------------
  479. body iwidgets::Scrolledtext::yview {args} {
  480.     return [eval $itk_component(text) yview $args]
  481. }
  482.  
  483.