rwUserQuestionHandler.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfutil/rwTemplatedList.h"
#include "vrfutil/rwUserQuestion.h"
#include "vrftasks/scriptedTaskTask.h"

class DtIfUserQuestionOperation;

class DT_DLL_vrfobjcore DtRwUserQuestionHandler : public DtReaderWriter
{
public:
   DtRwUserQuestionHandler(const DtString& rwName, DtReaderWriterRegistry*  parentRegistry = 0);

   DtRwUserQuestionHandler(const DtRwUserQuestionHandler& orig,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   const DtRwUserQuestionHandler& operator=( 
      const DtRwUserQuestionHandler& orig);

   virtual ~DtRwUserQuestionHandler();


   virtual int currentQuestionId(const DtString&) const;

   virtual int outstandingQuestionId(const DtString&) const;

   virtual DtString scriptIdFor(int) const;

   virtual int askUserQuestion(const DtString& scriptId, const DtRwTranslatableStringObject& title,
      const DtRwTranslatableStringObject& message, const std::vector<DtRwTranslatableStringObject>& options,
      int displayFlag);

   virtual bool userQuestionData(int questionId, DtString& scriptId, DtRwTranslatableStringObject& title,
      DtRwTranslatableStringObject& message, std::vector<DtRwTranslatableStringObject>& options,
      int& displayFlag) const;

   virtual int statusOfUserQuestion(int) const;

   virtual bool cancelUserQuestion(int);
   virtual void cancelUserResponse(const DtString& scriptId);

   virtual void processUserResponse(const DtIfUserQuestionOperation&);


protected:
   virtual int nextQuestionId();

protected:
   typedef DtRwTemplatedListPtr<DtRwUserQuestion, true> UserQuestions;
   UserQuestions myUserQuestions;

   typedef DtRwTemplatedListPtr<DtScriptedTaskTask, true> UserResponses;
   UserResponses myUserResponses;

   int myQuestionId;
};