LibreOffice LibreOffice 25.2 SDK API Reference

XListBox.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21
22 module com { module sun { module star { module awt {
23
24
28published interface XListBox: com::sun::star::uno::XInterface
29{
30
33 void addItemListener( [in] com::sun::star::awt::XItemListener l );
34
35
38 void removeItemListener( [in] com::sun::star::awt::XItemListener l );
39
40
43 void addActionListener( [in] com::sun::star::awt::XActionListener l );
44
45
48 void removeActionListener( [in] com::sun::star::awt::XActionListener l );
49
50
53 void addItem( [in] string aItem,
54 [in] short nPos );
55
56
59 void addItems( [in] sequence<string> aItems,
60 [in] short nPos );
61
62
65 void removeItems( [in] short nPos,
66 [in] short nCount );
67
68
71 short getItemCount();
72
73
76 string getItem( [in] short nPos );
77
78
81 sequence<string> getItems();
82
83
88 short getSelectedItemPos();
89
90
93 sequence<short> getSelectedItemsPos();
94
95
100 string getSelectedItem();
101
102
105 sequence<string> getSelectedItems();
106
107
110 void selectItemPos( [in] short nPos,
111 [in] boolean bSelect );
112
113
116 void selectItemsPos( [in] sequence<short> aPositions,
117 [in] boolean bSelect );
118
119
122 void selectItem( [in] string aItem,
123 [in] boolean bSelect );
124
125
129 boolean isMutipleMode();
130
131
134 void setMultipleMode( [in] boolean bMulti );
135
136
139 short getDropDownLineCount();
140
141
144 void setDropDownLineCount( [in] short nLines );
145
146
149 void makeVisible( [in] short nEntry );
150
151};
152
153
154}; }; }; };
155
156/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::XActionListener
makes it possible to receive action events.
Definition: XActionListener.idl:28
com::sun::star::awt::XItemListener
makes it possible to receive events from a component when the state of an item changes.
Definition: XItemListener.idl:29
com::sun::star::awt::XListBox
gives access to the items of a list box and makes it possible to register item and action event liste...
Definition: XListBox.idl:29
com::sun::star::awt::XListBox::getItemCount
short getItemCount()
returns the number of items in the listbox.
com::sun::star::awt::XListBox::getItem
string getItem([in] short nPos)
returns the item at the specified position.
com::sun::star::awt::XListBox::getDropDownLineCount
short getDropDownLineCount()
returns the number of visible lines in drop down mode.
com::sun::star::awt::XListBox::selectItemsPos
void selectItemsPos([in] sequence< short > aPositions, [in] boolean bSelect)
selects/deselects multiple items at the specified positions.
com::sun::star::awt::XListBox::removeItems
void removeItems([in] short nPos, [in] short nCount)
removes a number of items at the specified position.
com::sun::star::awt::XListBox::getSelectedItemsPos
sequence< short > getSelectedItemsPos()
returns the positions of all currently selected items.
com::sun::star::awt::XListBox::removeActionListener
void removeActionListener([in] com::sun::star::awt::XActionListener l)
unregisters a listener for action events.
com::sun::star::awt::XListBox::getSelectedItem
string getSelectedItem()
returns the currently selected item.
com::sun::star::awt::XListBox::addItems
void addItems([in] sequence< string > aItems, [in] short nPos)
adds multiple items at the specified position.
com::sun::star::awt::XListBox::isMutipleMode
boolean isMutipleMode()
returns TRUE if multiple items can be selected, FALSE if only one item can be selected.
com::sun::star::awt::XListBox::addItemListener
void addItemListener([in] com::sun::star::awt::XItemListener l)
registers a listener for item events.
com::sun::star::awt::XListBox::getItems
sequence< string > getItems()
returns all items of the list box.
com::sun::star::awt::XListBox::makeVisible
void makeVisible([in] short nEntry)
makes the item at the specified position visible by scrolling.
com::sun::star::awt::XListBox::addActionListener
void addActionListener([in] com::sun::star::awt::XActionListener l)
registers a listener for action events.
com::sun::star::awt::XListBox::getSelectedItemPos
short getSelectedItemPos()
returns the position of the currently selected item.
com::sun::star::awt::XListBox::setDropDownLineCount
void setDropDownLineCount([in] short nLines)
sets the number of visible lines for drop down mode.
com::sun::star::awt::XListBox::removeItemListener
void removeItemListener([in] com::sun::star::awt::XItemListener l)
unregisters a listener for item events.
com::sun::star::awt::XListBox::setMultipleMode
void setMultipleMode([in] boolean bMulti)
determines if only a single item or multiple items can be selected.
com::sun::star::awt::XListBox::selectItemPos
void selectItemPos([in] short nPos, [in] boolean bSelect)
selects/deselects the item at the specified position.
com::sun::star::awt::XListBox::selectItem
void selectItem([in] string aItem, [in] boolean bSelect)
selects/deselects the specified item.
com::sun::star::awt::XListBox::getSelectedItems
sequence< string > getSelectedItems()
returns all currently selected items.
com::sun::star::awt::XListBox::addItem
void addItem([in] string aItem, [in] short nPos)
adds an item at the specified position.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20