Introduction

Related Commands and Options

Items

create [21] Create new items

delete [23] Delete existing items

find[31] Search for items by various keys

isvisible [55] Return true if the specified item is visible.

itemconfigure Configure existing items

lower[60] Push an item lower in the drawing order

pick[65] Find the item under a point

popcoordframe[66] Pop a relative coordinate frame off of the stack

pushcoordframe[68] Add a new relative coordinate frame to the stack

raise[69] Bring an item higher in the drawing order

resetcoordframe[75] Reset coordinate frame stack to empty

setid[82] Change the id of an item

text[91] Modify text item

type [93] Get the type of an item

-aliases [1] (Read-only) Returns all aliases of the item

-arrow [7] Whether to draw arrow heads with this item

-arrowshape [8] The shape of drawn arrow heads

-height [26] Height of an item. Normally computed, but can be set to squash/stretch item

-html [27] The HTML item associated with an htmlanchor

-htmlanchors [28] The anchors associated with an HTML page

-image [29] Image data associated with item (allocated by image alloc)

-info [30] A place to store application-specific information with an item

-ismap [31] True if an htmlanchor is an image map

-lock [35] Locks an item so it can not be modified or deleted

-state [53] State of an item (such as visited, unvisited, etc.)

-sticky [54] Specifies if an item should stay put when the view changes

-text [56] The text of any item containing text

-timerrate [57] Frequency timerscript should fire

-timerscript [58] Script associated with an item that fires at regular intervals

-title [59] Some items only: Title of an item

-url [63] The URL associated with an item

-width [68] Width of an item. Normally computed, but can be set to squash/stretch item

-zoomaction [70] A script that gets evaluated when an item is scaled larger or smaller than a set size

Item Transformations

animate [1] Animate item options asynchronously

bbox [10] Get the bounding box of an item

coords [20] Change the coordinates of an item

getsize [44] Get the size of an item (possibly within portals)

rotate [76] Rotate an item

scale [77] Change the size of an item relatively

slide [88] Move an item relatively in (x, y)

-anchor [3] The part of the item that -position refers to

-anchorpt [4] The (x, y) portion of -position

-angle [5] Specifies absolute rotation of item

-anglectr [6] Specifies absolute rotation of item, rotating about specified point

-position [47] The absolute position of the object (x, y, scale)

-rposition [51] The relative position of the object (to groups)

-scale [52] The (scale) portion of -position

View Transformations

center [15] Change the view so as to center an item

centerbbox [16] Change the view so as to center a bounding box

getview [47] Get the current view (possibly within portals)

getzoom [48] Get the current view magnification (possibly within portals)

moveto [62] Change the view (possibly within portals)

zoom [99] Zoom the view around a specified point

-lookon [36] Specifies the pad widget this item sees

-view [65] Specifies the view this item sees

-viewscript [66] A script that gets evaluated whenever the view is changed

Tags

addtag [5] Add a tag to an item

deletetag [23] Delete a tag from an item

dtag [23] Synonym for deletetag

gettags [45] Get the tags an item has

hastag [51] Determine if an item has a particular tag

-tags [55] List of tags associated with an item

Events

bind [11] Create, modify, access, or delete event bindings

bindtags [12] Specify whether events should go to the most-specific or most-general description

focus [32] Set the focus for keyboard events

modifier [61] Manipulate user-defined modifiers

-events [20] True if item receives events, false otherwise

Groups

addgroupmember [2] Add an item to a group

getgroup [38] Get the group an item belongs to

removegroupmember [72] Remove an item from a group

-divisible [16] True if events go through a group to its members

-members [38] The list of members of a group

Layout

grid [50] Manage item layout in a grid as with the Tk grid command

layout [58] Layout items once

tree [92] Manage item layout with a dynamic graphical-fisheye view tree

Rendering

damage [22] Specify that a group of items needs to be redrawn

update [94] Force any requested render requests to occur immediately

