ArticleController.h

//
//  ArticleController.h
//  Vienna
//
//  Created by Steve on 5/6/06.
//  Copyright (c) 2004-2005 Steve Palmer. All rights reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

#import <Cocoa/Cocoa.h>
#import "FoldersTree.h"
#import "BacktrackArray.h"
#import "BaseView.h"
#import "ArticleBaseView.h"
#import "ArticleView.h"

/* ArticleController
 * The ArticleController contains the controlling logic for the article view that is
 * independent of the view. The code here was split from ArticleListView for the
 * purpose of allowing us to manage multiple article views. The application
 * controller creates a single article controller then assigns it the candidate
 * article view. Thus all control of the article view now passes through the article
 * controller.
 */
@interface ArticleController : NSObject
{
	IBOutlet FoldersTree * foldersTree;

	NSView<ArticleBaseView, BaseView> * mainArticleView;
	NSArray * currentArrayOfArticles;
	NSArray * folderArrayOfArticles;
	int currentFolderId;
	NSDictionary * articleSortSpecifiers;
	NSString * sortColumnIdentifier;
	BackTrackArray * backtrackArray;
	BOOL isBacktracking;
	Article * articleToPreserve;
    NSOperationQueue * operationQueue;
}

// Public functions
-(NSView<ArticleBaseView, BaseView> *)mainArticleView;
-(void)setMainArticleView:(NSView<ArticleBaseView, BaseView> *)newView;
-(int)currentFolderId;
-(Article *)selectedArticle;
-(void)sortArticles;
-(NSArray *)allArticles;
-(void)displayFirstUnread;
-(void)displayNextUnread;
-(NSString *)searchPlaceholderString;
-(void)reloadArrayOfArticles;
-(void)refreshCurrentFolder;
-(void)displayFolder:(int)newFolderId;
-(void)refilterArrayOfArticles;
-(NSString *)sortColumnIdentifier;
-(BOOL)sortIsAscending;
-(void)ensureSelectedArticle:(BOOL)singleSelection;
-(void)sortByIdentifier:(NSString *)columnName;
-(void)sortAscending:(BOOL)newAscending;
-(BOOL)currentCacheContainsFolder:(int)folderId;
-(void)deleteArticlesByArray:(NSArray *)articleArray;
-(void)markReadByArray:(NSArray *)articleArray readFlag:(BOOL)readFlag;
-(void)markAllReadByReferencesArray:(NSArray *)refArray readFlag:(BOOL)readFlag;
-(void)markAllReadByArray:(NSArray *)folderArray withUndo:(BOOL)undoFlag withRefresh:(BOOL)refreshFlag;
-(void)markDeletedByArray:(NSArray *)articleArray deleteFlag:(BOOL)deleteFlag;
-(void)markFlaggedByArray:(NSArray *)articleArray flagged:(BOOL)flagged;
-(void)addBacktrack:(NSString *)guid;
-(void)goForward;
-(void)goBack;
-(BOOL)canGoForward;
-(BOOL)canGoBack;
-(void)setArticleToPreserve:(Article *)article;
@end