Documents > BPS V2 C++ API
BpsAlphaKeyboardAction Class Reference

A checkable action to show or hide the alphanumeric keyboard. More...

#include <bpskeyboardcontrols.h>

List of all members.

Public Types

enum  {
  NoKeyboardShown,
  AlphaKeyboardShown,
  NumericKeyboardShown
}
 Keyboard display status values. More...

Public Member Functions

 BpsAlphaKeyboardAction (QWidget *aWidget, QObject *aParent=0)
void setNumericAction (BpsNumericKeyboardAction *aAction)
 Set the associated numeric keyboard action.
void setStatus (int aStatus)
 Set the keyboard show status.
int status () const

Detailed Description

A checkable action to show or hide the alphanumeric keyboard.

A action of type BpsAlphaKeyboardAction can be linked by setNumericAction() to get mutual exclusive virtual keyboards, e.g. if on of the actions is checked the other gets unchecked automatically. This control mandatory requires the application to be of type BpsApplication.


Member Enumeration Documentation

anonymous enum

Keyboard display status values.

Enumerator:
NoKeyboardShown 

No keyboard is shown.

AlphaKeyboardShown 

The alphanumeric keyboard is shown.

NumericKeyboardShown 

The numeric keypad is shown.


Constructor & Destructor Documentation

BpsAlphaKeyboardAction::BpsAlphaKeyboardAction ( QWidget *  aWidget,
QObject *  aParent = 0 
)
Parameters:
[in]aWidgetThe widget to show the keyboard for.
[in]aParentThe parent object.

Member Function Documentation

void BpsAlphaKeyboardAction::setNumericAction ( BpsNumericKeyboardAction aAction)

Set the associated numeric keyboard action.

It is sufficient to set the associated button only on one of the two buttons, the back link is created automatically.

Parameters:
[in]aActionThe associated numeric keyboard action.
void BpsAlphaKeyboardAction::setStatus ( int  aStatus)

Set the keyboard show status.

Checks or unchecks the actions and hides/shows the keyboard.

Parameters:
[in]aStatusThe new status to set.
int BpsAlphaKeyboardAction::status ( ) const
Returns:
the current keyboard show status.

The documentation for this class was generated from the following file: