/*!
  @header FTTool
  @abstract Defines the protocol of ft based tools
 
  @availability OS X, GNUstep
  @copyright 2004, 2005, 2006 Free Software Foundation, Inc.
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA

  <pre>
  -------------------------------------------------------------------------
  Modification history

  29.07.06 ola     initial version
  23.08.06 ola     license changed
  -------------------------------------------------------------------------
  </pre>
*/

#if !defined(__FTTool_h)
#define __FTTool_h

#include <FT/FT.h>


/*!
 * @protocol FTTool
 * @abstract Methods to implement for an application which uses the
 *   generic "framework" for an FT tool. Such application may implement
 *   the methods of this protocol and may be derived from FTAbstractTool.
 */
@protocol FTTool <FTObject>

/*!
 * @method cmdLineArgumentsOK
 * @result YES if the check for the command line arguments has successfully been
 *   passed
 */
- (BOOL) cmdLineArgumentsOK;


/*!
 * @method cmdLineArgumentsOverview
 * @abstract Prints information on the usage of command line arguments on the 
 *   standard output
 * @result self
 */
- cmdLineArgumentsOverview;


/*!
 * @method log
 * @result logging instance for FTExport
 */
- (ECLogger *) log;


/*!
 * @method run
 * @abstract runs the export
 * @result self
 */
- run;

@end

#endif