TIP #262: Background Images for Frames

TIP:	262
Title:	Background Images for Frames
Version:	$Revision: 1.5 $
Authors:	Eric Taylor <et2 at rocketship1 dot com> Donal K. Fellows <donal dot k dot fellows at manchester dot ac dot uk>
State:	Draft
Type:	Project
Tcl-Version:	8.7
Vote:	Pending
Created:	Saturday, 18 March 2006
Keywords:	Tk, option

Please enter your e-mail address (required), your name (optional), make your edits to this TIP and its Abstract, and Submit them. See TIP 3 for a description of the TIP format.

You are advised to copy the text of the TIP into an editor, make your edits there, and then paste back.

E-mail:
Name:

Abstract:	This TIP proposes an option for frames that allows users to set the background of the window to be an image.
Body:	~ Rationale Just a there is an '''-image''' option for '''button''' widgets, this TIP suggests that a '''-backgroundimage''' option for frames be implemented. The image should be either an entire single image, or a smaller image that would be tiled, with a '''-tile''' option. Tiling would repeat, as needed, a smaller image to fit the visible area of the frame. If the image was tiled, then it should be re-tiled as needed during a resize. The image would reside behind any other decoration or other widgets that resided in the frame. The image should be re-configurable to replace the image and/or remove it, as with a button image. This TIP should allow some rather classy looking tcl/tk programs to be created with much ease. ~ Proposed Change Two new options are proposed for '''frame''' widgets, to be manipulated using the normal '''configure''' and '''cget''' methods: * '''-backgroundimage''' ''imageName'' - This gives the name of an image (as created by '''image create''') that is to be painted onto the widget immediately after the painting of the solid background colour. If ''imageName'' is the empty string (the default) no image will be painted. The painting of the image will be controlled by the '''-tile''' option. * '''-tile''' ''boolean'' - If this option gives ''boolean'' as true, the image will be painted such that the top-left corner corresponds to the top-left corner of the frame, and then subsequently repeatedly painted (with no gaps between the areas painted) to the right and below that initial painting until such time as the entire widget is covered by copies of the image. If this option gives ''boolean'' as false, the image will only be painted once, such that the center of the image painted is coincident with the center of the frame widget. ~ Copyright This document has been placed in the public domain.
Log:	This is a supplement to the main log message to allow you to add extra notes if you wish.

Note that when you submit this form, the server will attempt to store your personal details (i.e. name and email address) as cookies in your browser so that next time you edit a TIP, you do not need to retype this info. We do not retain the information on our server (other than as logged in the TIP itself and in the CVS log) and you can delete it without ill-effect if you wish. You are invited to study the implementation code if you wish to understand exactly how the information is stored in your browser.

TIP AutoGenerator - written by Donal K. Fellows