extensions/source/scanner/scanner.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: scanner.hxx,v $
  10  * $Revision: 1.7 $
  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 #ifndef _EXT_SCANNER_HXX
  32 #define _EXT_SCANNER_HXX
  33
  34 #include <tools/stream.hxx>
  35 #include <vos/mutex.hxx>
  36 #ifndef __RTL_USTRING_HXX_
  37 #include <rtl/ustring.hxx>
  38 #endif
  39 #include <cppuhelper/weak.hxx>
  40 #include <cppuhelper/weak.hxx>
  41 #include <com/sun/star/uno/Reference.h>
  42 #include <com/sun/star/uno/Sequence.h>
  43 #ifndef __COM_SUN_STAR_AWT_XBITMAP_HPP
  44 #include <com/sun/star/awt/XBitmap.hpp>
  45 #endif
  46 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  47 #include <com/sun/star/lang/XEventListener.hpp>
  48 #ifndef __COM_SUN_STAR_LANG_EVENTOBJECT_HPP
  49 #include <com/sun/star/lang/EventObject.hpp>
  50 #endif
  51 #include <com/sun/star/scanner/XScannerManager.hpp>
  52 #include <com/sun/star/scanner/ScannerException.hpp>
  53
  54 using namespace rtl;
  55 using namespace cppu;
  56 using namespace com::sun::star::uno;
  57 using namespace com::sun::star::scanner;
  58
  59 // -----------
  60 // - Defines -
  61 // -----------
  62
  63 #define REF( _def_Obj )                                         Reference< _def_Obj >
  64 #define SEQ( _def_Obj )                                         Sequence< _def_Obj >
  65 #define ANY                                                                     Any
  66 #define AWT                                                                     com::sun::star::awt
  67
  68 // ------------------
  69 // - ScannerManager -
  70 // ------------------
  71
  72 class ScannerManager : public OWeakObject, XScannerManager, AWT::XBitmap
  73 {
  74 protected:
  75
  76     vos::OMutex                                                         maProtector;
  77     void*                                                                       mpData;
  78
  79     void                                                                        DestroyData();
  80
  81 public:
  82
  83                                             ScannerManager();
  84     virtual                                                                     ~ScannerManager();
  85
  86     // XInterface
  87     virtual ANY SAL_CALL                                        queryInterface( const Type & rType ) throw( RuntimeException );
  88     virtual void SAL_CALL                                       acquire() throw();
  89     virtual void SAL_CALL                                       release() throw();
  90
  91     // XScannerManager
  92     virtual SEQ( ScannerContext ) SAL_CALL      getAvailableScanners() throw();
  93     virtual BOOL SAL_CALL                                       configureScanner( ScannerContext& scanner_context ) throw( ScannerException );
  94     virtual void SAL_CALL                                       startScan( const ScannerContext& scanner_context, const REF( com::sun::star::lang::XEventListener )& rxListener ) throw( ScannerException );
  95     virtual ScanError SAL_CALL                          getError( const ScannerContext& scanner_context ) throw( ScannerException );
  96     virtual REF( AWT::XBitmap ) SAL_CALL        getBitmap( const ScannerContext& scanner_context ) throw( ScannerException );
  97
  98     // XBitmap
  99     virtual AWT::Size SAL_CALL                          getSize() throw();
 100     virtual SEQ( sal_Int8 ) SAL_CALL            getDIB() throw();
 101     virtual SEQ( sal_Int8 ) SAL_CALL            getMaskDIB() throw();
 102
 103     // Misc
 104     static OUString                                             getImplementationName_Static() throw();
 105     static Sequence< OUString >                         getSupportedServiceNames_Static() throw();
 106
 107     void                                                                        Lock() { maProtector.acquire(); }
 108     void                                                                        Unlock() { maProtector.release(); }
 109
 110     void*                                                                       GetData() const { return mpData; }
 111     void                                                                        SetData( void* pData ) { DestroyData(); mpData = pData; }
 112 };
 113
 114 // -----------------------------------------------------------------------------
 115
 116 REF( XInterface ) SAL_CALL ScannerManager_CreateInstance( const REF( com::sun::star::lang::XMultiServiceFactory )& rxFactory ) throw( Exception );
 117
 118 #endif