automation/source/inc/cmdbasestream.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: cmdbasestream.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 /*************************************************************************
  32  *
  33  *        ATTENTION
  34  *        This file is intended to work inside and outside the StarOffice environment.
  35  *        Only adaption of file commtypes.hxx should be necessary. Else it is a bug!
  36  *
  37  ************************************************************************/
  38
  39 #ifndef _CMDBASESTREAM_HXX_
  40 #define _CMDBASESTREAM_HXX_
  41
  42 #include <automation/commtypes.hxx>
  43 #include "icommstream.hxx"
  44
  45 class CmdBaseStream
  46 {
  47 protected:
  48     ICommStream* pCommStream;
  49     CmdBaseStream();
  50     virtual ~CmdBaseStream();
  51
  52 public:
  53
  54     void GenError( SmartId *pUId, comm_String *pString );
  55
  56     void GenReturn( comm_USHORT nRet, comm_ULONG nNr );
  57     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_ULONG nNr );
  58     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_String *pString );
  59     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_BOOL bBool );
  60     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_ULONG nNr, comm_String *pString, comm_BOOL bBool );
  61
  62 // MacroRecorder
  63     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_USHORT nMethod );
  64     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_USHORT nMethod, comm_String *pString );
  65     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_USHORT nMethod, comm_String *pString, comm_BOOL bBool );
  66     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_USHORT nMethod, comm_BOOL bBool );
  67     void GenReturn( comm_USHORT nRet, SmartId *pUId, comm_USHORT nMethod, comm_ULONG nNr );
  68
  69     void Read ( comm_USHORT &nNr );
  70     void Read ( comm_ULONG &nNr );
  71     void Read (comm_UniChar* &aString, comm_USHORT &nLenInChars );
  72     void Read ( comm_BOOL &bBool );
  73     comm_USHORT GetNextType();
  74
  75     void Write( comm_USHORT nNr );
  76     void Write( comm_ULONG nNr );
  77     void Write( const comm_UniChar* aString, comm_USHORT nLenInChars );
  78     void Write( comm_BOOL bBool );
  79
  80 // Complex Datatypes to be handled system dependent
  81     virtual void Read ( comm_String *&pString );
  82     virtual void Read ( SmartId* &pId );
  83
  84     virtual void Write( comm_String *pString );
  85     virtual void Write( SmartId* pId );
  86 };
  87
  88 #endif