HAW_image Class Reference

List of all members.

Public Member Functions

 HAW_image ($src_wbmp, $src_html, $alt, $src_bmp="")
 set_br ($br)
 use_localsrc ($icon)
 use_chtml_icon ($icon)
 use_mml_icon ($icon)
 set_html_width ($width)
 set_html_height ($height)
 set_voice_text ($text, $audio_src="")

Detailed Description

This class allows to insert bitmap images into a HAW_deck, HAW_form or HAW_table object.

Examples:

$myImage1 = new HAW_image("my_image.wbmp", "my_image.gif", ":-)");
$myImage2 = new HAW_image("my_image.wbmp", "my_image.gif", ":-)", "my_image.bmp");
$myImage2->set_br(1);

See also:
HAW_deck

HAW_form

HAW_row


Member Function Documentation

HAW_image::HAW_image ( src_wbmp,
src_html,
alt,
src_bmp = "" 
)

Constructor

Parameters:
src_wbmp Your bitmap in WAP-conform .wbmp format.
src_html Your bitmap in .gif, .jpg or any other HTML compatible format.
alt Alternative text for your bitmap. Will be displayed if the client can display none of your graphic formats.
src_bmp (optional)
your bitmap in monochrome .bmp format. If the browser signals in the HTTP request header, that he's only able to display image/bmp and not image/vnd.wap.wbmp (e.g. the UPSim 3.2 did so), this image will be sent.

HAW_image::set_br ( br  ) 

Sets the number of line breaks (CRLF) after the image. (default: 0)

Parameters:
br Some number of line breaks.

HAW_image::use_localsrc ( icon  ) 

Use localsrc attribute on WAP/HDML devices.
Using built-in icons, mobile devices don't have to download bitmap images. If the device can not render the specified icon, it will download the according bitmap as specified in the HAW_image constructor.

Parameters:
icon Device-internal representation of the image, e.g. "heart".

HAW_image::use_chtml_icon ( icon  ) 

Use cHTML icon instead of HTML bitmap on i-mode devices.
Using built-in icons, mobile devices don't have to download bitmap images. Has no effect on non-i-mode devices.

Parameters:
icon cHTML icon code, e.g. 63889 for the "heart" icon.

HAW_image::use_mml_icon ( icon  ) 

Use MML icon instead of HTML bitmap on MML devices.
Using built-in icons, mobile devices don't have to download bitmap images. Has no effect on non-MML devices.

Parameters:
icon MML icon code, e.g. "GB" for the "heart" icon.

HAW_image::set_html_width ( width  ) 

Specifies the width of the HTML image.

Parameters:
width image width in pixels.

HAW_image::set_html_height ( height  ) 

Specifies the height of the HTML image.

Parameters:
height image height in pixels.

HAW_image::set_voice_text ( text,
audio_src = "" 
)

Sets text to be spoken by voice browsers.

Parameters:
text Some text that represents the image for voice users.
audio_src Some audio file (e.g. *.wav file) to play (optional).


The documentation for this class was generated from the following file:
Generated on Mon Dec 6 21:51:55 2010 for HAWHAW PHP by  doxygen 1.5.1