From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/ucb/HelpContent.idl | 171 ++++++++++++++++++++++++++++++++ 1 file changed, 171 insertions(+) create mode 100644 offapi/com/sun/star/ucb/HelpContent.idl (limited to 'offapi/com/sun/star/ucb/HelpContent.idl') diff --git a/offapi/com/sun/star/ucb/HelpContent.idl b/offapi/com/sun/star/ucb/HelpContent.idl new file mode 100644 index 000000000..7047c61dd --- /dev/null +++ b/offapi/com/sun/star/ucb/HelpContent.idl @@ -0,0 +1,171 @@ +/* -*- 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_HelpContent_idl__ +#define __com_sun_star_ucb_HelpContent_idl__ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + + +module com { module sun { module star { module ucb { + +/** A Help Content represents either a directory object allowing access to a + search engine and to index information for the respective module, or an + object allowing access to the concrete written help content. + + @see com::sun::star::ucb::HelpContentProvider +*/ +published service HelpContent +{ + /** 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. + +

+ + Supported Commands + +

    +
  • + getCommandInfo +
    • +
  • + getPropertySetInfo +
    • +
  • + getPropertyValues +
    • +
  • + setPropertyValues +
    • +
  • + open +
    • +
+ + Supported Properties +
    +
  • + string ContentType ( read-only, + ""application/vnd.sun.star.help" ) +
    • +
  • + boolean IsReadOnly ( read-only, always "true" ) +
    • +
  • + boolean IsDocument ( read-only ) +
    • +
  • + boolean IsFolder ( read-only ) +
    • +
  • + string Title ( read-only, content title ) +
    • +
  • + string MediaType ( read only, either "image/gif", "text/plain", + "text/html" or "text/css" ) +
    • +
  • + sequence<string> KeywordList ( read-only, only if IsFolder is true, + contains the index ) +
    • +
  • + sequence<sequence<string>> KeywordRef ( read-only, only if IsFolder is true, + contains the links belonging to the index ) +
    • +
  • + sequence<sequence<string>> KeywordAnchorForRef ( read-only, only if IsFolder is true, + contains the anchor names belonging to the index ) +
    • +
  • + sequence<sequence<string>> KeywordTitleForRef ( read-only, , only if IsFolder is true, + contains the titles of the documents in which the keywords are found. ) +
    • +
  • + sequence<string> SearchScopes ( read only, , only if IsFolder is true, + contains the scopes in which to search ). +
    • +
  • + string AnchorName ( readonly, only if content is has media type "text/html". +
    • +
+ +

+ */ + 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