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