WizardKit  0.1
WKWizardPanel.h
1 /*
2  * WKWizardPanel.h
3  *
4  * Interface declaration of the WKWizardPanel class for the
5  * WizardKit framework
6  *
7  * Copyright (c) 2006, by Saso Kiselkov
8  *
9  * For license details please see the file COPYING included with this
10  * source distribution package.
11  */
12 
13 #ifndef _WK_WIZARD_PANEL_H_
14 #define _WK_WIZARD_PANEL_H_
15 
16 #import <AppKit/NSPanel.h>
17 
18 @class NSString,
19  NSArray,
20  NSMutableDictionary;
21 @class NSView, NSBox;
22 
23 extern NSString * const WKWizardPanelDidChangeCurrentStageNotification;
24 
25 @interface WKWizardPanel : NSPanel <NSCoding>
26 {
27  // run control
28  BOOL runsInModalSession;
30  BOOL isActive;
31 
32  // stages
33  NSArray * stages;
34  NSString * initialStage;
35  unsigned int currentStage;
36 }
37 
38 - (void) setStages: (NSArray *) someStages;
39 - (NSArray *) stages;
40 
41 - (void) setRunsInModalSession: (BOOL) flag;
42 - (BOOL) runsInModalSession;
43 
44 - (void) setInitialStage: (NSString *) aStageName;
45 - (NSString *) initialStage;
46 
47 - (void) setCentersBeforeActivating: (BOOL) flag;
48 - (BOOL) centersBeforeActivating;
49 
50 - (void) setCurrentStage: (NSString *) aStageName;
51 - (NSArray *) currentStage;
52 
53 - (void) nextStage: (id) sender;
54 - (void) previousStage: (id) sender;
55 
56 - (int) activate: (id) sender;
57 - (void) deactivate: (id) sender;
58 - (void) deactivateWithCode: (int) aCode;
59 
60 - (BOOL) isActive;
61 
62 @end
63 
65 
66 - (NSView *) wizardPanel: (WKWizardPanel *) sender
67  viewForStage: (NSString *) aStageName;
68 
69 - (NSView *) wizardPanel: (WKWizardPanel *) sender
70  initialFirstResponderForStage: (NSString *) aStageName;
71 
72 @end
73 
74 #endif // _WK_WIZARD_PANEL_H_
NSObject(WKWizardPanelDelegate)
This informal protocol defines what methods the delegate of a wizard panel may or must implement to c...
Definition: WKWizardPanel.h:65
WKWizardPanel::runsInModalSession
BOOL runsInModalSession
Returns whether the receiver activates itself in a modal session.
Definition: WKWizardPanel.h:29
WKWizardPanel::stages
NSArray * stages
Returns a list of stages of the receiver.
Definition: WKWizardPanel.h:34
WKWizardPanel::initialStage
NSString * initialStage
Returns the receiver's initial stage.
Definition: WKWizardPanel.h:35
WKWizardPanel::centersBeforeActivating
BOOL centersBeforeActivating
Returns whether the receiver centers itself before activating.
Definition: WKWizardPanel.h:30
WKWizardPanel::currentStage
unsigned int currentStage
Returns the current stage which the receiver displays.
Definition: WKWizardPanel.h:36
WKWizardPanel::isActive
BOOL isActive
Returns whether the receiver is active or not.
Definition: WKWizardPanel.h:31
WKWizardPanel
A wizard panel class.
Definition: WKWizardPanel.h:25