-alwaysrender [2] True if the item must be rendered, even if the system is slow and the item is small

-border [10] Specifies border color of item

-borderwidth [11] Specifies width of border

-capstyle [12] Specifies how to draw line ends

-clipping [13] Controls if items are clipped to their bounding box when rendered

-dither [15] Render with dithering

-faderange [21] Range over which an item fades in or out

-fill [23] Specifies fill color of item

-font [24] Specifies font to use for text

-joinstyle [32] Specifies how to draw the joints within multi-point lines

-layer [33] The layer an item is on

-noisedata [42] Specifies parameters to render item with noise

-maxsize [37] The maximum size an item is rendered it (absolute or relative to window size)

-minsize [41] The minimum size an item is rendered it (absolute or relative to window size)

-pen [45] Specifies pen color of item

-penwidth [46] Specifies width of pen

-relief [49] Specifies how border should be rendered (raised, flat, sunken, ridge, groove)

-transparency [61] Transparency of an item. 0 is completely transparent, 1 is completely opaque

-visiblelayers [67] The layers that are visible within this view (just for portals and surface, item #1)

Renderscripts

border [13] Manipulate a fake 3D border for use in a render callback

color [18] Manipulate a color for use in a render callback

render [73] Configure and use renderer

renderitem [74] Render an item in a render callback

-renderscript [50] A script that gets evaluated every time an item is rendered

-bb [9] A script that gets evaluated to specify the bounding box of an item

File I/O

cache [14] Control item cache

read [71] Read a .pad file

write [98] Write a .pad file (all the items on a widget)

-file [22] File an item should be defined by

-writeformat [69] Controls whether disk-based item is written out by copy or reference

Miscellaneous

configure [19] Modify the pad widget

font [33] Manipulate fonts and the font path

html [52] Manipulate and query an html page and its anchors.

image [53] Manipulate images

info [54] Get type-specific information about an item

layer [57] Manipulates layers

random [70] Generates a random integer

setlanguage [84] Set the language to be used for future callback scripts

settoplevel [87] Set the language to be used by the top-level interpreter

sound [89] Manipulate and play sounds

windowshape [97] Modify the shape of the top-level window that a pad widget is in

-donescript [17] A script to evaluate when a background action has completed

-errorscript [19] A script to evaluate when a background action has an error

-reference [48] What item an alias references

-updatescript [62] A script to evaluate when a background action has made progress

Utilities

clock [17] Create a clock to measure elapsed milliseconds

getdate [37] Get the current date in unix format

getpads [42] Get a list of all pad widgets currently defined

line2spline [59] Generate points for a spline that approximate a line

noise [63] Generate 'perlin' noise

padxy [64] Convert a window point (x, y) to pad coordinates

spline2line [90] Generate points for a line that approximate a spline

urlfetch [95] Retrieve a URL over the internet in the background

warp [96] Warp (move) the core pointer

Widgets

-command [14] Callback for widgets

-editable [18] True if text item is editable

-from [25] Starting value of valuator widget

-linesize [34] Amount widget should change to represent a line change

-memberlabels [39] List of labels for a pull-down or pop-up menu

-menubar [40] Menubar associated with a frame

-orientation [43] Orientation of widget (horizontal or vertical.)

-pagesize [44] Amount widget should change to represent a page change

-to [60] Ending value of valuator widget

-value [64] Current value of valuator widget

Debugging

printtree [67] Print all the items on the pad surface in their internal tree structure

Extensions

addoption [4] Create a new option for an existing type

addtype [6] Create a new item type

Item Types

Items
Item Transformations
View Transformations
Tags
Events
Groups
Layout
Rendering
Renderscripts
File I/O
Miscellaneous
Utilities
Widgets
Debugging
Extensions
Item Types

Pad++ Reference Manual - 20 JUN 1997

Copyright Computer Science Department, The University of New Mexico

Web Accessibility