Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | List of all members
cinder::app::AppCocoaTouch::KeyboardOptions Struct Reference

Optional params passed to showKeyboard();. More...

#include <AppCocoaTouch.h>

Public Member Functions

 KeyboardOptions ()
 
KeyboardOptionsinitialString (const std::string &str)
 Sets the initial value of the keyboard string. Default is an empty string. More...
 
KeyboardOptionstype (KeyboardType type)
 Sets the keyboard layout type to . Default is KeyboardType::DEFAULT. More...
 
KeyboardOptionscloseOnReturn (bool enable)
 Sets whether the keyboard closes (hides) when the return key is entered. Default is true. More...
 
const std::stringgetInitialString () const
 Returns the keyboard's initial string. More...
 
KeyboardType getType () const
 Returns the keyboard layout type. More...
 
bool getCloseOnReturn () const
 Returns whether the keyboard closes (hides) when the return key is entered. More...
 

Detailed Description

Optional params passed to showKeyboard();.

Constructor & Destructor Documentation

cinder::app::AppCocoaTouch::KeyboardOptions::KeyboardOptions ( )

Member Function Documentation

KeyboardOptions& cinder::app::AppCocoaTouch::KeyboardOptions::initialString ( const std::string str)

Sets the initial value of the keyboard string. Default is an empty string.

KeyboardOptions& cinder::app::AppCocoaTouch::KeyboardOptions::type ( KeyboardType  type)

Sets the keyboard layout type to . Default is KeyboardType::DEFAULT.

KeyboardOptions& cinder::app::AppCocoaTouch::KeyboardOptions::closeOnReturn ( bool  enable)

Sets whether the keyboard closes (hides) when the return key is entered. Default is true.

Note
if false, a carriage return () will be appended to the keyboard string. In either case, a KeyEvent will still fire.
const std::string& cinder::app::AppCocoaTouch::KeyboardOptions::getInitialString ( ) const

Returns the keyboard's initial string.

KeyboardType cinder::app::AppCocoaTouch::KeyboardOptions::getType ( ) const

Returns the keyboard layout type.

bool cinder::app::AppCocoaTouch::KeyboardOptions::getCloseOnReturn ( ) const

Returns whether the keyboard closes (hides) when the return key is entered.


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