MAK RTIspy API Documentation for HLA 1516: assistantPopupMsg.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2008 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: assistantPopupMsg.h,v $ $Revision: 1.4 $ $State: Exp $
00007 *********************************************************************/
00008 
00009 #ifndef assistantPopupMsg_H_
00010 #define assistantPopupMsg_H_
00011 
00015 
00016 #include <vlutil/vlPrint.h>
00017 
00018 #include "assistantMsg.h"
00019 #include "netAssistantPopupMsg.h"
00020 
00021 class DtAssistantPopupMsg;
00022 class DtRtiAssistantServer;
00023 class DtRtiAssistantPeer;
00024 class DtAssistantMsgQueue;
00025 
00026 typedef void (*DtAssistantPopupCb)(const DtAssistantPopupMsg& inter, void* usr);
00027 
00028 
00033 class DT_DLL_ASSISTANT DtAssistantPopupMsg : public DtAssistantMsg
00034 {
00035 
00036 public:
00037 
00039    DtAssistantPopupMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00040 
00041    DtAssistantPopupMsg(const DtNetAssistantPopupMsg* netRep,
00042       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00043 
00044    DtAssistantPopupMsg( const MAKRti::DtString& text, const MAKRti::DtString& advancedText,      
00045       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
00046 
00048    virtual ~DtAssistantPopupMsg();
00049 
00051    virtual DtAssistantMsg* clone(bool copy = true) const; 
00052 
00054    virtual MAKRti::DtString text() const;
00055 
00057    virtual MAKRti::DtString advancedText() const;
00058 
00060    virtual void printData() const;
00061 
00063    virtual void set(const MAKRti::DtString& text, const MAKRti::DtString& advanced);
00064 
00065 
00066 protected:
00068    virtual void setAdvancedText(const MAKRti::DtString& advanced);
00069 
00071    virtual void setText(const MAKRti::DtString& name);
00072 
00073 
00074 public:
00075 
00077    static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
00078       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00079 
00080    static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00081 
00084    static void addCallback(DtRtiAssistantServer* conn, DtAssistantPopupCb cb, void* usr);
00085    static void removeCallback(DtRtiAssistantServer* conn, DtAssistantPopupCb cb, void* usr);
00086 
00089    static void addCallback(DtRtiAssistantPeer* conn, DtAssistantPopupCb cb, void* usr);
00090    static void removeCallback(DtRtiAssistantPeer* conn, DtAssistantPopupCb cb, void* usr);
00091 
00094    static void addCallback(DtAssistantMsgQueue* queue, DtAssistantPopupCb cb, void* usr);
00095    static void removeCallback(DtAssistantMsgQueue* queue, DtAssistantPopupCb cb, void* usr);
00096 
00097 protected:
00098 
00100    virtual DtNetAssistantPopupMsg* netAssistantPopupMsg();
00101    virtual const DtNetAssistantPopupMsg* netAssistantPopupMsg() const;
00102 
00104    virtual DtAssistantMsgKind internalMsgKind();
00105 
00107    virtual int minSize() const;
00108 
00112    virtual int setMinSize( const MAKRti::DtString& text, const MAKRti::DtString& advanced );
00113 
00115    virtual void setTextSize( unsigned long size );
00116    virtual unsigned long textSize() const;
00117 
00119    virtual void setAdvancedTextSize( unsigned long size );
00120    virtual unsigned long advancedTextSize() const;
00121 
00123    virtual const char* textPtr() const;
00124    virtual char* textPtr();
00125 
00127    virtual const char* advancedTextPtr() const;
00128    virtual char* advancedTextPtr();
00129 
00130 };
00131 
00132 #endif