sc/inc/tablink.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 SC_TABLINK_HXX
  21 #define SC_TABLINK_HXX
  22
  23 #include "scdllapi.h"
  24 #include "refreshtimer.hxx"
  25 #include <sfx2/lnkbase.hxx>
  26
  27 #include <sfx2/objsh.hxx>
  28
  29 class ScDocShell;
  30 struct TableLink_Impl;
  31
  32 class ScTableLink : public ::sfx2::SvBaseLink, public ScRefreshTimer
  33 {
  34 private:
  35     TableLink_Impl* pImpl;
  36     OUString aFileName;
  37     OUString aFilterName;
  38     OUString aOptions;
  39     bool bInCreate:1;
  40     bool bInEdit:1;
  41     bool bAddUndo:1;
  42     bool bDoPaint:1;
  43
  44 public:
  45     TYPEINFO();
  46     ScTableLink( ScDocShell* pDocSh, const String& rFile,
  47                     const String& rFilter, const String& rOpt, sal_uLong nRefresh );
  48     ScTableLink( SfxObjectShell* pShell, const String& rFile,
  49                     const String& rFilter, const String& rOpt, sal_uLong nRefresh );
  50     virtual ~ScTableLink();
  51     virtual void Closed();
  52     virtual ::sfx2::SvBaseLink::UpdateResult DataChanged(
  53         const String& rMimeType, const ::com::sun::star::uno::Any & rValue );
  54
  55     virtual void    Edit( Window*, const Link& rEndEditHdl );
  56
  57     sal_Bool    Refresh(const String& rNewFile, const String& rNewFilter,
  58                     const String* pNewOptions /* = NULL */, sal_uLong nNewRefresh );
  59     void    SetInCreate(bool bSet)      { bInCreate = bSet; }
  60     void    SetAddUndo(bool bSet)       { bAddUndo = bSet; }
  61     void    SetPaint(bool bSet)         { bDoPaint = bSet; }
  62
  63     const OUString& GetFileName() const   { return aFileName; }
  64     const OUString& GetFilterName() const { return aFilterName; }
  65     const OUString& GetOptions() const    { return aOptions; }
  66
  67     sal_Bool    IsUsed() const;
  68
  69     DECL_LINK( RefreshHdl, void* );
  70     DECL_LINK( TableEndEditHdl, ::sfx2::SvBaseLink* );
  71 };
  72
  73 class ScDocument;
  74 class SfxMedium;
  75 class SfxFilter;
  76
  77 class SC_DLLPUBLIC ScDocumentLoader
  78 {
  79 private:
  80     ScDocShell*         pDocShell;
  81     SfxObjectShellRef   aRef;
  82     SfxMedium*          pMedium;
  83
  84     static bool         GetFilterName( const String& rFileName,
  85                                        String& rFilter, String& rOptions,
  86                                        bool bWithContent, bool bWithInteraction );
  87
  88 public:
  89                         ScDocumentLoader( const OUString& rFileName,
  90                                           OUString& rFilterName, OUString& rOptions,
  91                                           sal_uInt32 nRekCnt = 0, bool bWithInteraction = false );
  92                         ~ScDocumentLoader();
  93     ScDocument*         GetDocument();
  94     ScDocShell*         GetDocShell()       { return pDocShell; }
  95     bool                IsError() const;
  96     OUString       GetTitle() const;
  97
  98     void                ReleaseDocRef();    // without calling DoClose
  99
 100     /** Create SfxMedium for stream read with SfxFilter and filter options set
 101         at the medium's SfxItemSet.
 102      */
 103     static SfxMedium*   CreateMedium( const OUString& rFileName, const SfxFilter* pFilter, const OUString& rOptions );
 104
 105     static OUString     GetOptions( SfxMedium& rMedium );
 106
 107     /** Returns the filter name and options from a file name.
 108         @param bWithContent
 109             true = Tries to detect the filter by looking at the file contents.
 110             false = Detects filter by file name extension only (should be used in filter code only).
 111         @return sal_True if a filter could be found, sal_False otherwise. */
 112
 113     static bool         GetFilterName( const OUString& rFileName,
 114                                        OUString& rFilter, OUString& rOptions,
 115                                        bool bWithContent, bool bWithInteraction );
 116
 117     static void         RemoveAppPrefix( OUString& rFilterName );
 118 };
 119
 120 #endif
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */