tk2ico {tcltk2}

Manipulate icons under Windows

Description

These function are only useful for Windows, but they can be used without error on other platform for making platform-independent code that has an additional behaviour under Windows. On the other platforms, these function just return NULL silently.

Usage

tk2ico.create(iconfile, res = 0, size = 16)
tk2ico.destroy(icon)
tk2ico.list(file = "shell32.dll")
tk2ico.sizes(file = "shell32.dll", res = "application")
tk2ico.load(file = "shell32.dll", res = "application", size = 16)
tk2ico.set(win, icon, pos = NULL, type = c("all", "small", "big"))
tk2ico.setFromFile(win, iconfile)

## Deprecated functions since drop of winico.dll support
tk2ico.hicon(icon)
tk2ico.info(icon, convert = TRUE)
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

iconfile

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

file

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

res

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

size

the size of the icon to use. For windows icons, 16 should be fine usually

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!

icon

an icon object.

convert

do we convert the result into a data.frame?

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 searched in the icon resource.

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

These function do nothing and return NULL on other platforms than Windows.

Author(s)

Philippe Grosjean