summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/smarttags/XSmartTagAction.idl
blob: b8f2794402b8fd65d45f63963d8af0fbfe1ce4d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSmartTagAction.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: hr $ $Date: 2007-01-02 16:56:23 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    Initial Contributer was Fabalabs Software GmbH, Jakob Lechner
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_smarttags_XSmartTagAction_idl__
#define __com_sun_star_smarttags_XSmartTagAction_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_uno_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif
#ifndef __com_sun_star_text_XTextRange_idl__
#include <com/sun/star/text/XTextRange.idl>
#endif
#ifndef __com_sun_star_frame_XController_idl__
#include <com/sun/star/frame/XController.idl>
#endif


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


  interface XSmartTagAction: com::sun::star::uno::XInterface
  {
    /**
       Function: getName

       @return Name of the smarttag action library
    */
    string getName();

    /**
       Function: getDescription

       @return Description of the smarttag action library
    */
    string getDescription();

    /**
       Function: getSmartTagCount

       @return Number of available smarttags in this action library
    */
    long getSmartTagCount();

    /**
       Function: getSmartTagName

       @param sal_Int32 nSmartTagIndex
       Index of the wanted smarttag. Value needs to
       be between 0 and the number of smarttags available (exclusively).

       @return Returns the name of one specific smarttag in this
       action library. This is needed for associating the actions with the corresponding
       recognizer.
    */
    string getSmartTagName([in] long nSmartTagIndex);

    /**
       Function: getSmartTagCaption

       @param sal_Int32 nSmartTagIndex
       Index of the wanted smarttag. Value needs to
       be between 0 and the number of smarttags available (exclusively).

       @return Returns the caption of one specific smarttag in this
       action library.
    */
    string getSmartTagCaption([in] long nSmartTagIndex,
                  [in] com::sun::star::frame::XController xController);

  /**
     Function: getActionCount

     @param sal_Int32 nSmartTagIndex
     Index of the wanted smarttag. Value needs to
     be between 0 and the number of smarttags available (exclusively).

     @return Returns the number of available actions of one specific smarttag in this
     action library
  */
    long getActionCount([in] long nSmartTagIndex,
              [in] com::sun::star::frame::XController xController);

    /**
       Function: getActionCaption

       @param sal_Int32 nSmartTagIndex
       Index of the wanted smarttag. Value needs to
       be between 0 and the number of smarttags available (exclusively).

       @param sal_Int32 nActionIndex
       Index of the wanted action. Value needs to
       be between 0 and the number of actions available for the specified
       smarttag  (exclusively).

       @return Returns the caption of an action for one specific smarttag in this
        action library.
    */
    string getActionCaption([in] long nSmartTagIndex, [in] long nActionIndex,
              [in] com::sun::star::frame::XController xController);

    /**
       Function: invokeAction

       @param sal_Int32 nSmartTagIndex
       Index of the wanted smarttag. Value needs to
       be between 0 and the number of smarttags available (exclusively).

       @param sal_Int32 nActionIndex
       Index of the wanted action. Value needs to
       be between 0 and the number of actions available for the specified
       smarttag  (exclusively).

       @param OUString aWord
       Word that was recognized as actionable.

    */
    void invokeAction([in] long nSmartTagIndex, [in] long nActionIndex, [in] com::sun::star::text::XTextRange xRange,
            [in] com::sun::star::frame::XController xController );

    /** initializes the object.

    <p>It should be called directly after the object is created.
    */
    void initialize( [in] sequence<any> aArguments );

  };

  service SmartTagAction
  {
    // exported interfaces:
    interface XSmartTagAction;
  };


}; }; }; };

#endif