AuboCaps  0.5.0
arcs::aubo_scope::KeyboardInputFactory Class Reference

#include <keyboard_input_factory.h>

Public Member Functions

 KeyboardInputFactory (KeyboardInputFactory &f)
 
 KeyboardInputFactory (KeyboardInputFactory &&f)
 
virtual ~KeyboardInputFactory ()
 
KeyboardTextInputPtr createStandardKeyboardInput ()
 
KeyboardTextInputPtr createStringKeyboardInput ()
 
KeyboardExpressionInputPtr createExpressionKeyboardInput ()
 
KeyboardTextInputPtr createPasswordKeyboardInput ()
 
std::shared_ptr< KeyboardIntInputcreateIPAddressKeyboardInput ()
 Creates a virtual keyboard input accepting IPv4 addresses. More...
 
std::shared_ptr< KeyboardDoubleInputcreateDoubleKeypadInput ()
 
std::shared_ptr< KeyboardDoubleInputcreatePositiveDoubleKeypadInput ()
 
std::shared_ptr< KeyboardIntInputcreateIntegerKeypadInput ()
 
std::shared_ptr< KeyboardUIntInputcreatePositiveIntegerKeypadInput ()
 

Private Member Functions

 KeyboardInputFactory ()
 

Private Attributes

void * d_ { nullptr }
 

Friends

class DataSwitch
 

Detailed Description

Factory for creating keyboard inputs which are used to configure the virtual keyboard/keypad and to request it to be displayed for a Swing GUI component. The typical Swing component most commonly used is a javax.swing.JTextField.

NOTE: This functionality is only relevant for AuboCap nodes with a Swing-based user interface (see ProgramNodeService, InstallationNodeService and ToolbarService}).

Definition at line 27 of file keyboard_input_factory.h.

Constructor & Destructor Documentation

arcs::aubo_scope::KeyboardInputFactory::KeyboardInputFactory ( KeyboardInputFactory f)
arcs::aubo_scope::KeyboardInputFactory::KeyboardInputFactory ( KeyboardInputFactory &&  f)
virtual arcs::aubo_scope::KeyboardInputFactory::~KeyboardInputFactory ( )
virtual
arcs::aubo_scope::KeyboardInputFactory::KeyboardInputFactory ( )
private

Member Function Documentation

std::shared_ptr<KeyboardDoubleInput> arcs::aubo_scope::KeyboardInputFactory::createDoubleKeypadInput ( )

Creates a virtual numeric keypad input accepting doubles

If no input validator is specified, all double values are accepted.

Returns
new instance of KeyboardNumberInput<Double>.
KeyboardExpressionInputPtr arcs::aubo_scope::KeyboardInputFactory::createExpressionKeyboardInput ( )

Creates a expression virtual keyboard input for expression.

If no input validator is specified, all strings are accepted.

Returns
new instance of KeyboardTextInput.
std::shared_ptr<KeyboardIntInput> arcs::aubo_scope::KeyboardInputFactory::createIntegerKeypadInput ( )

Creates a virtual numeric keypad input accepting integers. The dot ('.') button on the keypad will be disabled.

If no input validator is specified, all integer values are accepted.

Returns
new instance of KeyboardNumberInput<Integer>}.
std::shared_ptr<KeyboardIntInput> arcs::aubo_scope::KeyboardInputFactory::createIPAddressKeyboardInput ( )

Creates a virtual keyboard input accepting IPv4 addresses.

The keyboards accepts any IPv4 address (ensuring the correct format) and returns it as a string.

Returns
new instance of KeyboardTextInput.
KeyboardTextInputPtr arcs::aubo_scope::KeyboardInputFactory::createPasswordKeyboardInput ( )

Creates a standard virtual keyboard input accepting password string/text input. When the end user types, asterisks are shown instead of the original characters.

If no input validator is specified, all strings are accepted.

Returns
new instance of KeyboardTextInput.
std::shared_ptr<KeyboardDoubleInput> arcs::aubo_scope::KeyboardInputFactory::createPositiveDoubleKeypadInput ( )

Creates a virtual numeric keypad input accepting positive doubles. The minus ('-') button on the keypad will be disabled.

If no input validator is specified, all positive double values are accepted.

Returns
new instance of KeyboardNumberInput<Double>.
std::shared_ptr<KeyboardUIntInput> arcs::aubo_scope::KeyboardInputFactory::createPositiveIntegerKeypadInput ( )

Creates a virtual numeric keypad input accepting positive integers. The minus ('-') and the dot ('.') buttons on the keypad will be disabled.

If no input validator is specified, all positive integer values are accepted.

Returns
new instance of KeyboardNumberInput<Integer>.
KeyboardTextInputPtr arcs::aubo_scope::KeyboardInputFactory::createStandardKeyboardInput ( )

Creates a standard virtual keyboard input.

If no input validator is specified, all strings are accepted.

Returns
new instance of KeyboardTextInput.
KeyboardTextInputPtr arcs::aubo_scope::KeyboardInputFactory::createStringKeyboardInput ( )

Creates a standard virtual keyboard input for naming.

If no input validator is specified, all strings are accepted.

Returns
new instance of KeyboardTextInput.

Friends And Related Function Documentation

friend class DataSwitch
friend

Definition at line 139 of file keyboard_input_factory.h.

Member Data Documentation

void* arcs::aubo_scope::KeyboardInputFactory::d_ { nullptr }
private

Definition at line 141 of file keyboard_input_factory.h.


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