Documents > BPS V2 C++ API
BpsNumericKeyboardAction Class Reference

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

#include <bpskeyboardcontrols.h>

List of all members.

Public Types

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

Public Member Functions

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

Detailed Description

A checkable action to show or hide the numeric keyboard.

A action of type BpsAlphaKeyboardAction can be linked by setAlphaAction() to get mutual exclusive virtual keyboards, e.g. if on of the buttons 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

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

Member Function Documentation

void BpsNumericKeyboardAction::setAlphaAction ( BpsAlphaKeyboardAction aAction)

Set the associated alphanumeric keyboard action.

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

Parameters:
[in]aActionThe associated alpha keyboard action.
void BpsNumericKeyboardAction::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 BpsNumericKeyboardAction::status ( ) const
Returns:
the current keyboard show status.

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