offapi/com/sun/star/ucb/XSimpleFileAccess3.idl

   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
  21 module com { module sun { module star { module ucb {
  22
  23 /** This is an extension to the interface XSimpleFileAccess2.
  24
  25     @since OOo 1.1.2
  26 */
  27 published interface XSimpleFileAccess3 : com::sun::star::ucb::XSimpleFileAccess2
  28 {
  29     /** Checks if a file is "hidden"
  30
  31         @param FileURL
  32         URL to be checked
  33
  34         @return
  35         true, if the given File is "hidden", false otherwise
  36     */
  37     boolean isHidden( [in] string FileURL )
  38         raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
  39
  40     /** Sets the "hidden" of a file according to the boolean parameter,
  41         if the actual process has the right to do so and the used
  42         operation system supports this operation.
  43
  44         @param FileURL
  45             URL of the file
  46
  47         @param bHidden
  48         true; "hidden" flag will be set, false; "hidden" flag will be reset
  49     */
  50     void setHidden( [in] string FileURL, [in] boolean bHidden )
  51         raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
  52
  53 };
  54
  55
  56 }; }; }; };
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */