mcontroller.h

Go to the documentation of this file.

/*     -*-C++-*- -*-coding: utf-8-unix;-*-
  Classified Ads is Copyright (c) Antti Järvinen 2013-2017.

  This file is part of Classified Ads.

  Classified Ads 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.

  Classified Ads 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 Classified Ads; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/

#ifndef M_CONTROLLER_H
#define M_CONTROLLER_H
#include <QObject>
#include "util/hash.h" // Hash
#include "datamodel/netrequestexecutor.h"
#include "datamodel/cadbrecord.h" // for CaDbRecord::SearchTerms

#define CLASSIFIED_ADS_VERSION "0.11"

class Node ;
class Model ;
class NetworkListener ;
class NetworkConnectorEngine ;
class NetworkRequestExecutor;
class BinaryFile ;
class VoiceCallEngine ;
class MVoiceCallEngine ;
class TclWrapper ;
class QWidget ;

class MController : public QObject {
    Q_OBJECT

public:
    enum CAErrorSituation {
        OwnCertNotFound, 
        DataBaseNotMountable, 
        BadPassword, 
        DbTransactionError, 
        ContentEncryptionError, 
        FileOperationError, 
        TCLEvalError 
    } ;

    enum CAUserInterfaceRequest {
        ViewProfileDetails, 
        ViewCa, 
        ViewProfileComment, 
        DisplayProgressDialog, 
        VoiceCallToNode 
    } ;

    virtual void startRetrievingContent(NetworkRequestExecutor::NetworkRequestQueueItem aReq,
                                        bool aIsBackgroundDl,
                                        ProtocolItemType aTypeOfExpectedObject ) = 0 ;
    virtual void startRetrievingContent( CaDbRecord::SearchTerms aSearchTerms ) = 0 ;

    virtual void userInterfaceAction ( CAUserInterfaceRequest aRequest,
                                       const Hash& aHashConcerned = KNullHash,
                                       const Hash& aFetchFromNode = KNullHash,
                                       const QString* aAdditionalInformation = NULL ) = 0 ;

    virtual void hideUI() = 0 ;
    virtual void showUI() = 0 ;
    virtual void setProfileInUse(const Hash& aProfileHash) = 0 ;
    virtual const Hash& profileInUse() = 0 ;
    virtual void setContentKeyPasswd(QString aPasswd) = 0 ;
    virtual QString contentKeyPasswd()  const = 0;

public slots:
    virtual void exitApp() = 0 ; 
    virtual void displayAboutBox() = 0  ; 
    virtual void displayFront() = 0 ; 
    virtual void handleError(MController::CAErrorSituation aError,
                             const QString& aExplanation) = 0 ;
    virtual Node& getNode()  const = 0 ;
    virtual NetworkListener *networkListener() const = 0 ;
    virtual Model &model() const = 0 ;
    virtual void storePrivateDataOfSelectedProfile(bool aPublishTrustListToo = false ) = 0 ;
    virtual void reStorePrivateDataOfSelectedProfile() = 0 ;
    virtual bool isContactInContactList(const Hash& aFingerPrint) const = 0;
    virtual QString displayableNameForProfile(const Hash& aProfileFingerPrint) const = 0 ;
    virtual void offerDisplayNameForProfile(const Hash& aProfileFingerPrint,
                                            const QString& aDisplayName,
                                            const bool iUpdatePersistenStorage=false) = 0 ;
    virtual void displayFileInfoOnUi(const BinaryFile& aFileMetadata) = 0 ;
    virtual VoiceCallEngine* voiceCallEngine() = 0 ;

    virtual MVoiceCallEngine* voiceCallEngineInterface() = 0 ;

    virtual TclWrapper &tclWrapper() = 0 ;

    virtual QWidget *frontWidget() = 0 ;
    virtual QString getFileName(bool& aSuccess,
                                bool aIsSaveFile = false , 
                                QString aSuggestedFileName = QString()) = 0 ;
} ;
#endif