ArServerHandlerPopup.h

Go to the documentation of this file.

/*
MobileRobots Advanced Robotics Interface for Applications (ARIA)
Copyright (C) 2004, 2005 ActivMedia Robotics LLC
Copyright (C) 2006, 2007 MobileRobots Inc.

     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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

If you wish to redistribute ARIA under different terms, contact 
MobileRobots for information about a commercial version of ARIA at 
robots@mobilerobots.com or 
MobileRobots Inc, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
*/

#ifndef ARSERVERHANDLERPOPUP_H
#define ARSERVERHANDLERPOPUP_H

#include "Aria.h"
#include "ArServerBase.h"


class ArServerClient;

class ArServerHandlerPopupInfo;


class ArServerHandlerPopup
{
public:
  AREXPORT ArServerHandlerPopup(ArServerBase *server);
  AREXPORT virtual ~ArServerHandlerPopup();
  AREXPORT ArTypes::Byte4 createPopup(
          ArServerHandlerPopupInfo *popupInfo,
          ArFunctor2<ArTypes::Byte4, int> *callback = NULL);
  AREXPORT void closePopup(ArTypes::Byte4 id,
                            const char *closeMessage);
  AREXPORT void netPopupClicked(ArServerClient *client, 
                                ArNetPacket *packet);
  AREXPORT void serverCycleCallback(void);
  enum PopupType { 
    NOICON = 0, 
    INFORMATION = 1, 
    WARNING = 2, 
    CRITICAL = 3, 
    QUESTION = 4 
  };
protected:
  ArServerBase *myServer;
  class PopupData {
  public:
    PopupData(ArServerHandlerPopupInfo *popupInfo, 
              ArTypes::Byte4 id,
              ArFunctor2<ArTypes::Byte4, int> *callback);
    virtual ~PopupData();
    ArServerHandlerPopupInfo *myPopupInfo;
    ArFunctor2<ArTypes::Byte4, int> *myCallback;
    ArTime myStarted;
    ArTypes::Byte4 myID;
    
  };
  ArMutex myDataMutex;
  std::map<ArTypes::Byte4, PopupData *> myMap;
  ArTypes::Byte4 myLastID;
  ArTime myLastTimeCheck;
  ArFunctor2C<ArServerHandlerPopup, ArServerClient*, 
      ArNetPacket *> myNetPopupClickedCB;
  ArFunctorC<ArServerHandlerPopup> myServerCycleCB;
};


class ArServerHandlerPopupInfo
{
public:
  AREXPORT ArServerHandlerPopupInfo(
          const char *ignoreIdentifier, const char *title, 
          const char *message, ArServerHandlerPopup::PopupType popupType, 
          ArTypes::Byte defaultButtonNumber, 
          ArTypes::Byte escapeButtonNumber,  
          int timeoutInSeconds, const char *timeoutString,
          const char *button0Label, const char *button0Pressed, 
          const char *button1Label = "", const char *button1Pressed = "", 
          const char *button2Label = "", const char *button2Pressed = "");

  AREXPORT virtual ~ArServerHandlerPopupInfo();
  AREXPORT ArServerHandlerPopupInfo(const ArServerHandlerPopupInfo &popupInfo);
  AREXPORT ArServerHandlerPopupInfo &operator=(
          const ArServerHandlerPopupInfo &popupInfo);

  const char *getIgnoreIdentifier(void) { return myIgnoreIdentifier.c_str(); }
  const char *getTitle(void) { return myTitle.c_str(); }
  const char *getMessage(void) { return myMessage.c_str(); }
  ArServerHandlerPopup::PopupType getPopupType(void) { return myPopupType; }
  ArTypes::Byte getDefaultButtonNumber(void) { return myDefaultButtonNumber; }
  ArTypes::Byte getEscapeButtonNumber(void) { return myEscapeButtonNumber; }
  int getTimeout(void) { return myTimeout; }
  const char * getTimeoutString(void) 
    { return myTimeoutString.c_str(); }
  const char *getButton0Label(void) { return myButton0Label.c_str(); }
  const char *getButton0Pressed(void) { return myButton0Pressed.c_str(); }

  const char *getButton1Label(void) { return myButton1Label.c_str(); }
  const char *getButton1Pressed(void) { return myButton1Pressed.c_str(); }
  const char *getButton2Label(void) { return myButton2Label.c_str(); }
  const char *getButton2Pressed(void) { return myButton2Pressed.c_str(); }

  void setIgnoreIdentifier(const char *identifier) 
    { if (identifier != NULL) myIgnoreIdentifier = identifier; else myIgnoreIdentifier = ""; }
  void setTitle(const char *title) 
    { if (title != NULL) myTitle = title; else myTitle = ""; }
  void setMessage(const char *message) 
    { if (message != NULL) myMessage = message; else myMessage = ""; }
  void setPopupType(ArServerHandlerPopup::PopupType popupType) 
    { myPopupType = popupType; }
  void setDefaultButtonNumber(ArTypes::Byte defaultButtonNumber) 
    { myDefaultButtonNumber = defaultButtonNumber; }
  void setEscapeButtonNumber(ArTypes::Byte escapeButtonNumber) 
    { myEscapeButtonNumber = escapeButtonNumber; }
  void setTimeout(int timeoutInSeconds)
    { myTimeout = timeoutInSeconds; }
  void setTimeoutString(const char *timeoutString) 
    { if (timeoutString != NULL) myTimeoutString = timeoutString; else myTimeoutString = ""; }
  void setButton0Label(const char *label) 
    { if (label != NULL) myButton0Label = label; else myButton0Label = ""; }
  void setButton0Pressed(const char *pressed) 
    { if (pressed != NULL) myButton0Pressed = pressed; else myButton0Pressed = ""; }
  void setButton1Label(const char *label) 
    { if (label != NULL) myButton1Label = label; else myButton1Label = ""; }
  void setButton1Pressed(const char *pressed) 
    { if (pressed != NULL) myButton1Pressed = pressed; else myButton1Pressed = ""; }
  void setButton2Label(const char *label) 
    { if (label != NULL) myButton2Label = label; else myButton2Label = ""; }
  void setButton2Pressed(const char *pressed) 
    { if (pressed != NULL) myButton2Pressed = pressed; else myButton2Pressed = ""; }

protected:
  std::string myIgnoreIdentifier;
  std::string myTitle;
  std::string myMessage;
  ArServerHandlerPopup::PopupType myPopupType;
  ArTypes::Byte myDefaultButtonNumber;
  ArTypes::Byte myEscapeButtonNumber;
  int myTimeout;
  std::string myTimeoutString;
  std::string myButton0Label;
  std::string myButton0Pressed;
  std::string myButton1Label;
  std::string myButton1Pressed;
  std::string myButton2Label;
  std::string myButton2Pressed;
};

#endif // ARSERVERHANDLERPOPUP_H

---