Adding a "SoftKey" Control to a Screen

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

Adding a "SoftKey" Control to a Screen

Previous pageReturn to chapter overviewNext page

 

Control Purpose

 

This control is used to represent a key on the device's keyboard that is defined at screen level (as a "Hotkey" event). 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).

 

Add a softkey to a screen by dragging 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.

 

Click Here to View Details on Adding Text

 

Click Here to View Details on Adding an Image

 

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 list 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.

<Resume>

Resumes the speech application's flow.

<Volume Up>

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

<Volume Down>

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

<TTS Faster>

Increases the speed of the speech application's prompts.

<TTS Slower>

Decreases the speed of the speech application's prompts.

<Audio Calibration>

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

<Repeat Prompt>

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

<Show User Profile>

Displays a window with speech parameters of the logged in operator's speech profile.

The operator will be able to edit these parameters:

 

The first slider concerns the volume of the prompts being heard by the operator. Moving the slider mark or pressing the corresponding buttons turns the prompts' volume up or down.

The second slider regards the speed of the prompts being heard by the operator. Moving the slider mark or pressing the corresponding buttons slows down or speeds up the prompts.

If the operator presses this button, it triggers a calibration.

See Calibration.

<TTS Pitch Lower>

Increases the pitch of the speech application's prompts.

<TTS Pitch Higher>

Decreases the pitch of the speech application's prompts.

<Toggle Pause/Resume>

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" event. This event 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 list 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. 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

 

 

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

 

12. 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 actions/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.

 

 

 

13. 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.

 

 

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

 

The "SoftKey" control has been successfully added to the screen.

 

 

 

To activate an instant Edit Text mode, select the "SoftKey" control 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.