CPDFHeaderFooter.h 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. //
  2. // CPDFHeaderFooter.h
  3. // ComPDFKit
  4. //
  5. // Copyright © 2014-2023 PDF Technologies, Inc. All Rights Reserved.
  6. //
  7. // THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
  8. // AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE ComPDFKit LICENSE AGREEMENT.
  9. // UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
  10. // This notice may not be removed from this file.
  11. //
  12. #import <ComPDFKit/CPDFKitPlatform.h>
  13. /**
  14. * Adds and removes the header & footer.
  15. */
  16. @interface CPDFHeaderFooter : NSObject
  17. #pragma mark - Accessors
  18. /**
  19. * Method to get / set the page range of the header & footer by string, such as "0,3,5-7".
  20. */
  21. @property (nonatomic,retain) NSString *pageString;
  22. /**
  23. * Method to get / set the margins of the header & footer.
  24. */
  25. @property (nonatomic,assign) CPDFKitPlatformEdgeInsets margin;
  26. /**
  27. * Gets the text of the header & footer at the specified index.
  28. */
  29. - (NSString *)textAtIndex:(NSUInteger)index;
  30. /**
  31. * Sets the text of the header & footer at the specified index.
  32. */
  33. - (void)setText:(NSString *)text atIndex:(NSUInteger)index;
  34. /**
  35. * Gets the font color of the header & footer at the specified index.
  36. */
  37. - (CPDFKitPlatformColor *)textColorAtIndex:(NSUInteger)index;
  38. /**
  39. * Sets the font color of the header & footer at the specified index.
  40. */
  41. - (void)setTextColor:(CPDFKitPlatformColor *)color atIndex:(NSUInteger)index;
  42. /**
  43. * Gets the font size of the header & footer at the specified index.
  44. */
  45. - (CGFloat)fontSizeAtIndex:(NSUInteger)index;
  46. /**
  47. * Sets the font size of the header & footer at the specified index.
  48. */
  49. - (void)setFontSize:(CGFloat)fontSize atIndex:(NSUInteger)index;
  50. /**
  51. * Gets the font name of the header & footer at the specified index.
  52. */
  53. - (NSString *)fontNameAtIndex:(NSUInteger)index;
  54. /**
  55. * Sets the font name of the header & footer at the specified index.
  56. */
  57. - (void)setFontName:(NSString *)fontName atIndex:(NSUInteger)index;
  58. /**
  59. * Updates the header & footer.
  60. */
  61. - (void)update;
  62. /**
  63. * Removes the header & footer.
  64. */
  65. - (void)clear;
  66. @end