How to Work with Screens > Adding Display Controls to a Screen

Control Purpose

This control is used to represent a key on the device's keyboard that is defined at screen level (as a "Hotkey" action). It can be displayed with text or images.

If the project includes speech attributes, it will also be possible to associate a speech related command to the SoftKey control ("Volume Up>"; "TTS Slower>"; "Audio Calibration>"; etc.).

Ex: If a SoftKey is associated to a "Volume Down" command, it means that the operator can press that SoftKey to lower the volume of the application's speech prompts.

The SoftKey control can also be used to launch a virtual keyboard, if you associate the control to the "<Open SIP>" function (the operator presses the SoftKey to open a SIP keyboard and presses it again to close it).

You can drag a SoftKey control from the top section of the "Control" tab OR the Style Preview section onto the screen.

Step-by-step

1. Drag the control onto the screen:

•If dragged from the "Control" tab, the control will assume the default style. (See Set Default.)

•If dragged from the Style Preview section, it will assume that particular style.

2. Now, double-click the selected control on the screen OR the tree view to open the properties window.

3. In the "General" tab, add text and/or an image to the SoftKey control which is displayed on the device's screen.

Browsing for a project resource:

a. In the "Image" box, click to open a window with tabs that contain image resources ("Theme", "Designer Resources", "Project Resources", "My Pictures" and a tab representing the folder you previously used as a source for an image import. In the case of the image below, it is the "C:\...\Pictures\" tab).

This window allows you to control the displayed images:

•Click and select the most appropriate view ("Large Icons", "Medium Icons" and "Small Icons").

•Use to filter the image display according to the defined resolution.

Right-clicking an existing image resource, opens a menu with several options. The available options vary according to the resource's location (the tab that includes the selected image).

Below are all the possible options:

	Add Resource	Opens an OS browse window. Browse for an image, select it and import it into the tab that is currently open.
	Edit Resource	Opens your default image editor. Edit the selected image.
	Transform	Allows you to rotate (90o, 180o or 270o) or flip (horizontally or vertically) the selected image file.
	Duplicate Resource	Duplicates the selected image. The duplicate has the same name as the original resource plus an incremented number.
	Rename Resource	Sets the image's name into "edit" mode. Enter the new name and click "<Enter>" in your PC keyboard.
	Delete Resource	Deletes the selected image. Click in the resulting delete confirmation window.

b. Open the tab that contains the image you want to use.

c. Select the image.

To avoid image display issues, make sure that the dimension of the selected image resource and the target area of the SoftKey control are the same.

d. Click to apply and return to the "General" tab.

Importing an Image

Instead of selecting an image from the available tabs, you can import the required image from an outside source:

a. Click (located on the lower left). This opens an OS browse window.

b. Browse for the required image and select it.

c. Click to import the image.

No matter which tab you had open when you clicked , the imported image is placed in the "Project Resources" tab.

d. In the "Project Resources" tab, select the image you have imported.

e. Click to apply and return to the "General" tab.

Instead of selecting an image, you can enter a relative path to refer the image file(s) you want to add to the SoftKey control. See Working with Aliases.

Using Drag-and-Drop

Drag the intended image from an OS browse window and drop-it in the "Image" field.

4. There is an advanced option regarding the image element that allows you to rotate or flip the selected image:

If required, right-click the "Image" option to access the "Advanced Image Settings" option and follow the steps described in The Display of a Control's Image Element.

5. Check the desired position of the image inside the SoftKey control (either "Top", "Bottom", "Left" or "Right"). These options only become active after an image is selected.

6. Select the key on the device's keyboard that will have the same function as the SoftKey control.

Select it from the drop-down in the "Key" box.

If the current project is a speech project, there will be speech commands available as well:

Speech Function you can associate to the SoftKey

SoftKey's expected behavior when pressed

<Pause>

Pauses the speech application flow.

Resumes the speech application's flow.

Turns up the volume of the speech application's prompts.

Turns down the volume of the speech application's prompts.

Increases the speed of the speech application's prompts.

Decreases the speed of the speech application's prompts.

Triggers a calibration to be performed by the operator. See Calibration.

Triggers a repetition of the prompt last heard by the operator.

Displays a window with the speech parameters of the logged in operator's speech profile (which can be edited) and other speech related options:

	The buttons OR corresponding slider change the volume of the prompts being heard by the operator.
	The buttons OR corresponding slider are used to slow down/speed up the prompts.
	The buttons OR corresponding slider lower/increase the pitch of the prompts heard by the operator.
	This button triggers a calibration. See Calibration.
	This option allows the operator to test/train his speech input to achieve an acceptable recognition level - the operator says a series of 3 to 5 digits and receives a rating (1 to 4 stars) concerning the recognition level of his speech input.
	This button provides info on the installed Voice SW, the used headset and ASR/TTS languages.

There is also a speech input energy meter to show the energy level of the operator's speech input.

See Speech Setup Window for more details.

Decreases the pitch of the speech application's prompts.

Increases the pitch of the speech application's prompts.

Alternates between the speech's "Pause" and "Resume".

The objective/function of this SoftKey will be attributed at screen level (in the "Actions" tab of the "Screen Properties" window in the form of a "Hotkey" action. This action will contain an action to mirror the function of the key selected on the "Key" box of the above mentioned "General" tab).

7. Go to the "Layout" tab.

8. Define the control's style by selecting an option in the drop-down OR by clicking . See Editing and Creating Styles and Editing and Creating the SoftKey Style.

9. Position the text, within the control, with the alignment buttons.

10. Use the button to define if the text is meant to be displayed in a single or in multiple lines. Click the button to the intended state:

If selected ( ), the control's text can be displayed within multiple lines.

If deselect ( ), the text will ONLY be displayed within a single line.

11. Maintain the given values or specify the control's position/size, within the screen, by providing the "X" and "Y" coordinates as well as "Width" and "Height".

Detail of Position/Size values

12. In the "Control Settings" section, attribute a name to the control. This name is displayed in the tree view.

13. Consider whether or not to check the following options:

"Enable"

Activates the control's features.

"Visible"

Controls the visibility of the control on the device's screen.

"Auto Refresh"

Enables an automatic update of the visible information every time the used variable's value is modified.

Before concluding the addition operation, check the following:

Remember that the "Enable" option (located in the "Layout" tab) must be checked so that the added processes run.

Use the right-click in MCL-Designer's input boxes to access some related options as well as the general "Cut"; "Copy"; "Paste"; "Search"actions (active/inactive according to the current context).

Ex: If you right-click the "Text Data" input box (included in a Display Text properties window), you are provided with the general editing/search actions and other specific options such as "Variable Select" (see "Variable Select") ;"Variable Insert" (see "Variable Insert"), "Insert Special Character" (see To Insert Special Characters into a Control's Text Input Field) and "Localization Select" (see Localization List).

If you right-click any other input box, it may provide other possibilities.

14. If required, use the icons located on the upper right corner of the properties window:

Click this icon to open a "Localization" window where you can edit the text element within that control or add translations to it. See Localization.

Click this icon to attach any relevant notes to this control. Enter your text in the resulting window.The entered information is displayed in the "Developer report". See Report.

15. Click to apply the choices made in both tabs.

The SoftKey control has been successfully added to the screen.

To activate an instant edit mode for the Softkey's text, select it and press the "<space>" key. When you are done editing the control's text element, press "<Enter>" or click outside the control's area to set it back to view mode.

If any subsequent edition of the control's properties is required, double-click the SoftKey OR select "Edit" (in its right-click menu) to open the properties window.

If you want to view this control applied within an application, see Sample Applications.