Merge pull request #15 from cemolcay/feature/cemolcay-append-button

[KeyboardLayout] Get, Add, Remove KeyboardButtons

Author: cemolcay

Keyboard/DefaultKeyboard/DefaultKeyboard.swift

@@ -15,6 +15,7 @@ import UIKit
   optional func defaultKeyboardDidPressBackspaceButton(defaultKeyboard: DefaultKeyboard)
   optional func defaultKeyboardDidPressGlobeButton(defaultKeyboard: DefaultKeyboard)
   optional func defaultKeyboardDidPressReturnButton(defaultKeyboard: DefaultKeyboard)
+  optional func defaultKeyboardDidPressKeyboardButton(defaultKeyboard: DefaultKeyboard, keyboardButton: KeyboardButton)
 }
 
 // MARK: - DefaultKeyboard
@@ -35,6 +36,7 @@ public class DefaultKeyboard: UIView, KeyboardLayoutDelegate {
   private var backspaceDeleteTimer: NSTimer?
   private var backspaceAutoDeleteModeTimer: NSTimer?
 
+  private var lastLetterLayout: KeyboardLayout?
   private(set) var currentLayout: KeyboardLayout! {
     didSet {
       oldValue?.delegate = nil
@@ -74,7 +76,7 @@ public class DefaultKeyboard: UIView, KeyboardLayoutDelegate {
     lowercaseLayout = DefaultKeyboardLayout.Lowercase.keyboardLayout
     numbersLayout = DefaultKeyboardLayout.Numbers.keyboardLayout
     symbolsLayout = DefaultKeyboardLayout.Symbols.keyboardLayout
-
+    
     currentLayout = uppercaseLayout
     addSubview(currentLayout)
   }
@@ -136,6 +138,7 @@ public class DefaultKeyboard: UIView, KeyboardLayoutDelegate {
 
   // MARK: KeyboardLayoutDelegate
   public func keyboardLayoutDidPressButton(keyboardLayout: KeyboardLayout, keyboardButton: KeyboardButton) {
+    delegate?.defaultKeyboardDidPressKeyboardButton?(self, keyboardButton: keyboardButton)
     invalidateBackspaceAutoDeleteModeTimer()
     invalidateBackspaceDeleteTimer()
     if keyboardLayout == currentLayout {

Keyboard/KeyboardLayoutEngine/KeyboardLayout.swift

@@ -8,6 +8,14 @@
 
 import UIKit
 
+// MARK: - Array Extension
+extension CollectionType {
+  /// Returns the element at the specified index iff it is within bounds, otherwise nil.
+  subscript (safe index: Index) -> Generator.Element? {
+    return indices.contains(index) ? self[index] : nil
+  }
+}
+
 // MARK: - KeyboardLayoutDelegate
 @objc public protocol KeyboardLayoutDelegate {
   optional func keyboardLayoutDidStartPressingButton(keyboardLayout: KeyboardLayout, keyboardButton: KeyboardButton)
@@ -83,6 +91,34 @@ public class KeyboardLayout: UIView {
     return max(0, (height - totalPaddings) / CGFloat(rows.count))
   }
 
+  // MARK: Manage Buttons
+  public func getKeyboardButton(atRowIndex rowIndex: Int, buttonIndex: Int) -> KeyboardButton? {
+    if let row = rows[safe: rowIndex], let button = row.characters[safe: buttonIndex] as? KeyboardButton {
+      return button
+    }
+    return nil
+  }
+
+  public func addKeyboardButton(keyboardButton button: KeyboardButton, rowAtIndex: Int, buttonIndex: Int?) {
+    if let row = rows[safe: rowAtIndex] {
+      if let index = buttonIndex where buttonIndex < row.characters.count {
+        row.characters.insert(button, atIndex: index)
+      } else {
+        row.characters.append(button)
+      }
+      row.addSubview(button)
+    }
+  }
+
+  public func removeKeyboardButton(atRowIndex rowIndex: Int, buttonIndex: Int) -> Bool {
+    if let row = rows[safe: rowIndex], let button = row.characters[safe: buttonIndex] {
+      row.characters.removeAtIndex(buttonIndex)
+      button.removeFromSuperview()
+      return true
+    }
+    return false
+  }
+
   // MARK: Touch Handling
   public override func touchesBegan(touches: Set<UITouch>, withEvent event: UIEvent?) {
     super.touchesBegan(touches, withEvent: event)

Keyboard/KeyboardViewController.swift

@@ -18,6 +18,17 @@ class KeyboardViewController: UIInputViewController, DefaultKeyboardDelegate {
     defaultKeyboard = DefaultKeyboard()
     defaultKeyboard.delegate = self
     view.addSubview(defaultKeyboard)
+
+    // This is how you add extra buttons to layouts for customising DefaultKeyboard without even subclass it!
+    let customButton = KeyboardButton(
+      type: .Text("🕶"),
+      style: DefaultKeyboardKeyButtonStyle,
+      width: .Static(width: 40),
+      identifier: "customButton")
+    defaultKeyboard.numbersLayout.addKeyboardButton(
+      keyboardButton: customButton,
+      rowAtIndex: 3,
+      buttonIndex: 2)
   }
 
   override func viewDidLayoutSubviews() {
@@ -55,4 +66,12 @@ class KeyboardViewController: UIInputViewController, DefaultKeyboardDelegate {
       advanceToNextInputMode()
     }
   }
+
+  func defaultKeyboardDidPressKeyboardButton(defaultKeyboard: DefaultKeyboard, keyboardButton: KeyboardButton) {
+    if defaultKeyboard == self.defaultKeyboard {
+      if keyboardButton.identifier == "customButton" {
+        print("custom button pressed")
+      }
+    }
+  }
 }