#import "HBListController.h"

NS_ASSUME_NONNULL_BEGIN

/// The HBAboutListController class in CepheiPrefs provides a list controller with functions
/// that would typically be used on an "about" page. It includes two class methods you can override
/// to provide a developer website and donation URL, and a class method to provide an email address
/// so the user can send the developer an email right from the tweak's settings.
///
/// There is a sample of an HBAboutListController implemented in the Cephei demo preferences. See
/// the Cephei readme for details.
///
/// ### Example Usage
/// ```xml
/// <dict>
/// 	<key>cell</key>
/// 	<string>PSLinkCell</string>
/// 	<key>cellClass</key>
/// 	<string>HBLinkTableCell</string>
/// 	<key>label</key>
/// 	<string>Visit Website</string>
/// 	<key>url</key>
/// 	<string>https://hashbang.productions/</string>
/// </dict>
/// <dict>
/// 	<key>cell</key>
/// 	<string>PSGroupCell</string>
/// 	<key>label</key>
/// 	<string>Experiencing issues?</string>
/// </dict>
/// <dict>
/// 	<key>action</key>
/// 	<string>hb_sendSupportEmail</string>
/// 	<key>cell</key>
/// 	<string>PSLinkCell</string>
/// 	<key>label</key>
/// 	<string>Email Support</string>
/// </dict>
/// <dict>
/// 	<key>cell</key>
/// 	<string>PSGroupCell</string>
/// 	<key>footerText</key>
/// 	<string>If you like this tweak, please consider a donation.</string>
/// </dict>
/// <dict>
/// 	<key>cell</key>
/// 	<string>PSLinkCell</string>
/// 	<key>cellClass</key>
/// 	<string>HBLinkTableCell</string>
/// 	<key>label</key>
/// 	<string>Donate</string>
/// 	<key>url</key>
/// 	<string>https://hashbang.productions/donate/</string>
/// </dict>
/// ```

@interface HBAboutListController : HBListController

/// @name Constants

/// The website URL to open when tapping the “visit website” cell. Override this method to return
/// your own URL.
///
/// Deprecated. It is encouraged to use an `HBLinkTableCell` instead.
///
/// @return By default, https://hashbang.productions/.
+ (NSURL *)hb_websiteURL __attribute((deprecated("Use an HBLinkTableCell instead.")));

/// The website URL to open when tapping the "donate" cell. Override this method to return your own
/// URL.
///
/// Deprecated. It is encouraged to use an `HBLinkTableCell` instead.
///
/// @return By default, https://hashbang.productions/donate/.
+ (NSURL *)hb_donateURL __attribute((deprecated("Use an HBLinkTableCell instead.")));

/// The email address to use in the support email composer form. Override this method to return an
/// email address.
///
/// If this method returns nil, the package’s author email address is used.
///
/// @return By default, nil.
+ (nullable NSString *)hb_supportEmailAddress;

/// No longer supported.
///
/// @return By default, nil.
/// @see `HBSupportController`
+ (nullable NSArray *)hb_supportInstructions __attribute((deprecated("TechSupport is no longer supported.")));

/// @name Preference Specifier Actions

/// Opens the user's browser to the URL specified by `-hb_websiteURL`.
///
/// Deprecated. Use an `HBLinkTableCell` instead.
- (void)hb_openWebsite __attribute((deprecated("Use an HBLinkTableCell instead.")));

/// Opens the user's browser to the URL specified by `-hb_donateURL`.
///
/// Deprecated. Use an `HBLinkTableCell` instead.
- (void)hb_openDonate __attribute((deprecated("Use an HBLinkTableCell instead.")));

/// Displays a support composer form.
///
/// The `-hb_supportEmailAddress` and `-hb_supportInstructions` methods are used to provide the
/// appropriate parameters to `HBSupportController`.
///
/// @see `HBSupportController`
- (void)hb_sendSupportEmail;

@end

NS_ASSUME_NONNULL_END