source: trunk/SapphireShowChooser.h @ 375

Revision 375, 1.5 KB checked in by gbooker, 7 years ago (diff)

More documentation (and a removed dead code here or there) while I watched the season finale of dexter (wow that was good).

Line 
1//
2//  SapphireShowChooser.h
3//  Sapphire
4//
5//  Created by Graham Booker on 7/1/07.
6//  Copyright 2007 www.nanopi.net. All rights reserved.
7//
8
9#import "SapphireCenteredMenuController.h"
10
11#define SHOW_CHOOSE_CANCEL -2
12#define SHOW_CHOOSE_NOT_SHOW -1
13
14/*!
15 * @brief A subclass of SapphireCenteredMenuController to choose a show title
16 *
17 * This class presents the user with a list of possible shows to match a file and asks the user to choose its name.
18 */
19@interface SapphireShowChooser : SapphireCenteredMenuController {
20        NSArray                 *shows;         /*!< @brief The list of possible shows*/
21        NSString                *searchStr;     /*!< @brief The string we searched for*/
22        int                             selection;      /*!< @brief The user's selection*/
23        BRTextControl   *fileName;      /*!< @brief The filename control*/
24}
25
26/*!
27 * @brief Sets the shows to choose from
28 *
29 * @param showList The list of shows to choose from
30 */
31- (void)setShows:(NSArray *)showList;
32
33/*!
34 * @brief Sets the filename to display
35 *
36 * @param choosingForFileName The filename being choosen for
37 */
38- (void)setFileName:(NSString *)choosingForFileName;
39
40/*!
41 * @brief The list of shows to choose from
42 *
43 * @return The list of shows to choose from
44 */
45- (NSArray *)shows;
46
47/*!
48 * @brief Sets the string we searched for
49 *
50 * @param search The string we searched for
51 */
52- (void)setSearchStr:(NSString *)search;
53
54/*!
55 * @brief The string we searched for
56 *
57 * @return The string we searched for
58 */
59- (NSString *)searchStr;
60
61/*!
62 * @brief The item the user selected.  Special values are in the header file
63 *
64 * @return The user's selection
65 */
66- (int)selection;
67
68@end
Note: See TracBrowser for help on using the repository browser.