binfilter/inc/bf_svtools/fltcall.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: fltcall.hxx,v $
  10  * $Revision: 1.3 $
  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 _FLTCALL_HXX
  32 #define _FLTCALL_HXX
  33 #ifndef _GEN_HXX
  34 #include <tools/gen.hxx>
  35 #endif
  36 #include <vcl/field.hxx>
  37
  38 #ifndef _COM_SUN_STAR_UNO_SEQUENCE_H_
  39 #include <com/sun/star/uno/Sequence.h>
  40 #endif
  41 #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_
  42 #include <com/sun/star/beans/PropertyValue.hpp>
  43 #endif
  44 #ifndef _FILTER_CONFIG_ITEM_HXX_
  45 #include <bf_svtools/FilterConfigItem.hxx>
  46 #endif
  47
  48 class FilterConfigItem;
  49 class SvStream;
  50 class Graphic;
  51 class Window;
  52
  53 namespace binfilter
  54 {
  55
  56 struct FltCallDialogParameter
  57 {
  58
  59         Window*         pWindow;
  60         ResMgr*         pResMgr;
  61         FieldUnit       eFieldUnit;
  62         String          aFilterExt;
  63
  64         // In and Out PropertySequence for all filter dialogs
  65         ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > aFilterData;
  66
  67         FltCallDialogParameter( Window* pW, ResMgr* pRsMgr, FieldUnit eFiUni ) :
  68                 pWindow                 ( pW ),
  69                 pResMgr                 ( pRsMgr ),
  70                 eFieldUnit              ( eFiUni ) {};
  71 };
  72
  73 typedef BOOL (*PFilterCall)(SvStream & rStream, Graphic & rGraphic,
  74                                                                 FilterConfigItem* pConfigItem, sal_Bool bPrefDialog);
  75         // Von diesem Typ sind sowohl Export-Filter-Funktionen als auch Import-Filter-Funktionen.
  76         // rFileName ist der komplette Pfadname der zu importierenden bzw. zu exportierenden Datei.
  77         // pCallBack darf auch NULL sein. pCallerData wird der Callback-Funktion uebergeben.
  78         // pOptionsConfig darf NULL sein. Anderenfalls ist die Gruppe des Config schon gesetzt
  79         // und darf von dem Filter nicht geaendert werden!
  80         // Wenn bPrefDialog==TRUE gilt, wird ggf. ein Preferences-Dialog durchgefuehrt.
  81
  82 typedef BOOL ( *PFilterDlgCall )( FltCallDialogParameter& );
  83         // Von diesem Typ sind sowohl Export-Filter-Funktionen als auch Import-Filter-Funktionen.
  84         // Uebergeben wird ein Pointer auf ein Parent-Fenster und auf die Options-Config.
  85         // pOptions und pWindow duerfen NULL sein, in diesem Fall wird FALSE zurueckgeliefert.
  86         // Anderenfalls ist die Gruppe der Config schon gesetzt
  87         // und darf von dem Filter nicht geaendert werden!
  88
  89 }
  90
  91 #endif