Attributes

pagebgcolor
pagebgcolor=color

bgcolor
bgcolor=color

Background color inside and outside button.

<gbutton bgcolor='lightblue'>Background</gbutton>

textcolor
textcolor=color

Button text color

<gbutton textcolor='#ff6600'>Text</gbutton>

frame-image
frame-image=path

Use this XCF-image as a frame for the button. The image is required to have at least the following layers: background, mask and frame. More information on how to create frame images can be found in the Roxen documentation; Web Site Creator/Graphical tags section.

<gbutton frame-image='internal-roxen-tabframe'>foo</gbutton>

alt
alt=string

Alternative button and alt text.

href
href=uri

Button URI.

textstyle
textstyle={normal, condensed}

Set to normal or condensed to alter text style.

width
width=

Minimum button width.

align
align={left, center, right}

Set text alignment. There are some alignment restrictions: when text alignment is either left or right, icons must also be aligned left or right.

state
state={enabled, disabled}

Set to enabled or disabled to select button state.

icon-src
icon-src=URI

Fetch the icon from this URI.

icon-data
icon-data=

Inline icon data.

align-icon
align-icon={left, center-before, center-after, right}

Set icon alignment.

left	Place icon on the left side of the text.
center-before	Center the icon before the text.Requires the align='center' attribute.
center-after	Center the icon after the text. Requires the align='center' attribute.
right	Place icon on the right side of the text.

<gbutton width='150' align-icon='center-before' icon-src='internal-roxen-help'>Roxen 2.0</gbutton>

<gbutton width='150' align='center' align-icon='center-after' icon-src='internal-roxen-help'>Roxen 2.0</gbutton>

font
font=

extra-layers
extra-layers={[],[first, last],[selected, unselected],[background, mask, frame, left, right]}

extra-left-layers
extra-left-layers={[],[first, last],[selected, unselected],[background, mask, frame, left, right]}

extra-right-layers
extra-right-layers={[],[first, last],[selected, unselected],[background, mask, frame, left, right]}

extra-background-layers
extra-background-layers={[],[first, last],[selected, unselected],[background, mask, frame, left, right]}

extra-mask-layers
extra-mask-layers={[],[first, last],[selected, unselected],[background, mask, frame, left, right]}

extra-frame-layers
extra-frame-layers={[],[first, last],[selected, unselected],[background, mask, frame, left, right]}

<gbutton frame-image='gbutton.xcf' alt='foo'>bu</gbutton>

<gbutton alt='Edit' bgcolor='#aeaeae' extra-background-layers='unselected background,last unselected background,last background' extra-frame-layers='unselected frame,last unselected frame,last frame' extra-layers='unselected,last unselected,last' extra-left-layers='unselected left,last unselected left,last left' extra-mask-layers='unselected mask,last unselected mask,last mask' extra-right-layers='unselected right,last unselected right,last right' >Buttontext </gbutton>

format
format={gif, jpeg, png, avs, gmp, bd, hrz, ilbm, psx, pnm, ps, pvr, tga, tiff, wbf, xbm, xpm} (gif)

The format to encode the image to. The formats available are:

gif	Graphics Interchange Format (might be missing in your roxen)
jpeg	Joint Photography Expert Group image compression
png	Portable Networks Graphics
avs
bmp	Windows BitMaP file
gd
hrz	HRZ is (was?) used for amatuer radio slow-scan TV.
ilbm
pcx	Zsoft PCX file format (PC / DOS)
pnm	Portable AnyMap
ps	Adobe PostScript file
pvr	Pover VR (dreamcast image)
tga	TrueVision Targa (PC / DOS)
tiff	Tag Image File Format
wbf	WAP Bitmap File
xbm	XWindows Bitmap File
xpm	XWindows Pixmap File

quant
quant=number (format dependant)

The number of colors to quantizize the image to.

Default for gif is 32(+1 transparent), for most other formats (except black and white) is it unlimited.

dither
dither={none, random, floyd-steinberg} (none)

