Cinder  0.9.1
Public Member Functions | List of all members
cinder::app::AppCocoaTouch::KeyboardOptions Struct Reference

#include <AppCocoaTouch.h>

Public Member Functions

 KeyboardOptions ()
 
KeyboardOptionsinitialString (const std::string &str)
 
KeyboardOptionstype (KeyboardType type)
 
KeyboardOptionscloseOnReturn (bool enable)
 
const std::string & getInitialString () const
 
KeyboardType getType () const
 
bool getCloseOnReturn () const
 

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: