GraphicCheckBox 1.0

 

Category / Domain:

Interface

SCOL Voy@ger Compatibility :

V 3.5 or above

Update:

05/2001

Function

The GraphicCheckBox module is a double status button on the customer interface.  It can be personalized with a bitmap.

The bitmap contains various button statuses vertically and horizontally.

 

The 5 statuses from bottom to top are:

§         Horizontally: (double status button)

-          Unchecked

-          Checked

§         Vertically:

-          Activated: mouse outside

-          Activated: mouse outside

-          Activated: clicked

-          Deactivated: optional; check box in editor must be checked if included in bitmap.

-          Hide (areas that will not react to mouse are in black; those that do react are in white)

This button is used to trigger an action in the 3D scene or in the interface.

Configuration

 

Figure 1:  GraphicCheckBox Module Interface

 



Image file

Indicates location path of bitmap used for button.  Click on … to select a file that must be located in the SCOL partition

 

First state button text

Indicates text visible on button:

-          Font size:         Specifies font size used for button text.  Value is expressed in points.

-          Font color:        Specifies font color of text in button.  The hexadecimal code of desired color can be entered or click on button for color palette to select a color or enter RGB or HSV codes.

-          Font type:         Specifies font style (regular, bold, italics, underlined or strikethrough).

 

ƒ

Second state button text

Indicates text visible on button.

-          Font size:         Specifies font size used for button text.  Value is expressed in points

-          Font color:        Specifies font color of text in button.  The hexadecimal code of desired color can be entered or click on button for color palette to select a color or enter RGB or HSV codes.

-          Font type:         Specifies font style (regular, bold, italics, underlined or strikethrough).

-           

Tooltip text

Shows text visible in info-balloon.

-          Font size:         Specifies font size used for button text.  Value is expressed in points.

-          Font color:        Specifies font color of text in button.  The hexadecimal code of desired color can be entered or click on button for color palette to select a color or enter RGB or HSV codes.

-          Font type:         Specifies font style (regular, bold, italics, underlined or strikethrough).

-          Background color:         Color used for info-balloon text background in a hexadecimal code

-           

Bitmap with a disabled state

If image has a “deactivated” status form, the box must be checked.

Types of files supported for bitmap are:

§         JPEG: *.jpg or *.jpeg

§         PNG: *.png

§         Bitmap: *.bmp

Bitmap can have any size, but its cutout form must be the same as the button form.

If no image is provided or file name is not valid, a default image is used. 

It is possible to define various texts for checked or unchecked status.

On creation, button is visible and “activated” and in unchecked status.

 

Implementation

 

Action

Function

shell.startą GraphicCheckBox.start

Starts module and displays button in customer graphic interface.

 

module.eventą GraphicCheckBox.destroy

 

Stops GraphicCheckBox module at customer site.

 

module.event ą GraphicCheckBox.show

Displays button on customer.

 

module.event ą GraphicCheckBox.hide

Hides button on customer interface.

 

module.event ą GraphicCheckBox.enable

Activates button.

 

module.event ą GraphicCheckBox.disable

Deactivates button.

 

module.event ą GraphicCheckBox.check

Allows button “check” control from another module.  This is possible even if checkbox is “deactivated”.

 

module.event ą GraphicCheckBox.uncheck

Allows button “uncheck” control from another module.  This is possible even if checkbox is “deactivated”.

 

 

Event

Function

GraphicCheckBox.in ą module.action

Customer part on button is initiated and ready to receive events.

 

GraphicCheckBox.out ą module.action

Exit from module triggers an action.

 

GraphicCheckBox.enteringą module.action

The customer part of module will be started and this triggers an action.

 

GraphicCheckBox.shown ą module.action

Button display triggers an action.

GraphicCheckBox.hidden ą module.action

Button hidden on customer triggers an action.

GraphicCheckBox.enabled ą module.action

Bitmap activated on button triggers an action.

GraphicCheckBox.disable ą module.action

Bitmap deactivated on button triggers an action.

GraphicCheckBox.check ą module.action

Change of button status triggers an action.

GraphicCheckBox.uncheck ą module.action

Change of button status triggers an action.

 

 

Area

Function

Interface

Assignment

button

Displays button.

Customer

Yes