/**
 * $Id$
 * $Revision$
 * $Author$
 * $Date$
 *
 * This file is part of The iWear Framework.
 * In particular this file is part of the Framework Output
 *
 * The iWear Framework is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the
 * Free Software Foundation as in version 2 of the License.

 * 
 * The iWear Framework 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 General Public License for
 * more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * The iWear Framework; if not, write to the Free Software Foundation, Inc., 59
 * Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __OUTPUTCLIENT_H
#define __OUTPUTCLIENT_H

// Standard includes
#include <string>

// iWear includes

namespace iwear {
namespace output {

using std::string;

class OutputData;

/**
 * This class is the base class of all applications which want to
 * use the OutputManager for distributing content.
 * @author Christian Ober-Bloebaum, Carsten Rachuy
 */
class OutputClient{

 public:

    /**
     * Constructor
     * @param application_name The name of the application.
     * @param application_description A longer description of the
     *        the application.
     */
    OutputClient(const string& application_name, 
		 const string& application_description);
    
    /**
     * Destructor
     */   
    virtual ~OutputClient(void);

    
    /**
     * @return The application name
     */
    inline const string& get_application_name(void) const {
	return this->application_name;
    }


    /**
     * @return The application description
     */
    inline const string& get_application_description(void) const {
	return this->application_description;
    }

    /**
     * Has to be implemented by the deriving classes and is called by the
     * OutputManager when hes has to stop displaying an OutputData for some
     * reason.
     */
    virtual void notify_destroy_odo(OutputData* data) = 0;

 protected:

    /**
     * The application name
     */
    const string application_name;
    
    /**
     * The application description
     */
    const string application_description;

};

} // namespace output
} // namespace iwear

#endif // __OUTPUTCLIENT_H