Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ttk_image (1t)

Name

ttk_image - Define an element based on an image

Synopsis

ttk::style element create name image imageSpec ?options?

Description

ttk_image(1t)                  Tk Themed Widget                  ttk_image(1t)



______________________________________________________________________________

NAME
       ttk_image - Define an element based on an image

SYNOPSIS
       ttk::style element create name image imageSpec ?options?
______________________________________________________________________________

DESCRIPTION
       The  image  element  factory creates a new element in the current theme
       whose visual appearance is determined by Tk  images.   imageSpec  is  a
       list  of  one or more elements.  The first element is the default image
       name.  The rest of the list is a sequence of statespec  /  value  pairs
       specifying  other  images  to  use  when the element is in a particular
       state or combination of states.

OPTIONS
       Valid options are:

       -border padding
              padding is a list of up to four integers, specifying  the  left,
              top,  right,  and  bottom  borders, respectively.  If fewer than
              four elements are  specified,  bottom  defaults  to  top,  right
              defaults  to  left, and top defaults to left.  In other words, a
              list of three numbers specify the left, vertical, and right bor-
              der; a list of two numbers specify the horizontal and the verti-
              cal border; a single number specifies the same  border  all  the
              way around the element.  See IMAGE STRETCHING, below.

       -height height
              Specifies  a minimum height for the element.  If less than zero,
              the base image's height is used as a default.

       -padding padding
              Specifies the element's interior padding.  The padding is a list
              of  up  to four length specifications left top right bottom.  If
              fewer than four elements are specified, bottom defaults to  top,
              right  defaults  to  left,  and  top defaults to left.  In other
              words, a list of three numbers specify the left,  vertical,  and
              right  padding; a list of two numbers specify the horizontal and
              the vertical padding; a single number specifies the same padding
              all the way around the widget.  Defaults to -border if not spec-
              ified.

       -sticky spec
              Specifies how the image is placed within the final parcel.  spec
              contains zero or more characters "n", "s", "w", or "e".

       -width width
              Specifies  a  minimum width for the element.  If less than zero,
              the base image's width is used as a default.

IMAGE STRETCHING
       If the element's allocated parcel is larger than the image,  the  image
       will be placed in the parcel based on the -sticky option.  If the image
       needs to stretch horizontally (i.e., -sticky ew) or vertically (-sticky
       ns), subregions of the image are replicated to fill the parcel based on
       the -border option.  The -border divides the image into 9 regions: four
       fixed  corners,  top  and left edges (which may be tiled horizontally),
       left and right edges (which may be tiled vertically), and  the  central
       area (which may be tiled in both directions).

EXAMPLE
              set img1 [image create photo -file button.png]
              set img2 [image create photo -file button-pressed.png]
              set img3 [image create photo -file button-active.png]
              style element create Button.button image \
                  [list $img1  pressed $img2  active $img3] \
                  -border {2 4} -sticky we


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tk-8     |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       ttk::intro(n), ttk::style(n), ttk_vsapi(n), image(n), photo(n)

KEYWORDS
       style, theme, appearance, pixmap theme, image



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from         https://source-
       forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tk                                    8.5                        ttk_image(1t)