content.hxx

Go to the documentation of this file.

/* -*- 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 INCLUDED_UCBHELPER_CONTENT_HXX
#define INCLUDED_UCBHELPER_CONTENT_HXX
 
#include <rtl/ref.hxx>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.h>
#include <ucbhelper/ucbhelperdllapi.h>
 
namespace com::sun::star::beans
{
class XPropertySetInfo;
}
 
namespace com::sun::star::io
{
class XActiveDataSink;
class XOutputStream;
class XInputStream;
class XStream;
}
 
namespace com::sun::star::sdbc
{
class XResultSet;
class XRow;
}
 
namespace com::sun::star::ucb
{
class XCommandEnvironment;
class XCommandInfo;
class XContent;
class XDynamicResultSet;
class XAnyCompareFactory;
struct ContentInfo;
struct NumberedSortingInfo;
}
 
namespace com::sun::star::uno
{
class XComponentContext;
}
 
namespace com::sun::star::uno
{
class Any;
}
 
namespace ucbhelper
{
enum ResultSetInclude
{
    INCLUDE_FOLDERS_ONLY,
    INCLUDE_DOCUMENTS_ONLY,
    INCLUDE_FOLDERS_AND_DOCUMENTS
};
 
enum class InsertOperation
{
    Copy, // copy source data
    Move, // move source data
    Checkin // check-in source data
};
 
class Content_Impl;
 
class UCBHELPER_DLLPUBLIC Content final
{
    rtl::Reference<Content_Impl> m_xImpl;
 
    css::uno::Any createCursorAny(const css::uno::Sequence<OUString>& rPropertyNames,
                                  ResultSetInclude eMode);
 
public:
    Content();
 
    Content(const OUString& rURL, const css::uno::Reference<css::ucb::XCommandEnvironment>& rEnv,
            const css::uno::Reference<css::uno::XComponentContext>& rCtx);
    Content(const css::uno::Reference<css::ucb::XContent>& rContent,
            const css::uno::Reference<css::ucb::XCommandEnvironment>& rEnv,
            const css::uno::Reference<css::uno::XComponentContext>& rCtx);
    Content(const Content& rOther);
 
    Content(Content&& rOther) noexcept;
 
    ~Content();
 
    Content& operator=(const Content& rOther);
 
    Content& operator=(Content&& rOther) noexcept;
 
    static bool create(const OUString& rURL,
                       const css::uno::Reference<css::ucb::XCommandEnvironment>& rEnv,
                       const css::uno::Reference<css::uno::XComponentContext>& rCtx,
                       Content& rContent);
 
    // Direct access to UCB content.
 
    css::uno::Reference<css::ucb::XContent> get() const;
 
    // Object identity.
 
    const OUString& getURL() const;
 
    // Command environment.
 
    const css::uno::Reference<css::ucb::XCommandEnvironment>& getCommandEnvironment() const;
 
    void setCommandEnvironment(const css::uno::Reference<css::ucb::XCommandEnvironment>& xNewEnv);
 
    // Access to supported commands/properties.
 
    css::uno::Reference<css::ucb::XCommandInfo> getCommands();
    css::uno::Reference<css::beans::XPropertySetInfo> getProperties();
 
    // Access to property value(s).
 
    css::uno::Any getPropertyValue(const OUString& rPropertyName);
    css::uno::Any setPropertyValue(const OUString& rPropertyName, const css::uno::Any& rValue);
    css::uno::Sequence<css::uno::Any>
    getPropertyValues(const css::uno::Sequence<OUString>& rPropertyNames);
    css::uno::Reference<css::sdbc::XRow>
    getPropertyValuesInterface(const css::uno::Sequence<OUString>& rPropertyNames);
 
    css::uno::Sequence<css::uno::Any>
    setPropertyValues(const css::uno::Sequence<OUString>& rPropertyNames,
                      const css::uno::Sequence<css::uno::Any>& rValues);
 
    // General command execution.
 
    css::uno::Any executeCommand(const OUString& rCommandName,
                                 const css::uno::Any& rCommandArgument);
 
    // Special commands.
 
    css::uno::Reference<css::sdbc::XResultSet>
    createCursor(const css::uno::Sequence<OUString>& rPropertyNames,
                 ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS);
    css::uno::Reference<css::ucb::XDynamicResultSet>
    createDynamicCursor(const css::uno::Sequence<OUString>& rPropertyNames,
                        ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS);
 
    css::uno::Reference<css::sdbc::XResultSet>
    createSortedCursor(const css::uno::Sequence<OUString>& rPropertyNames,
                       const css::uno::Sequence<css::ucb::NumberedSortingInfo>& rSortInfo,
                       const css::uno::Reference<css::ucb::XAnyCompareFactory>& rAnyCompareFactory,
                       ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS);
 
    css::uno::Reference<css::io::XInputStream> openStream();
    css::uno::Reference<css::io::XInputStream> openStreamNoLock();
 
    css::uno::Reference<css::io::XStream> openWriteableStream();
    css::uno::Reference<css::io::XStream> openWriteableStreamNoLock();
 
    bool openStream(const css::uno::Reference<css::io::XActiveDataSink>& rSink);
    bool openStream(const css::uno::Reference<css::io::XOutputStream>& rStream);
    void writeStream(const css::uno::Reference<css::io::XInputStream>& rStream,
                     bool bReplaceExisting);
 
    css::uno::Sequence<css::ucb::ContentInfo> queryCreatableContentsInfo();
 
    bool insertNewContent(const OUString& rContentType,
                          const css::uno::Sequence<OUString>& rPropertyNames,
                          const css::uno::Sequence<css::uno::Any>& rPropertyValues,
                          Content& rNewContent);
    bool insertNewContent(const OUString& rContentType,
                          const css::uno::Sequence<OUString>& rPropertyNames,
                          const css::uno::Sequence<css::uno::Any>& rPropertyValues,
                          const css::uno::Reference<css::io::XInputStream>& rStream,
                          Content& rNewContent);
 
    void transferContent(const Content& rSourceContent, InsertOperation eOperation,
                         const OUString& rTitle, const sal_Int32 nNameClashAction,
                         const OUString& rMimeType = OUString(), bool bMajorVersion = false,
                         const OUString& rCommentVersion = OUString(),
                         OUString* pResultURL = nullptr,
                         const OUString& rDocumentId = OUString()) const;
 
    void lock();
 
    void unlock();
 
    // Required properties.
 
    bool isFolder();
    bool isDocument();
};
 
} /* namespace ucbhelper */
 
#endif /* ! INCLUDED_UCBHELPER_CONTENT_HXX */
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */