XSmartTagAction.idl

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


module com {  module sun {  module star {  module smarttags {


interface XSmartTagAction: com::sun::star::lang::XInitialization
{
    string getName( [in] ::com::sun::star::lang::Locale aLocale );


    string getDescription( [in] ::com::sun::star::lang::Locale aLocale );


    [attribute, readonly] long SmartTagCount;


    string getSmartTagName( [in] long nSmartTagIndex)
        raises( com::sun::star::lang::IndexOutOfBoundsException );


    string getSmartTagCaption( [in] long nSmartTagIndex,
                               [in] ::com::sun::star::lang::Locale aLocale)
        raises( com::sun::star::lang::IndexOutOfBoundsException );


    long getActionCount( [in] string aSmartTagName,
                         [in] com::sun::star::frame::XController xController,
                         [in] com::sun::star::container::XStringKeyMap xProperties);

    long getActionID( [in] string aSmartTagName, [in] long nActionIndex,
                      [in] com::sun::star::frame::XController xController )
        raises( com::sun::star::lang::IllegalArgumentException );


    string getActionCaptionFromID( [in] long nActionID,
                                   [in] string aApplicationName,
                                   [in] ::com::sun::star::lang::Locale aLocale,
                                   [in] com::sun::star::container::XStringKeyMap xProperties,
                                   [in] string aText,
                                   [in] string aXML,
                                   [in] com::sun::star::frame::XController xController,
                                   [in] com::sun::star::text::XTextRange xTarget )
        raises( com::sun::star::lang::IllegalArgumentException );


    string getActionNameFromID( [in] long nActionID,
                                [in] com::sun::star::frame::XController xController)
        raises( com::sun::star::lang::IllegalArgumentException );


    void invokeAction( [in] long nActionID,
                       [in] string aApplicationName,
                       [in] com::sun::star::frame::XController xController,
                       [in] com::sun::star::text::XTextRange xTarget,
                       [in] com::sun::star::container::XStringKeyMap xProperties,
                       [in] string aText,
                       [in] string aXML,
                       [in] ::com::sun::star::lang::Locale aLocale )
        raises( com::sun::star::lang::IllegalArgumentException );


    boolean isCaptionDynamic( [in] long nActionID,
                              [in] string aApplicationName,
                              [in] com::sun::star::frame::XController xController,
                              [in] ::com::sun::star::lang::Locale aLocale )
        raises( com::sun::star::lang::IllegalArgumentException );


    boolean isShowSmartTagIndicator( [in] long nActionID,
                                     [in] string aApplicationName,
                                     [in] com::sun::star::frame::XController xController,
                                     [in] ::com::sun::star::lang::Locale aLocale )
        raises( com::sun::star::lang::IllegalArgumentException );
};

}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */