From 940b4d1848e8c70ab7642901a68594e8016caffc Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 27 Apr 2024 18:51:28 +0200 Subject: Adding upstream version 1:7.0.4. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/ucb/FileContent.idl | 220 ++++++++++++++++++++++++++++++++ 1 file changed, 220 insertions(+) create mode 100644 offapi/com/sun/star/ucb/FileContent.idl (limited to 'offapi/com/sun/star/ucb/FileContent.idl') diff --git a/offapi/com/sun/star/ucb/FileContent.idl b/offapi/com/sun/star/ucb/FileContent.idl new file mode 100644 index 000000000..89eda3997 --- /dev/null +++ b/offapi/com/sun/star/ucb/FileContent.idl @@ -0,0 +1,220 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_ucb_FileContent_idl__ +#define __com_sun_star_ucb_FileContent_idl__ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + + +module com { module sun { module star { module ucb { + +/** A File Content represents either a directory or a file in the local file + system. + +

Whether a content represents a folder or a file can be determined by + inspecting its property IsFolder or IsDocument. + + @see com::sun::star::ucb::FileContentProvider +*/ +published service FileContent +{ + /** This interface is implemented according to the specification of + service Content. + */ + interface com::sun::star::lang::XComponent; + + /** This interface is implemented according to the specification of + service Content. + */ + interface com::sun::star::ucb::XContent; + + /** This interface is implemented according to the specification of + service Content. + +

An object representing a directory in the file system is able + to create a new object, which in turn can become the representation + of a physical file/directory being contained in the initial directory. + The precise way is the following: + +

+ +

    +
  1. + Let the parent folder create a new content by calling + XContentCreator::createNewContent() on it. The content + type to use for new directories is + "application/vnd.sun.staroffice.fsys-folder". To create a new file + use the type "application/vnd.sun.staroffice.fsys-file". + As return value you get a new file content object. +
    2. +
  2. + Set a title at the new object by letting it execute + the command "setPropertyValues", which sets at least the property + "Title" to a non-empty value ). +
    3. +
  3. + Let the new object ( not the parent! ) execute the command "insert". + This will create the corresponding physical file or directory. + For files, you need to supply the implementation of + a com::sun::star::io::XInputStream with the + command's parameters, that provides access to the stream data. +
    4. +
+ +

+ */ + interface com::sun::star::ucb::XContentCreator; + + /** This interface is implemented according to the specification of + service Content. + +

+ + Supported Commands + +

    +
  • + getCommandInfo +
    • +
  • + getPropertySetInfo +
    • +
  • + getPropertyValues +
    • +
  • + setPropertyValues +
    • +
  • + insert ( makes a newly created document persistent ) +
    • +
  • + delete +
    • +
  • + open +
    • +
  • + transfer +
    • +
+ + Supported Properties +
    +
  • + string ContentType ( read-only, either + "application/vnd.sun.staroffice.fsys-folder" or + "application/vnd.sun.staroffice.fsys-file" ) +
    • +
  • + boolean IsDocument ( read-only, always `TRUE` for files, always + `FALSE` for directories ) +
    • +
  • + boolean IsFolder ( read-only ), always `FALSE` for files, always + `TRUE` for directories ) +
    • +
  • + com::sun::star::util::DateTime DateModified ( read-only ) +
    • +
  • + boolean IsReadOnly ( read-only attribute ) +
    • +
  • + hyper Size ( file size ) +
    • +
  • + string Title ( file name ) +
    • +
  • + boolean IsVolume ( read-only ) +
    • +
  • + boolean IsRemoveable ( read-only ) +
    • +
  • + boolean IsRemote ( read-only ) +
    • +
  • + boolean IsCompactDisc ( read-only ) +
    • +
  • + boolean IsFloppy ( read-only ) +
    • +
  • + boolean IsHidden ( read-only ) +
    • +
+ +

+ */ + interface com::sun::star::ucb::XCommandProcessor; + + /** is an enhanced version of XCommandProcessor that has an + additional method for releasing command identifiers obtained via + XCommandProcessor::createCommandIdentifier() to avoid + resource leaks. For a detailed description of the problem refer to + XCommandProcessor2::releaseCommandIdentifier(). + +

Where many existing Content implementations do not + (yet), every new implementation should support this interface. + */ + [optional] interface com::sun::star::ucb::XCommandProcessor2; + + /** This interface is implemented according to the specification of + service Content. + */ + interface com::sun::star::beans::XPropertiesChangeNotifier; + + /** This interface is implemented according to the specification of + service Content. + */ + interface com::sun::star::beans::XPropertyContainer; + + /** This interface is implemented according to the specification of + service Content. + */ + interface com::sun::star::beans::XPropertySetInfoChangeNotifier; + + /** This interface is implemented according to the specification of + service Content. + */ + interface com::sun::star::ucb::XCommandInfoChangeNotifier; + + /** This interface is implemented according to the specification of + service Content. + */ + interface com::sun::star::container::XChild; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3