tcltk2 (version 1.1-4)

tk2ico: Manipulate icons under Windows

Description

Create, load and work with Windows icons. Change icons fo Windows, use icons in the taskbar under Windows 9X/2000/XP, ... These function are only useful for Windows, but they silently return NULL on other platforms for writing compatible code (Windows icons instructions can be simply ignored).

Usage

tk2ico.load(file = "shell32.dll", res = "application")
tk2ico.create(iconfile)
tk2ico.destroy(icon)
tk2ico.hicon(icon)
tk2ico.info(icon, convert = TRUE)
tk2ico.set(win, icon, pos = NULL, type = c("all", "small", "big"))
tk2ico.text(icon)
tk2ico.text(icon) <- value
tk2ico.pos(icon) <- value
tk2ico.taskbar.add(icon, pos = 0, text = tk2ico.text(icon),
    leftmenu = NULL, rightmenu = NULL)
tk2ico.taskbar.delete(icon)
tk2ico.taskbar.modify(icon, pos = NULL, text = NULL)

Arguments

file

A file having icon resources (.exe, or .dll)

res

The name of the resource from where the icon should be extracted

iconfile

A file with a .ico extension, containing one or more Windows icons

icon

An icon object

convert

Do we convert the result into a data.frame?

win

A tk window, or an integer representing the handle (HWND) of a foreign window whose icon will be changed (take care, the function returns TRUE even if the handle is wrong!

pos

A position (starting from 0) pointing to an icon in a multi-icon object. Note that pos is not used in tk2ico.set() if type = "all" (in this case, best icons matching both "small" and "large" sizes are search

type

Do we change only the small, the large, or both icons?

value

A string with the new text for the icon in tk2ico.text() or a numerical value indicating the new default position in the icon resource for tk2ico.pos()

text

Change a text for an icon

leftmenu

A "tkwin" object to display when the user left-clicks on the taskbar icon (usually, a Tk popup menu), or NULL for nothing

rightmenu

Idem as 'lefmenu' but for a right-click on the taskbar icon

Value

• An icon object, which is a reference to an image resource in Tcl. Its classes are c("tclObj", "tclIcon"). Do not forget to destroy it using tk2ico.destroy() when you do not need it any more! If tk2ico.load(), tk2ico.info() fail, they return NULL instead on a Tcl object.

See Also

tk2dde, tk2reg

Examples

## These cannot be run by examples() but should be OK when pasted
## into an interactive R session with the tcltk package loaded

## Examples of tk2ico - icon manipulation under Windows
tt2 <- tktoplevel()
# Load a system icon (there are: "application", "asterisk", "error",
# "exclamation", "hand", "question", "information", "warning", and "winlogo".
Warn <- tk2ico.load(res = "warning")
tk2ico.info(Warn)
# Change the text
tk2ico.text(Warn)
tk2ico.text(Warn) <- "Warning icon"
tk2ico.text(Warn)
# Get hicon
tk2ico.hicon(Warn)
# Change the icon of my window tt2
tk2ico.set(tt2, Warn)
# Do not forget to destroy icon to free resource when not needed any more
tk2ico.destroy(Warn)
rm(Warn)
# Load an icon from the resource section of an exe, or dll
Rico <- tk2ico.load(file.path(Sys.getenv("R_HOME"), "bin", "R.exe"), res = "R")
tk2ico.info(Rico)
tk2ico.set(tt2, Rico)
tk2ico.destroy(Rico)
rm(Rico)

# Load one or several icons from an .ico file
libdir <- file.path(.path.package(package = "tcltk2")[1], "gui")
SVico <- tk2ico.create(file.path(libdir, "SciViews.ico"))
# The various resolution icons created from this file
tk2ico.info(SVico)
# Change the default position to 1 (the second icon)
tk2ico.pos(SVico) <- 1
# Change only the small icon (use Alt-Tab to see the large one)
tk2ico.set(tt2, SVico, type = "small")
# Get the handle of the R Console window and change its icon
tk2ico.set(getWindowsHandle("Console"), SVico)

# Set a taskbar icon, with both a left and right-click menu
lmenu <- tkmenu(.TkRoot, tearoff = FALSE)
tkadd(lmenu, "command", label = "Say hello",
	command = function() cat("Hello from taskbar!\n"))
rmenu <- tkmenu(.TkRoot, tearoff = FALSE)
tkadd(rmenu, "command", label = "Say hello again",
	command = function() cat("Hello again from taskbar!\n"))
tk2ico.taskbar.add(SVico, pos = 1, text = "my R taskbar icon",
	leftmenu = lmenu, rightmenu = rmenu)
# Try left and right-click on the taskbar icon...
# Change its text...
tk2ico.taskbar.modify(SVico,  pos = 1, text = "text changed!")
#... and delete it
tk2ico.taskbar.delete(SVico)

# Destroy the icons
tk2ico.destroy(SVico)
rm(SVico)

# When done, dispose of the window and clean the workspace
tkdestroy(tt2)
rm(list = c("libdir", "lmenu", "rmenu", "tt2"))