vcl/inc/salobj.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_INC_SALOBJ_HXX
  21 #define INCLUDED_VCL_INC_SALOBJ_HXX
  22
  23 #include <tools/solar.h>
  24 #include <vcl/dllapi.h>
  25 #include <vcl/salgtype.hxx>
  26 #include <salwtype.hxx>
  27
  28 struct SystemEnvData;
  29
  30 // -------------------
  31 // - SalObject-Types -
  32 // -------------------
  33
  34 #define SAL_OBJECT_CLIP_INCLUDERECTS            ((sal_uInt16)0x0001)
  35 #define SAL_OBJECT_CLIP_EXCLUDERECTS            ((sal_uInt16)0x0002)
  36 #define SAL_OBJECT_CLIP_ABSOLUTE                ((sal_uInt16)0x0004)
  37
  38 class VCL_PLUGIN_PUBLIC SalObject
  39 {
  40     void*               m_pInst;
  41     SALOBJECTPROC       m_pCallback;
  42     sal_Bool                m_bMouseTransparent:1,
  43                         m_bEraseBackground:1;
  44 public:
  45     SalObject() : m_pInst( NULL ), m_pCallback( NULL ), m_bMouseTransparent( sal_False ), m_bEraseBackground( sal_True ) {}
  46     virtual ~SalObject();
  47
  48     virtual void                    ResetClipRegion() = 0;
  49     virtual sal_uInt16                  GetClipRegionType() = 0;
  50     virtual void                    BeginSetClipRegion( sal_uLong nRects ) = 0;
  51     virtual void                    UnionClipRegion( long nX, long nY, long nWidth, long nHeight ) = 0;
  52     virtual void                    EndSetClipRegion() = 0;
  53
  54     virtual void                    SetPosSize( long nX, long nY, long nWidth, long nHeight ) = 0;
  55     virtual void                    Show( sal_Bool bVisible ) = 0;
  56     virtual void                    Enable( sal_Bool /* nEnable */ ) {}
  57     virtual void                    GrabFocus() {}
  58
  59     virtual void                    SetBackground() {}
  60     virtual void                    SetBackground( SalColor /* nSalColor */ ) {}
  61
  62     virtual void                    SetForwardKey( sal_Bool /* bEnable */ ) {}
  63
  64     virtual const SystemEnvData*    GetSystemData() const = 0;
  65
  66     void                    SetCallback( void* pInst, SALOBJECTPROC pProc )
  67     { m_pInst = pInst; m_pCallback = pProc; }
  68     long                    CallCallback( sal_uInt16 nEvent, const void* pEvent )
  69     { return m_pCallback ? m_pCallback( m_pInst, this, nEvent, pEvent ) : 0; }
  70     void                    SetMouseTransparent( sal_Bool bMouseTransparent )
  71     { m_bMouseTransparent = bMouseTransparent; }
  72     sal_Bool                    IsMouseTransparent()
  73     { return m_bMouseTransparent; }
  74     void                    EnableEraseBackground( sal_Bool bEnable )
  75     { m_bEraseBackground = bEnable; }
  76     sal_Bool                    IsEraseBackgroundEnabled()
  77     { return m_bEraseBackground; }
  78 };
  79
  80 #endif // INCLUDED_VCL_INC_SALOBJ_HXX
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */