xref: /aoo42x/main/vcl/inc/salobj.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _SV_SALOBJ_HXX
29*cdf0e10cSrcweir #define _SV_SALOBJ_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <vcl/sv.h>
32*cdf0e10cSrcweir #include <vcl/dllapi.h>
33*cdf0e10cSrcweir #include <vcl/salgtype.hxx>
34*cdf0e10cSrcweir #include <salwtype.hxx>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir struct SystemEnvData;
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir // -------------------
39*cdf0e10cSrcweir // - SalObject-Types -
40*cdf0e10cSrcweir // -------------------
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir #define SAL_OBJECT_CLIP_INCLUDERECTS			((sal_uInt16)0x0001)
43*cdf0e10cSrcweir #define SAL_OBJECT_CLIP_EXCLUDERECTS			((sal_uInt16)0x0002)
44*cdf0e10cSrcweir #define SAL_OBJECT_CLIP_ABSOLUTE				((sal_uInt16)0x0004)
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir // -------------
47*cdf0e10cSrcweir // - SalObject -
48*cdf0e10cSrcweir // -------------
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir class VCL_PLUGIN_PUBLIC SalObject
51*cdf0e10cSrcweir {
52*cdf0e10cSrcweir     void*				m_pInst;
53*cdf0e10cSrcweir     SALOBJECTPROC		m_pCallback;
54*cdf0e10cSrcweir     sal_Bool                m_bMouseTransparent:1,
55*cdf0e10cSrcweir                         m_bEraseBackground:1;
56*cdf0e10cSrcweir public:
57*cdf0e10cSrcweir     SalObject() : m_pInst( NULL ), m_pCallback( NULL ), m_bMouseTransparent( sal_False ), m_bEraseBackground( sal_True ) {}
58*cdf0e10cSrcweir     virtual ~SalObject();
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir 	virtual void					ResetClipRegion() = 0;
61*cdf0e10cSrcweir 	virtual sal_uInt16					GetClipRegionType() = 0;
62*cdf0e10cSrcweir 	virtual void					BeginSetClipRegion( sal_uLong nRects ) = 0;
63*cdf0e10cSrcweir 	virtual void					UnionClipRegion( long nX, long nY, long nWidth, long nHeight ) = 0;
64*cdf0e10cSrcweir 	virtual void					EndSetClipRegion() = 0;
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir 	virtual void					SetPosSize( long nX, long nY, long nWidth, long nHeight ) = 0;
67*cdf0e10cSrcweir 	virtual void					Show( sal_Bool bVisible ) = 0;
68*cdf0e10cSrcweir 	virtual void					Enable( sal_Bool nEnable ) = 0;
69*cdf0e10cSrcweir 	virtual void					GrabFocus() = 0;
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir 	virtual void					SetBackground() = 0;
72*cdf0e10cSrcweir 	virtual void					SetBackground( SalColor nSalColor ) = 0;
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir 	virtual const SystemEnvData*	GetSystemData() const = 0;
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir     virtual void InterceptChildWindowKeyDown( sal_Bool bIntercept ) = 0;
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir 	void					SetCallback( void* pInst, SALOBJECTPROC pProc )
79*cdf0e10cSrcweir     { m_pInst = pInst; m_pCallback = pProc; }
80*cdf0e10cSrcweir     long					CallCallback( sal_uInt16 nEvent, const void* pEvent )
81*cdf0e10cSrcweir     { return m_pCallback ? m_pCallback( m_pInst, this, nEvent, pEvent ) : 0; }
82*cdf0e10cSrcweir     void                    SetMouseTransparent( sal_Bool bMouseTransparent )
83*cdf0e10cSrcweir     { m_bMouseTransparent = bMouseTransparent; }
84*cdf0e10cSrcweir     sal_Bool                    IsMouseTransparent()
85*cdf0e10cSrcweir     { return m_bMouseTransparent; }
86*cdf0e10cSrcweir     void                    EnableEraseBackground( sal_Bool bEnable )
87*cdf0e10cSrcweir     { m_bEraseBackground = bEnable; }
88*cdf0e10cSrcweir     sal_Bool                    IsEraseBackgroundEnabled()
89*cdf0e10cSrcweir     { return m_bEraseBackground; }
90*cdf0e10cSrcweir };
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir #endif // _SV_SALOBJ_HXX
93