include/vcl/fltcall.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 _FLTCALL_HXX
  21 #define _FLTCALL_HXX
  22 #include <sal/types.h>
  23 #include <vcl/field.hxx>
  24 #include <com/sun/star/uno/Sequence.h>
  25 #include <com/sun/star/beans/PropertyValue.hpp>
  26 #include <vcl/FilterConfigItem.hxx>
  27
  28 class FilterConfigItem;
  29 class SvStream;
  30 class Graphic;
  31 class Window;
  32
  33 struct FltCallDialogParameter
  34 {
  35
  36     Window*     pWindow;
  37     ResMgr*     pResMgr;
  38     FieldUnit   eFieldUnit;
  39     String      aFilterExt;
  40
  41     // In and Out PropertySequence for all filter dialogs
  42     ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > aFilterData;
  43
  44     FltCallDialogParameter( Window* pW, ResMgr* pRsMgr, FieldUnit eFiUni ) :
  45         pWindow         ( pW ),
  46         pResMgr         ( pRsMgr ),
  47         eFieldUnit      ( eFiUni ) {};
  48 };
  49
  50 typedef sal_Bool (*PFilterCall)(SvStream & rStream, Graphic & rGraphic,
  51                                 FilterConfigItem* pConfigItem, sal_Bool bPrefDialog);
  52     // Of this type are both export-filter and import-filter functions
  53     // rFileName is the complete path to the file to be imported or exported
  54     // pCallBack can be NULL. pCallerData is handed to the callback function
  55     // pOptionsConfig can be NULL; if not, the group of the config is already set
  56     // and may not be changed by this filter!
  57     // If bPrefDialog==sal_True, a Preferences-Dialog might be called
  58
  59 typedef sal_Bool ( *PFilterDlgCall )( FltCallDialogParameter& );
  60     // Of this type are both export-filter and import-filter functions
  61     // hands a pointer to the parent window and to the options config
  62     // pOptions and pWindow can be NULL; in this case sal_False is returned,
  63     // otherwise the group of the config is already set
  64     // and may not be changed by this filter!
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */