docs.roxen.comView this page in a printer friendly mode
DocsRoxenWebServer 4.5Web Developer ManualGraphics Tags
Copyright  2012, Roxen Internet Software
Suggestions, comments & compliments
manuals@roxen.com
 DEMO  DOCS  PIKE
 COMMUNITY  DOWNLOAD
www.roxen.com



Color attributes
Internal Images
<anfang>
<atlas>
<cimg>
<cimg-url>
<colorscope>
<configimage>
<diagram>
<gbutton>
<gbutton-url>
<gh>
<gtext>
<gtext-id>
<gtext-js>
<gtext-url>
<imgs>
<tablist>

<gbutton></gbutton>

Provided by module: Graphics: GButton

Creates graphical buttons.


Attributes

pagebgcolor="color"


bgcolor="color"

Background color inside and outside button.


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

textcolor="color"

Button text color.


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

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.


alt="string"

Alternative button and alt text.


title="string"

Button tooltip.


href="uri"

Button URI.


target="string"

Button target frame.


textstyle="{normal, condensed}"

Set to normal or condensed to alter text style.


width=""

Minimum button width.


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.


img-align=""

Alignment passed on to the resulting <img>.


state="{enabled, disabled}"

Set to enabled or disabled to select button state.


icon-src="URI"

Fetch the icon from this URI.


icon-data=""

Inline icon data.


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>
Roxen 2.0

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

valign-icon="{above, middle, below}"

Set icon vertical alignment. Requires three horizontal guidelines in the frame image. If set to above the icon is placed between the first and second guidelines and the text between the second and third ones. If set to below the placement is reversed. Default value is middle.


font="fontname"


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:

AcronymAcronym interpretation

gif

Graphics Interchange Format (might be missing in your roxen)

jpeg

Joint Photography Expert Group image compression

png

Portable Networks Graphics

avs

Advanced Visual Systems Inc. image format

bmp

Windows BitMaP file

gd

Internal format used by libgd

hrz

HRZ is (was?) used for amatuer radio slow-scan TV.

ilbm

Interchangeable File Format: interleaved bitmap

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="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="{none, random, floyd-steinberg}"(none)

Choose the dithering method.

MethodMeaning

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="color"(taken from the page)

The color to render the image against.


opaque-value="percentage"(100)

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


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

Perform rgb to hsv colorspace conversion.


gamma="number"(1.0)

Perform gamma adjustment.


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

Perform rgb to greyscale colorspace conversion.


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

Invert all colors


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

Perform hsv to rgb colorspace conversion.


rotate-cw="degree"(0)

Rotate the image clock-wise.


rotate-ccw="degree"(0)

Rotate the image counter clock-wise.


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

Select the unit to use while rotating.

UnitMeaning

rad

Radians

deg

Degrees

ndeg

'New' degrees (400 for each full rotation)

part

0 - 1.0 (1.0 == full rotation)


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

Mirror the image around the X-axis.


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

Mirror the image around the Y-axis.


scale="fact"(1.0)

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


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="xsize"

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


max-height="ysize"

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


span-width="xsize"

If width is larger than 'xsize', scale width to 'xsize' while keeping aspect. If width is smaller than 'xsize', extend width to 'xsize' by filling the new space with current background color.


span-height="ysize"

If height is larger than 'ysize', scale height to 'ysize' while keeping aspect. If height is smaller than 'ysize', extend height to 'ysize' by filling the new space with current background color.


x-offset="pixels"(0)

Cut n pixels from the beginning of the X scale.


y-offset="pixels"(0)

Cut n pixels from the beginning of the Y scale.


x-size="pixels"(whole image)

Keep n pixels from the beginning of the X scale.


y-size="pixels"(whole image)

Keep n pixels from the beginning of the Y scale.


crop="{x1,y1-x2,y2, auto, guides-cross, guides-region}"

Crops the image by using several differen methods. The simplest is to only specify the area to be cropped with x,y-x,y coordinates. By instead selecting "auto" the image will be cropped so that as many pixels as possible with the same color is removed from around the image.

A more advanced cropping method can be used by giving the crop argument "guides-cross". The image will then be cropped around the intersection of two guides inside the image. Guides can be added to e.g. Photoshop and GIMP images. If several guides are present, which ones to use can be selected with the guides-index=x,y attribute, where x and y is the number of the guides. Guides cross cropping is usefull together with max-width and max-height attributes when creating thumb nails.

A combination of guides cross cropping can be used by giving the crop argument "guides-region". In this cropping mode the area enclosed by two horizontal and two vertical guides are saved. Which guides to use is given by the guides-index=x1,y1-x2,y2 attribute, where the x and y parameters are the number of the guides. Guides can also be specified as guides-index=x,y. Then the saved area will be the one enclosed by the buides x,y and x+1,y+1, counting from left and top. Again, combine max-width and max-height makes a good effect, since scaling is performed after cropping.


jpeg-quality="percentage"(75)

Set the quality on the output jpeg image.


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

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


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

Generate progressive jpeg images.


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

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


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

Force this number of bits per pixel for bmp images.


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

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


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

RLE 'compress' the BMP image.


gd-alpha_index="color"(0)

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


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

If 1, do not RLE encode the PCX image.


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

Resolution, in pixels per inch.


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

Resolution, in pixels per inch.


pcx-ydpy="0-10000000.0"(75.0)

Resolution, in pixels per inch.


pcx-xoffset="0-imagexsize-2"(0)

Offset from start of image data to image content for PCX images. Unused by most programs.


pcx-yoffset="0-imageysize-2"(0)

Offset from start of image data to image content for PCX images. Unused by most programs.


tga-raw="{1, 0}"(0)

If 1, do not RLE encode the Targa image.


ps-dpi="0-10000000.0"(75.0)

Dots per inch for the resulting postscript file.