InputPlugin.swift 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. //
  2. // InputPlugin.swift
  3. // InputBarAccessoryView
  4. //
  5. // Copyright © 2017-2019 Nathan Tannar.
  6. //
  7. // Permission is hereby granted, free of charge, to any person obtaining a copy
  8. // of this software and associated documentation files (the "Software"), to deal
  9. // in the Software without restriction, including without limitation the rights
  10. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11. // copies of the Software, and to permit persons to whom the Software is
  12. // furnished to do so, subject to the following conditions:
  13. //
  14. // The above copyright notice and this permission notice shall be included in all
  15. // copies or substantial portions of the Software.
  16. //
  17. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23. // SOFTWARE.
  24. //
  25. // Copyright © 2017-2019 Nathan Tannar. All rights reserved.
  26. //
  27. import UIKit
  28. /// `InputPlugin` is a protocol that makes integrating plugins to the `InputBarAccessoryView` easy.
  29. public protocol InputPlugin: AnyObject {
  30. /// Should reload the state if the `InputPlugin`
  31. func reloadData()
  32. /// Should remove any content that the `InputPlugin` is managing
  33. func invalidate()
  34. /// Should handle the input of data types that an `InputPlugin` manages
  35. ///
  36. /// - Parameter object: The object to input
  37. func handleInput(of object: AnyObject) -> Bool
  38. }