Choose the dithering method.

none	No dithering is performed at all.
random	Random scatter dither. Not visually pleasing, but it is useful for very high resolution printing.
floyd-steinberg	Error diffusion dithering. Usually the best dithering method.

true-alpha

If present, render a real alpha channel instead of on/off alpha. If the file format only supports on/off alpha, the alpha channel is dithered using a floyd-steinberg dither.

background-color
background-color=color (taken from the page)

The color to render the image against.

opaque-value
opaque-value=percentage (100)

The transparency value to use, 100 is fully opaque, and 0 is fully transparent.

cs-rgb-hsv
cs-rgb-hsv={0, 1} (0)

Perform rgb to hsv colorspace conversion.

gamma
gamma=number (1.0)

Perform gamma adjustment.

cs-grey
cs-grey={0, 1} (0)

Perform rgb to greyscale colorspace conversion.

cs-invert
cs-invert={0, 1} (0)

Invert all colors

cs-hsv-rgb
cs-hsv-rgb={0, 1} (0)

Perform hsv to rgb colorspace conversion.

rotate-cw
rotate-cw=degree (0)

Rotate the image clock-wise.

rotate-ccw
rotate-ccw=degree (0)

Rotate the image counter clock-wise.

rotate-unit
rotate-unit={rad, deg, ndeg, part} (deg)

Select the unit to use while rotating.

rad	Radians
deg	Degrees
ndeg	'New' degrees (400 for each full rotation)
part	0 - 1.0 (1.0 == full rotation)

mirror-x
mirror-x={0, 1} (0)

Mirror the image around the X-axis.

mirror-y
mirror-y={0, 1} (0)

Mirror the image around the Y-axis.

scale
scale=fact (1.0)

Scale fact times. (0.5 -> half size, 2.0 -> double size)

scale
scale=x,y

Scale to the exact size x,y. If either of X or Y is zero, the image is scaled to the specified width or hight, and the value that is zero is scaled in proportion to the other value.

max-width
max-width=xsize

If width is larger than 'xsize', scale width to 'xsize' while keeping aspect.

max-height
max-height=ysize

If width is larger than 'ysize', scale width to 'ysize' while keeping aspect.

x-offset
x-offset=pixels (0)

Cut n pixels from the beginning of the X scale.

y-offset
y-offset=pixels (0)

Cut n pixels from the beginning of the Y scale.

x-size
x-size=pixels (whole image)

Keep n pixels from the beginning of the X scale.

y-size
y-size=pixels (whole image)

Keep n pixels from the beginning of the Y scale.

crop
crop=x0,y0-x1,y1 (whole image)

Crop the image by specifying the pixel coordinates.

jpeg-quality
jpeg-quality=percentage (75)

Set the quality on the output jpeg image.

jpeg-optimize
jpeg-optimize={0, 1} (1)

If 0, do not generate optimal tables. Somewhat faster, but produces bigger files.

jpeg-progressive=
jpeg-progressive=={0, 1} (0)

Generate progressive jpeg images.

jpeg-smooth
jpeg-smooth=0-100 (0)

Smooth the image while compressing it. This produces smaller files, but might undo the effects of dithering.

bmp-bpp
bmp-bpp=1,4,8,24 (24)

Force this number of bits per pixel for bmp images.

bmp-windows
bmp-windows={0, 1} (1)

Windows or OS/2 mode, default is 1. (windows mode)

bmp-rle
bmp-rle={0, 1} (0)

RLE 'compress' the BMP image.

gd-alpha_index
gd-alpha_index=color (0)

Color in the colormap to make transparent for GD-images with alpha channel.

pcx-raw
pcx-raw={1, 0} (0)

If 1, do not RLE encode the PCX image.

pcx-dpy
pcx-dpy=0-10000000.0 (75.0)

Resolution, in pixels per inch.

pcx-xdpy
pcx-xdpy=0-10000000.0 (75.0)

Resolution, in pixels per inch.