FileInterface.hh 6.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper 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 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper 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 LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
 *                                                                           *
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42 43 44 45 46 47 48




//
// C++ Interface: BasePlugin
//
49
// Description:
Jan Möbius's avatar
 
Jan Möbius committed
50 51 52 53 54
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

55 56
#ifndef FILEINTERFACE_HH
#define FILEINTERFACE_HH
Jan Möbius's avatar
 
Jan Möbius committed
57 58 59

 #include <QtGui>
 #include <OpenFlipper/common/Types.hh>
60

Jan Möbius's avatar
 
Jan Möbius committed
61
 /** \brief Interface class for file and object handling
62 63
  *
  * This interface class has to be fully implemented. When you want to support save and load
Jan Möbius's avatar
 
Jan Möbius committed
64 65 66 67 68 69 70
  * for an object type you have to implement all functions in this class. The core manages the
  * load and save interaction and gives the load and save actions to your plugin. The decision
  * which plugin is called for saving an object depends on your supportedTypes() and the filters
  * defined by your plugin.
 */

class FileInterface {
71

Jan Möbius's avatar
Jan Möbius committed
72 73 74 75
//===========================================================================
/** @name Widgets
* @{ */
//===========================================================================
76 77 78 79
  public:

    /// Destructor
    virtual ~FileInterface() {};  
Dirk Wilden's avatar
Dirk Wilden committed
80

Jan Möbius's avatar
Jan Möbius committed
81 82 83 84 85 86 87 88
    /** You can provide a special widget showing options for saving your file types
      *  depending on the current filter
      *
      *  _currentFilter: one filter from saveFilters
      *
      *  Return 0 when you dont need one
      */
    virtual QWidget* saveOptionsWidget(QString /*_currentFilter*/) = 0;
Dirk Wilden's avatar
Dirk Wilden committed
89

Jan Möbius's avatar
Jan Möbius committed
90 91 92 93 94 95 96 97
    /** You can provide a special widget showing options for loading your file types
      *  depending on the current filter
      *
      *  _currentFilter: one filter from loadFilters
      *
      *  Return 0 when you dont need one
      */
    virtual QWidget* loadOptionsWidget(QString /*_currentFilter*/) = 0;
Jan Möbius's avatar
Jan Möbius committed
98 99

/** @} */
100

Jan Möbius's avatar
 
Jan Möbius committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
//===========================================================================
/** @name Supported types
* @{ */
//===========================================================================

public:

  /** Return the name of your supported type (e.g. "Triangle Mesh"
   */
  virtual QString typeName() = 0;

  /** Return your supported object type( e.g. DATA_TRIANGLE_MESH )
   *
   * TODO : Support for adding new datatypes at runtime
   */
  virtual DataType supportedType() = 0;


  /** Return the Qt Filters for Filedialogs when loading files (e.g. "Off files ( *.off )" )
   *
   */
  virtual QString getLoadFilters() = 0;

  /** Get the Qt Filters for Filedialogs when saving files (e.g. "Off files ( *.off )" )
   *
   */
  virtual QString getSaveFilters() = 0;

/** @} */

//===========================================================================
/** @name Load Save Implementation
* @{ */
//===========================================================================

136 137
public slots:

Jan Möbius's avatar
 
Jan Möbius committed
138 139 140 141 142 143
      /** \brief Create an empty object
       *
       * When this slot is called you have to create an object of your supported type.
       * @return Id of the new Object
       */
      virtual int addEmpty() = 0;
Jan Möbius's avatar
Jan Möbius committed
144 145 146 147
      
      /** \todo Add an addEmpty function with a given type as an attribute. The plugin should then create only an
                empty object of the given type. It can be assumed that there is only one type given at a time.
      */
Jan Möbius's avatar
 
Jan Möbius committed
148 149 150 151 152 153 154

      /** \brief Load an object from the given file
       *
       * The Core will call this slot if you should load a file. The core will
       * check if you support the given file type depending on the provided
       * filters and dataTypes ( see supportedType and getLoadFilters )
       */
Dirk Wilden's avatar
Dirk Wilden committed
155
      virtual int loadObject(QString /*_filename*/) = 0;
156

Jan Möbius's avatar
 
Jan Möbius committed
157 158 159 160 161 162 163
      /** \brief Save an object from the given file
       *
       * The Core will call this slot if you should save an object to a file.
       * The core will check if you support the given object depending on the
       * provided dataTypes ( see supportedType ).
       * Additionally to the filename you get the id of the object to save
       */
Dirk Wilden's avatar
Dirk Wilden committed
164
      virtual bool saveObject(int /*_id*/, QString /*_filename*/) = 0;
165

Jan Möbius's avatar
 
Jan Möbius committed
166
/** @} */
167

Jan Möbius's avatar
 
Jan Möbius committed
168 169 170
};

Q_DECLARE_INTERFACE(FileInterface,"OpenFlipper.FileInterface/0.3")
171

Jan Möbius's avatar
 
Jan Möbius committed
172
#endif // FILEINTERFACE_HH