/*
	NSSearchFieldCell.h
	Application Kit
	Copyright (c) 2003-2012, Apple Inc.
	All rights reserved.
 */

#import <AppKit/NSTextFieldCell.h>


// Search menu template tags. Special items in the search menu are tagged so when the actual dynamic search menu is constructed, we know which items to show or hide.

#define	NSSearchFieldRecentsTitleMenuItemTag     1000
// Title of recents menu group. Hidden if no recents. Also use for separators that my go away with recents

#define	NSSearchFieldRecentsMenuItemTag          1001
// Recent items have this tag. Use to indicate location of recents in custom menu if no title specified

#define	NSSearchFieldClearRecentsMenuItemTag     1002
// The 'Clear Recents' item has this tag. Hidden if no recents

#define	NSSearchFieldNoRecentsMenuItemTag        1003
// The item describing a lack of recents uses this tag. Hidden if recents

@class NSButtonCell, NSMenu, NSMutableArray, NSTimer;

@interface NSSearchFieldCell : NSTextFieldCell {
  @private
    struct __sfFlags {
	unsigned int sendsWholeSearchString:1;
	unsigned int maximumRecents:8;
	unsigned int cancelVisible:1;
	unsigned int reserved2:2;
	unsigned int disableText:1;
	unsigned int menuTracking:1;
	unsigned int deferredUpdate:1;
	unsigned int sendsImmediately:1;

	unsigned int reserved:16;
    } _sfFlags;
    NSButtonCell*   _searchButtonCell;
    NSButtonCell*   _cancelButtonCell;
    NSMenu*         _searchMenuTemplate;
    NSString*       _recentsAutosaveName;
    NSMutableArray* _recentSearches;
    NSMenu*         _searchMenu;
    NSTimer*        _partialStringTimer;
    unsigned int _reserved1;
    unsigned int _reserved2;
    unsigned int _reserved3;
    unsigned int _reserved4;    
}

- (NSButtonCell*) searchButtonCell;
- (void) setSearchButtonCell:(NSButtonCell*)cell;
    // can modify, set or cancel search button.

- (NSButtonCell*) cancelButtonCell;
- (void) setCancelButtonCell:(NSButtonCell*)cell;
    // can modify, set or clear cancel button.

- (void) resetSearchButtonCell;
- (void) resetCancelButtonCell;
    // restore target, action, and image. if cell has been cleared, creates a new cell with default values.

- (NSRect) searchTextRectForBounds:(NSRect)rect;
- (NSRect) searchButtonRectForBounds:(NSRect)rect;
- (NSRect) cancelButtonRectForBounds:(NSRect)rect;
    // for custom layout or to get current sizes

- (void) setSearchMenuTemplate:(NSMenu*)menu;
- (NSMenu*)searchMenuTemplate;
    // set/get search menu template. Menu can use custom tagged items to indicate special items. this menu isn't actually set but used to construct the dynamic search menu. if cleared, then we don't track recents.

- (void) setSendsWholeSearchString:(BOOL)flag;
- (BOOL) sendsWholeSearchString;
    // if clear, send action on each key stroke (after sufficient amount of time so we don't interfere with typing). if set, send only on return/enter or clicking magnifying search button

- (void) setMaximumRecents:(NSInteger)maxRecents;
- (NSInteger) maximumRecents;
    // set/get limit max recents. allowable between 0 and 254. setting -1 will use default.

- (void) setRecentSearches:(NSArray*)searches;
- (NSArray*) recentSearches;
    // if app wants to do custom search lists. will return empty array if no searches

- (void) setRecentsAutosaveName:(NSString*)string;
- (NSString*) recentsAutosaveName;
    // must be set to use. default is nil which means no autosave.

- (BOOL) sendsSearchStringImmediately;
- (void) setSendsSearchStringImmediately:(BOOL)flag;

@end