1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __offapi_com_sun_star_awt_XItemList_idl__ 25*b1cdbd2cSJim Jagielski#define __offapi_com_sun_star_awt_XItemList_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 28*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/Pair.idl> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//================================================================================================================== 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module awt { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielskipublished interface XItemListListener; 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski//================================================================================================================== 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski/** provides convenient access to the list of items in a list box 39*b1cdbd2cSJim Jagielski */ 40*b1cdbd2cSJim Jagielskipublished interface XItemList 41*b1cdbd2cSJim Jagielski{ 42*b1cdbd2cSJim Jagielski /** is the number of items in the list 43*b1cdbd2cSJim Jagielski */ 44*b1cdbd2cSJim Jagielski [attribute, readonly] long ItemCount; 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski /** inserts a new item into the list 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski @param Position 49*b1cdbd2cSJim Jagielski the position at which the item should be inserted. Must be greater or equal to 0, and 50*b1cdbd2cSJim Jagielski lesser than or equal to <member>ItemCount</member>. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski @param ItemText 53*b1cdbd2cSJim Jagielski the text of the item to be inserted. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski @param ItemImageURL 56*b1cdbd2cSJim Jagielski the URL of the image to display for the item 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 59*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski void insertItem( 62*b1cdbd2cSJim Jagielski [in] long Position, 63*b1cdbd2cSJim Jagielski [in] string ItemText, 64*b1cdbd2cSJim Jagielski [in] string ItemImageURL 65*b1cdbd2cSJim Jagielski ) 66*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski /** inserts an item which has only a text, but no image 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @param Position 71*b1cdbd2cSJim Jagielski the position at which the item should be inserted. Must be greater or equal to 0, and 72*b1cdbd2cSJim Jagielski lesser than or equal to <member>ItemCount</member>. 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @param ItemText 75*b1cdbd2cSJim Jagielski the text of the item to be inserted. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 78*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 79*b1cdbd2cSJim Jagielski */ 80*b1cdbd2cSJim Jagielski void insertItemText( 81*b1cdbd2cSJim Jagielski [in] long Position, 82*b1cdbd2cSJim Jagielski [in] string ItemText 83*b1cdbd2cSJim Jagielski ) 84*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski /** inserts an item which has only an image, but no text 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski @param Position 89*b1cdbd2cSJim Jagielski the position at which the item should be inserted. Must be greater or equal to 0, and 90*b1cdbd2cSJim Jagielski lesser than or equal to <member>ItemCount</member>. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @param ItemImageURL 93*b1cdbd2cSJim Jagielski the URL of the image to display for the item 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 96*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 97*b1cdbd2cSJim Jagielski */ 98*b1cdbd2cSJim Jagielski void insertItemImage( 99*b1cdbd2cSJim Jagielski [in] long Position, 100*b1cdbd2cSJim Jagielski [in] string ItemImageURL 101*b1cdbd2cSJim Jagielski ) 102*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski /** removes an item from the list 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski @param Position 107*b1cdbd2cSJim Jagielski the position of the item which should be removed. Must be greater or equal to 0, and 108*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 111*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 112*b1cdbd2cSJim Jagielski */ 113*b1cdbd2cSJim Jagielski void removeItem( 114*b1cdbd2cSJim Jagielski [in] long Position 115*b1cdbd2cSJim Jagielski ) 116*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski /** removes all items from the list 119*b1cdbd2cSJim Jagielski */ 120*b1cdbd2cSJim Jagielski void removeAllItems(); 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski /** sets a new text for an existing item 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski @param Position 125*b1cdbd2cSJim Jagielski the position of the item whose text is to be changed. Must be greater or equal to 0, and 126*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @param ItemText 129*b1cdbd2cSJim Jagielski the new text of the item 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 132*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 133*b1cdbd2cSJim Jagielski */ 134*b1cdbd2cSJim Jagielski void setItemText( 135*b1cdbd2cSJim Jagielski [in] long Position, 136*b1cdbd2cSJim Jagielski [in] string ItemText 137*b1cdbd2cSJim Jagielski ) 138*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski /** sets a new image for an existing item 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski @param Position 143*b1cdbd2cSJim Jagielski the position of the item whose image is to be changed. Must be greater or equal to 0, and 144*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski @param ItemImageURL 147*b1cdbd2cSJim Jagielski the new URL of the image to display for the item 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 150*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 151*b1cdbd2cSJim Jagielski */ 152*b1cdbd2cSJim Jagielski void setItemImage( 153*b1cdbd2cSJim Jagielski [in] long Position, 154*b1cdbd2cSJim Jagielski [in] string ItemImageURL 155*b1cdbd2cSJim Jagielski ) 156*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 157*b1cdbd2cSJim Jagielski 158*b1cdbd2cSJim Jagielski /** sets both a new position and text for an existing item 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski @param Position 161*b1cdbd2cSJim Jagielski the position of the item whose text and image is to be changed. Must be greater or equal to 0, and 162*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski @param ItemText 165*b1cdbd2cSJim Jagielski the new text of the item 166*b1cdbd2cSJim Jagielski 167*b1cdbd2cSJim Jagielski @param ItemImageURL 168*b1cdbd2cSJim Jagielski the new URL of the image to display for the item 169*b1cdbd2cSJim Jagielski 170*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 171*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 172*b1cdbd2cSJim Jagielski */ 173*b1cdbd2cSJim Jagielski void setItemTextAndImage( 174*b1cdbd2cSJim Jagielski [in] long Position, 175*b1cdbd2cSJim Jagielski [in] string ItemText, 176*b1cdbd2cSJim Jagielski [in] string ItemImageURL 177*b1cdbd2cSJim Jagielski ) 178*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski /** associates an implementation dependend value with the given list item. 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski <p>You can use this to store data for an item which does not interfere with the displayed 183*b1cdbd2cSJim Jagielski text and image, but can be used by the client of the list box for an arbitrary purpose.</p> 184*b1cdbd2cSJim Jagielski 185*b1cdbd2cSJim Jagielski @param Position 186*b1cdbd2cSJim Jagielski the position of the item whose data value should be set. Must be greater or equal to 0, and 187*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 188*b1cdbd2cSJim Jagielski 189*b1cdbd2cSJim Jagielski @param ItemData 190*b1cdbd2cSJim Jagielski the data to associate with the list item 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 193*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 194*b1cdbd2cSJim Jagielski 195*b1cdbd2cSJim Jagielski @see getItemData 196*b1cdbd2cSJim Jagielski */ 197*b1cdbd2cSJim Jagielski void setItemData( 198*b1cdbd2cSJim Jagielski [in] long Position, 199*b1cdbd2cSJim Jagielski [in] any ItemData 200*b1cdbd2cSJim Jagielski ) 201*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 202*b1cdbd2cSJim Jagielski 203*b1cdbd2cSJim Jagielski /** retrieves the text of an existing item 204*b1cdbd2cSJim Jagielski 205*b1cdbd2cSJim Jagielski @param Position 206*b1cdbd2cSJim Jagielski the position of the item whose text should be retrieved. Must be greater or equal to 0, and 207*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 208*b1cdbd2cSJim Jagielski 209*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 210*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 211*b1cdbd2cSJim Jagielski */ 212*b1cdbd2cSJim Jagielski string getItemText( 213*b1cdbd2cSJim Jagielski [in] long Position 214*b1cdbd2cSJim Jagielski ) 215*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 216*b1cdbd2cSJim Jagielski 217*b1cdbd2cSJim Jagielski /** retrieves the URL of the image of an existing item 218*b1cdbd2cSJim Jagielski 219*b1cdbd2cSJim Jagielski @param Position 220*b1cdbd2cSJim Jagielski the position of the item whose image should be retrieved. Must be greater or equal to 0, and 221*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 222*b1cdbd2cSJim Jagielski 223*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 224*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 225*b1cdbd2cSJim Jagielski */ 226*b1cdbd2cSJim Jagielski string getItemImage( 227*b1cdbd2cSJim Jagielski [in] long Position 228*b1cdbd2cSJim Jagielski ) 229*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 230*b1cdbd2cSJim Jagielski 231*b1cdbd2cSJim Jagielski /** retrieves both the text and the image URL of an existing item 232*b1cdbd2cSJim Jagielski 233*b1cdbd2cSJim Jagielski @param Position 234*b1cdbd2cSJim Jagielski the position of the item whose text and image should be retrieved. Must be greater or equal to 0, and 235*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 236*b1cdbd2cSJim Jagielski 237*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 238*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 239*b1cdbd2cSJim Jagielski */ 240*b1cdbd2cSJim Jagielski ::com::sun::star::beans::Pair< string, string > 241*b1cdbd2cSJim Jagielski getItemTextAndImage( 242*b1cdbd2cSJim Jagielski [in] long Position 243*b1cdbd2cSJim Jagielski ) 244*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 245*b1cdbd2cSJim Jagielski 246*b1cdbd2cSJim Jagielski /** retrieves the implementation dependend value associated with the given list item. 247*b1cdbd2cSJim Jagielski @see setItemData 248*b1cdbd2cSJim Jagielski 249*b1cdbd2cSJim Jagielski @param Position 250*b1cdbd2cSJim Jagielski the position of the item whose data value should be retrieved. Must be greater or equal to 0, and 251*b1cdbd2cSJim Jagielski lesser than <member>ItemCount</member>. 252*b1cdbd2cSJim Jagielski 253*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 254*b1cdbd2cSJim Jagielski if <code>Position</code> is invalid. 255*b1cdbd2cSJim Jagielski 256*b1cdbd2cSJim Jagielski @see setItemData 257*b1cdbd2cSJim Jagielski */ 258*b1cdbd2cSJim Jagielski any getItemData( 259*b1cdbd2cSJim Jagielski [in] long Position 260*b1cdbd2cSJim Jagielski ) 261*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 262*b1cdbd2cSJim Jagielski 263*b1cdbd2cSJim Jagielski /** retrieves the texts and images of all items in the list 264*b1cdbd2cSJim Jagielski */ 265*b1cdbd2cSJim Jagielski sequence< ::com::sun::star::beans::Pair< string, string > > 266*b1cdbd2cSJim Jagielski getAllItems(); 267*b1cdbd2cSJim Jagielski 268*b1cdbd2cSJim Jagielski /** registers a listener which is notified about changes in the item list. 269*b1cdbd2cSJim Jagielski */ 270*b1cdbd2cSJim Jagielski void addItemListListener( [in] XItemListListener Listener ); 271*b1cdbd2cSJim Jagielski 272*b1cdbd2cSJim Jagielski /** revokes a listener which is notified about changes in the item list. 273*b1cdbd2cSJim Jagielski */ 274*b1cdbd2cSJim Jagielski void removeItemListListener( [in] XItemListListener Listener ); 275*b1cdbd2cSJim Jagielski}; 276*b1cdbd2cSJim Jagielski 277*b1cdbd2cSJim Jagielski//================================================================================================================== 278*b1cdbd2cSJim Jagielski 279*b1cdbd2cSJim Jagielski}; }; }; }; 280*b1cdbd2cSJim Jagielski 281*b1cdbd2cSJim Jagielski//================================================================================================================== 282*b1cdbd2cSJim Jagielski 283*b1cdbd2cSJim Jagielski#endif 284