LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XIndexContainer Interface Referencepublished

This is the generic interface for supporting the insertion and removal of indexed elements. More...

import"XIndexContainer.idl";

Inheritance diagram for XIndexContainer:
XIndexReplace XIndexAccess XElementAccess XInterface XTabPageContainerModel UnoControlRoadmapModel IndexedPropertyValues FormComponents XForms ImageMap CustomPresentation XFunctions XGroups XReportControlModel XDataContainer ActionTriggerContainer

Public Member Functions

void insertByIndex ([in] long Index, [in] any Element) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException )
 inserts the given element at the specified index. More...
 
void removeByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException )
 removes the element at the specified index. More...
 
- Public Member Functions inherited from XIndexReplace
void replaceByIndex ([in] long Index, [in] any Element) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException )
 replaces the element at the specified index with the given element. More...
 
- Public Member Functions inherited from XIndexAccess
long getCount ()
 
any getByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException )
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

This is the generic interface for supporting the insertion and removal of indexed elements.

See also
XContainer
Developers Guide
Professional UNO - Collections and Containers

Member Function Documentation

◆ insertByIndex()

inserts the given element at the specified index.

To append an element, use the index "last index +1".

◆ removeByIndex()

removes the element at the specified index.


The documentation for this interface was generated from the following file: