sw/inc/swunohelper.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 #ifndef _SWUNOHELPER_HXX
  20 #define _SWUNOHELPER_HXX
  21
  22 #include <tools/solar.h>
  23 #include <sal/types.h>
  24 #include "swdllapi.h"
  25
  26 #include <vector>
  27
  28 namespace com { namespace sun { namespace star {
  29     namespace uno {
  30         class Any;
  31     }
  32 }}}
  33
  34 class String;
  35 class DateTime;
  36
  37 namespace SWUnoHelper {
  38
  39 // calls over the compherl the getEnumAsInt32 function and handle the
  40 // exceptions.
  41 sal_Int32 GetEnumAsInt32( const com::sun::star::uno::Any& rVal );
  42
  43
  44 // methods for UCB actions:
  45     // delete the file under this URL
  46 SW_DLLPUBLIC sal_Bool UCB_DeleteFile( const String& rURL );
  47
  48     // copy/move the file to a new location
  49 sal_Bool UCB_CopyFile( const String& rURL, const String& rNewURL,
  50                     sal_Bool bCopyIsMove = sal_False );
  51
  52     // is the URL on the current system case sentive?
  53 SW_DLLPUBLIC sal_Bool UCB_IsCaseSensitiveFileName( const String& rURL );
  54
  55     // is the URL readonly?
  56 SW_DLLPUBLIC sal_Bool UCB_IsReadOnlyFileName( const String& rURL );
  57
  58     // get a list of files from the folder of the URL
  59     // options: pExtension = 0 -> all, else this specific extension
  60     //          pDateTime != 0 -> returns also the modified date/time of
  61     //                       the files in a vector -->
  62     //                       !! objects must be deleted from the caller!!
  63 bool UCB_GetFileListOfFolder( const String& rURL,
  64                                 std::vector<String*>& rList,
  65                                 const String* pExtension = 0,
  66                                 std::vector<DateTime*>* pDateTimeList = 0 );
  67
  68     // is the URL an existing file?
  69 SW_DLLPUBLIC sal_Bool UCB_IsFile( const String& rURL );
  70
  71     // is the URL a existing directory?
  72 sal_Bool UCB_IsDirectory( const String& rURL );
  73 }
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */