XLFormSectionDescriptor.h 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. //
  2. // XLFormSectionDescriptor.h
  3. // XLForm ( https://github.com/xmartlabs/XLForm )
  4. //
  5. // Copyright (c) 2015 Xmartlabs ( http://xmartlabs.com )
  6. //
  7. //
  8. // Permission is hereby granted, free of charge, to any person obtaining a copy
  9. // of this software and associated documentation files (the "Software"), to deal
  10. // in the Software without restriction, including without limitation the rights
  11. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. // copies of the Software, and to permit persons to whom the Software is
  13. // furnished to do so, subject to the following conditions:
  14. //
  15. // The above copyright notice and this permission notice shall be included in
  16. // all copies or substantial portions of the Software.
  17. //
  18. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. // THE SOFTWARE.
  25. #import "XLFormRowDescriptor.h"
  26. #import <Foundation/Foundation.h>
  27. typedef NS_OPTIONS(NSUInteger, XLFormSectionOptions) {
  28. XLFormSectionOptionNone = 0,
  29. XLFormSectionOptionCanInsert = 1 << 0,
  30. XLFormSectionOptionCanDelete = 1 << 1,
  31. XLFormSectionOptionCanReorder = 1 << 2
  32. };
  33. typedef NS_ENUM(NSUInteger, XLFormSectionInsertMode) {
  34. XLFormSectionInsertModeLastRow = 0,
  35. XLFormSectionInsertModeButton = 2
  36. };
  37. @class XLFormDescriptor;
  38. @interface XLFormSectionDescriptor : NSObject
  39. @property (nonatomic, nullable) NSString * title;
  40. @property (nonatomic, nullable) NSString * footerTitle;
  41. @property (readonly, nonnull) NSMutableArray * formRows;
  42. @property (readonly) XLFormSectionInsertMode sectionInsertMode;
  43. @property (readonly) XLFormSectionOptions sectionOptions;
  44. @property (nullable) XLFormRowDescriptor * multivaluedRowTemplate;
  45. @property (readonly, nullable) XLFormRowDescriptor * multivaluedAddButton;
  46. @property (nonatomic, nullable) NSString * multivaluedTag;
  47. @property (weak, null_unspecified) XLFormDescriptor * formDescriptor;
  48. @property (nonnull) id hidden;
  49. -(BOOL)isHidden;
  50. +(nonnull instancetype)formSection;
  51. +(nonnull instancetype)formSectionWithTitle:(nullable NSString *)title;
  52. +(nonnull instancetype)formSectionWithTitle:(nullable NSString *)title multivaluedSection:(BOOL)multivaluedSection DEPRECATED_ATTRIBUTE DEPRECATED_MSG_ATTRIBUTE("Use formSectionWithTitle:sectionType: instead");
  53. +(nonnull instancetype)formSectionWithTitle:(nullable NSString *)title sectionOptions:(XLFormSectionOptions)sectionOptions;
  54. +(nonnull instancetype)formSectionWithTitle:(nullable NSString *)title sectionOptions:(XLFormSectionOptions)sectionOptions sectionInsertMode:(XLFormSectionInsertMode)sectionInsertMode;
  55. -(BOOL)isMultivaluedSection;
  56. -(void)addFormRow:(nonnull XLFormRowDescriptor *)formRow;
  57. -(void)addFormRow:(nonnull XLFormRowDescriptor *)formRow afterRow:(nonnull XLFormRowDescriptor *)afterRow;
  58. -(void)addFormRow:(nonnull XLFormRowDescriptor *)formRow beforeRow:(nonnull XLFormRowDescriptor *)beforeRow;
  59. -(void)removeFormRowAtIndex:(NSUInteger)index;
  60. -(void)removeFormRow:(nonnull XLFormRowDescriptor *)formRow;
  61. @end