guiframework.h

/**
 *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
 *  Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
 *                                                                              
 *  This program 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; either version 2 of the License, or
 *  (at your option) any later version.
 *                                                                              
 *  This program 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 this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef __GUI_FRAMEWORK_H__
#define __GUI_FRAMEWORK_H__

/* Inherited class by GUI classes */
/* The GuiFramework class is the base of all user interface */

#include <string>

class GuiFramework {
public:
	GuiFramework ();
	virtual ~GuiFramework (void);

	/* Parent class to child class */
	virtual int incomingCall (short id) = 0;
	virtual int incomingCall (short id, const std::string& accountId, const std::string& from);
	virtual void peerAnsweredCall (short id) = 0;
	virtual int peerRingingCall (short id) = 0;
	virtual int peerHungupCall (short id) = 0;
	virtual void displayTextMessage (short id, const std::string& message) = 0;
	virtual void displayErrorText (short id, const std::string& message) = 0;
	virtual void displayError (const std::string& error) = 0;
	virtual void displayStatus (const std::string& status) = 0;
	virtual void displayContext (short id) = 0;
	virtual std::string getRingtoneFile (void) = 0;
	virtual void setup (void) = 0;
	//virtual int selectedCall (void) = 0;
	//virtual bool isCurrentId (short) = 0;
	virtual void startVoiceMessageNotification (void) = 0;
	virtual void stopVoiceMessageNotification (void) = 0;
	
	/* Child class to parent class */
	int outgoingCall (const std::string& to); 	
	int hangupCall (short id);
	int cancelCall (short id);
	int answerCall (short id);
	int onHoldCall (short id);
	int offHoldCall (short id);
	int transferCall (short id, const std::string& to);
	void mute ();
	void unmute ();
	void muteOn (short id);
	void muteOff (short id);
	int refuseCall (short id);

	int saveConfig (void);
	int registerVoIPLink (void);
	int unregisterVoIPLink (void);
	int quitApplication (void);
	int sendTextMessage (short id, const std::string& message);
	int accessToDirectory (void);
	bool sendDtmf (short id, char code);
  bool playDtmf (char code);
  bool playTone ();
	
protected:
	std::string _message;

};

#endif // __GUI_FRAMEWORK_H__