LibreOffice
LibreOffice 6.0 SDK API Reference
Public Member Functions | List of all members
XInterface Interface Referencepublished

base interface of all UNO interfaces More...

import"XInterface.idl";

Inheritance diagram for XInterface:
XAccessible XAccessibleAction XAccessibleComponent XAccessibleContext XAccessibleEventBroadcaster XAccessibleExtendedAttributes XAccessibleGetAccFlowTo XAccessibleGroupPosition XAccessibleImage XAccessibleKeyBinding XAccessibleRelationSet XAccessibleSelection XAccessibleStateSet XAccessibleTable XAccessibleTableSelection XAccessibleText XAccessibleTextSelection XAccessibleValue XSSOContext XSSOManager XSSOManagerFactory XSSOPasswordCache XBitmap XButton XCheckBox XComboBox XContainerWindowEventHandler XContainerWindowProvider XControlContainer XControlModel XCurrencyField XDataTransferProviderAccess XDateField XDevice XDialog XDialogEventHandler XDialogProvider XDisplayBitmap XDisplayConnection XDockableWindow XEventHandler XExtendedToolkit XFileDialog XFixedHyperlink XFixedText XFont XGraphics XImageButton XImageConsumer XImageProducer XItemEventBroadcaster XLayoutConstrains XListBox XMenu XMessageBoxFactory XMetricField XNumericField XPatternField XPointer XPrinterServer XProgressBar XRadioButton XRegion XReschedule XScrollBar XSimpleTabController XSpinField XSpinValue XSystemChildFactory XSystemDependentMenuPeer XSystemDependentWindowPeer XTabController XTabControllerModel XTextArea XTextComponent XTextEditField XTextLayoutConstrains XTimeField XToolkit XTopWindow XUnitConversion XUnoControlContainer XUserInputInterception XVclContainer XVclContainerPeer XView XExactName XFastPropertySet XHierarchicalPropertySet XHierarchicalPropertySetInfo XIntrospection XIntrospectionAccess XMaterialHolder XMultiHierarchicalPropertySet XMultiPropertySet XMultiPropertyStates XPropertiesChangeNotifier XProperty XPropertyAccess XPropertyContainer XPropertySet XPropertySetInfo XPropertySetInfoChangeNotifier XPropertySetOption XPropertyState XPropertyWithState XTolerantMultiPropertySet OleApplicationRegistration ApplicationRegistration XAutomationObject XBridge XBridgeFactory XBridgeSupplier XBridgeSupplier2 XInstanceProvider XProtocolProperties XUnoUrlResolver XDataProvider XDataReceiver XDataSequence XDataSink XDataSource XLabeledDataSequence XNumericalDataSequence XPivotTableDataProvider XRangeHighlighter XRangeXMLConversion XSheetDataProvider XTextualDataSequence XAxis XChartShape XChartShapeContainer XChartType XChartTypeContainer XChartTypeManager XChartTypeTemplate XColorScheme XCoordinateSystem XCoordinateSystemContainer XDataInterpreter XDataSeries XDataSeriesContainer XDefaultSizeTransmitter XDiagram XDiagramProvider XFormattedString XLegend XRegressionCurve XRegressionCurveCalculator XRegressionCurveContainer XScaling XTarget XTimeBased XTitle XTitled XTransformation X3DDefaultSetter X3DDisplay XAxis XAxisSupplier XAxisXSupplier XAxisYSupplier XAxisZSupplier XChartData XDiagramPositioning XSecondAxisTitleSupplier XStatisticDisplay XBackend XBackendChangesNotifier XBackendEntities XLayer XLayerContentDescriber XLayerHandler XLayerImporter XMultiLayerStratum XSchema XSchemaHandler XSchemaSupplier XSingleLayerStratum XUpdateHandler XTemplateContainer XTemplateInstance XAcceptor XConnection XConnectionBroadcaster XConnector XChild XContainer XContainerQuery XContentEnumerationAccess XElementAccess XEnumeration XHierarchicalName XHierarchicalNameAccess XImplicitIDReplace XNamed XUniqueIDAccess XClipboard XClipboardFactory XClipboardManager XClipboardNotifier XClipboardOwner XFlushableClipboard XAutoscroll XDragGestureRecognizer XDragSource XDragSourceContext XDropTarget XDropTargetDragContext XDropTargetDropContext XDataFormatTranslator XMimeContentType XMimeContentTypeFactory XSystemTransferable XTransferable XTransferableEx XTransferableSource XTransferDataAccess OleEmbeddedServerRegistration XActionLockable XBinaryStreamResolver XCmisDocument XDocumentInsertable XDocumentLanguages XDocumentRevisionListPersistence XDocumentSubStorageSupplier XEmbeddedObjectResolver XEmbeddedObjectSupplier XEventBroadcaster XEventsSupplier XExporter XExtendedFilterDetection XFilter XFilterAdapter XGraphicObjectResolver XImporter XLinkTargetSupplier XMimeTypeInfo XOOXMLDocumentPropertiesImporter XRedlinesSupplier XStorageBasedDocument XTypeDetection XVbaMethodParameter XViewDataSupplier XConnectableShape XCustomShapeEngine XCustomShapeHandle XDrawPageDuplicator XDrawPageExpander XDrawPagesSupplier XDrawPageSummarizer XDrawPageSupplier XDrawView XEnhancedCustomShapeDefaulter XGluePointsSupplier XLayerSupplier XMasterPagesSupplier XMasterPageTarget XShapeAligner XShapeArranger XShapeBinder XShapeCombiner XShapeDescriptor XShapeGrouper XShapeMirror XActionsApproval XClassifiedObject XCommonEmbedPersist XComponentSupplier XEmbedObjectClipboardCreator XEmbedObjectCreator XEmbedObjectFactory XEncryptionProtectedSource XHatchWindowController XHatchWindowFactory XInplaceClient XInplaceObject XInsertObjectDialog XLinkCreator XLinkFactory XPackageStructureCreator XPersistanceHolder XRelationshipAccess XStateChangeBroadcaster XTransactedObject XTransactionBroadcaster XTransferableSupplier XVisualObject XWindowSupplier XBindableValue XListEntrySink XListEntrySource XValueBinding XSubmission XSubmissionSupplier XValidatable XValidator XApproveActionBroadcaster XBoundControl XChangeBroadcaster XConfirmDeleteBroadcaster XDatabaseParameterBroadcaster XErrorBroadcaster XFormsSupplier XGrid XGridColumnFactory XGridFieldDataSupplier XGridPeer XImageProducerSupplier XLoadable XReset XSubmit XUpdateBroadcaster XBrowseHistoryRegistry XComponentLoader XComponentRegistry XConfigManager XControllerBorder XControlNotificationListener XDesktop XDispatch XDispatchHelper XDispatchInformationProvider XDispatchProvider XDispatchProviderInterception XDispatchRecorder XDispatchRecorderSupplier XDocumentTemplates XExtendedFilterDetection XFilterDetect XFrameLoader XFrameLoaderQuery XFrameSetModel XInterceptorInfo XLayoutManager XLayoutManagerEventBroadcaster XLoadable XMenuBarAcceptor XMenuBarMergingAcceptor XModule XModuleManager XPopupMenuController XRecordableDispatch XSessionManagerClient XStorable XSubToolbarController XSynchronousDispatch XSynchronousFrameLoader XTasksSupplier XTitle XTitleChangeBroadcaster XToolbarController XToolbarControllerListener XTransientDocumentsDocumentContentFactory XUIControllerRegistration XUntitledNumbers XUrlList XWindowArranger XGalleryItem XMapping2D XEmfParser XGraphic XGraphicObject XGraphicProvider XGraphicRasterizer XGraphicRenderer XGraphicTransformer XPrimitive2D XPrimitive2DRenderer XPrimitive3D XPrimitiveFactory2D XSvgParser XBreakIterator XCalendar XCharacterClassification XCollator XForbiddenCharacters XIndexEntrySupplier XInputSequenceChecker XLocaleData XNativeNumberSupplier XNumberFormatCode XOrdinalSuffix XScriptTypeDetector XTextConversion XTransliteration DefaultHelpProvider XActiveDataControl XActiveDataSink XActiveDataSource XActiveDataStreamer XConnectable XDataExporter XDataImporter XInputStream XInputStreamProvider XMarkableStream XOutputStream XPersist XPersistObject XSeekable XStream XTruncate XXMLExtractor XJavaThreadRegister_11 XJavaVM XComponent XConnectionPoint XConnectionPointContainer XEventListener XInitialization XLocalizable XMain XMultiComponentFactory XMultiServiceFactory XServiceDisplayName XServiceInfo XServiceName XSingleComponentFactory XSingleServiceFactory XTypeProvider XUnoTunnel XAvailableLocales XConversionDictionary XConversionDictionaryList XConversionPropertyType XDictionaryEntry XDictionaryList XHyphenatedWord XLinguServiceEventBroadcaster XLinguServiceManager XMeaning XPossibleHyphens XProofreadingIterator XSetSpellAlternatives XSpellAlternatives XSupportedLanguages XSupportedLocales XImplementationLoader XAuthenticator XMailMessage XMailService XMailServiceProvider XCloseSessionListener XCodeProxy XMenuProxyListener XProfileDiscover XProfileManager XProxyRunner XManifestReader XManifestWriter XDataSinkEncrSupport XZipFileAccess XCustomPresentationSupplier XHandoutMasterSupplier XPresentation XPresentationSupplier XSlideShow XSlideShowView XTransition XTransitionFactory XDumper XIdlArray XIdlClass XIdlClassProvider XIdlMember XIdlReflection XMethodParameter XProxyFactory XTypeDescription XTypeDescriptionEnumerationAccess XImplementationRegistration XRegistryKey XSimpleRegistry XAnimation XBitmap XBitmapPalette XBufferController XCachedPrimitive XCanvas XCanvasFont XGraphicDevice XMtfRenderer XParametricPolyPolygon2D XPolyPolygon2D XSimpleCanvas XSprite XTextLayout XLocale XStringResourceSupplier XScannerManager XBrowseNode XBrowseNodeFactory XScript XScriptContext XScriptProvider XScriptProviderFactory XScriptProviderSupplier XScriptURIHelper XAllListenerAdapterService XDebugging XDefaultMethod XDefaultProperty XDirectInvocation XEngine XErrorQuery XEventAttacher XEventAttacherManager XInvocation XInvocationAdapterFactory XInvocationAdapterFactory2 XLibraryAccess XLibraryContainerExport XLibraryContainerPassword XLibraryQueryExecutable XScriptEventsAttacher XScriptEventsSupplier XStarBasicAccess XStarBasicDialogInfo XStarBasicLibraryInfo XStarBasicModuleInfo XTypeConverter XAlterQuery XBookmarksSupplier XColumn XColumnUpdate XCommandPreparation XCompletedConnection XCompletedExecution XFormDocumentsSupplier XParametersSupplier XQueriesSupplier XQueryDefinitionsSupplier XReportDocumentsSupplier XResultSetAccess XRowSetApproveBroadcaster XRowSetSupplier XSingleSelectQueryAnalyzer XSQLErrorBroadcaster XSQLQueryComposer XSQLQueryComposerFactory XArray XBatchExecution XBlob XClob XCloseable XColumnLocate XDatabaseMetaData XDataSource XDriver XDriverAccess XDriverManager XGeneratedResultSet XIsolatedConnection XMultipleResults XOutParameters XParameters XPooledConnection XPreparedBatchExecution XPreparedStatement XRef XResultSet XResultSetMetaData XResultSetMetaDataSupplier XResultSetUpdate XRow XRowUpdate XSQLData XSQLInput XSQLOutput XStatement XStruct XWarningsSupplier XAlterTable XAppend XAuthorizable XColumnsSupplier XCreateCatalog XDataDefinitionSupplier XDataDescriptorFactory XDeleteRows XDrop XDropCatalog XGroupsSupplier XIndexesSupplier XKeysSupplier XRename XRowLocate XTablesSupplier XUsersSupplier XViewsSupplier XAccessControlContext XAccessController XAction XCertificate XCertificateExtension XDocumentDigitalSignatures XPolicy XSerialNumberAdapter XOpenCLSelection XActivationBroadcaster XAreaLink XArrayFormulaRange XCalculatable XCellAddressable XCellFormatRangesSupplier XCellRangeAddressable XCellRangeData XCellRangeFormula XCellRangeMovement XCellRangeReferrer XCellRangesAccess XCellRangesQuery XCellSeries XCompatibilityNames XConditionalFormats XConditionEntry XConsolidatable XConsolidationDescriptor XDatabaseRange XDataPilotField XDataPilotFieldGrouping XDataPilotMemberResults XDataPilotResults XDataPilotTable XDataPilotTablesSupplier XDDELink XDDELinkResults XDimensionsSupplier XDocumentAuditing XDrillDownDataSupplier XEnhancedMouseClickBroadcaster XExternalSheetName XFillAcrossSheet XFormulaQuery XFunctionAccess XGoalSeek XHeaderFooterContent XHierarchiesSupplier XLabelRange XLevelsSupplier XMembersSupplier XMultipleOperation XPrintAreas XRangeSelection XRecentFunctions XScenario XScenarioEnhanced XScenariosSupplier XSelectedSheetsSupplier XSheetAnnotation XSheetAnnotationAnchor XSheetAnnotationShapeSupplier XSheetAnnotationsSupplier XSheetAuditing XSheetCondition XSheetConditionalEntry XSheetFilterable XSheetFilterDescriptor XSheetFilterDescriptor2 XSheetFilterDescriptor3 XSheetLinkable XSheetOperation XSheetOutline XSheetPageBreak XSheetPastable XSolver XSolverDescription XSpreadsheetDocument XSpreadsheetView XSubTotalCalculatable XSubTotalDescriptor XSubTotalField XUniqueCellFormatRangesSupplier XUnnamedDatabaseRanges XUsedAreaCursor XViewFreezable XViewPane XViewPanesSupplier XViewSplitable XVolatileResult XAutoStylesSupplier XDefaultsSupplier XStyleFamiliesSupplier XStyleLoader XStyleSupplier XSVGPrinter XSVGWriter XSimpleMailClient XSimpleMailClientSupplier XSimpleMailMessage XSystemShellExecute XAutoFormattable XCell XCellRange XColumnRowRange XMergeableCellRange XTableChart XTableChartsSupplier XTablePivotChart XTablePivotChartsSupplier XAsyncJob XInteractionContinuation XInteractionHandler XInteractionRequest XInteractionRequestStringResolver XJob XJobExecutor XMasterPasswordHandling XPasswordContainer XRestartManager XStatusIndicator XStatusIndicatorFactory XStatusIndicatorSupplier XUrlContainer XAutoTextEntry XBookmarkInsertTool XBookmarksSupplier XChapterNumberingSupplier XDefaultNumberingProvider XDocumentIndexesSupplier XEndnotesSettingsSupplier XEndnotesSupplier XFlatParagraphIterator XFlatParagraphIteratorProvider XFootnotesSettingsSupplier XFootnotesSupplier XFormField XLineNumberingProperties XMailMergeBroadcaster XMailMergeListener XNumberingFormatter XNumberingRulesSupplier XNumberingTypeInfo XPageCursor XPagePrintable XParagraphAppend XReferenceMarksSupplier XRelativeTextContentInsert XRelativeTextContentRemove XRubySelection XTextColumns XTextContentAppend XTextConvert XTextCopy XTextEmbeddedObjectsSupplier XTextFieldsSupplier XTextFramesSupplier XTextGraphicObjectsSupplier XTextPortionAppend XTextRange XTextRangeCompare XTextRangeMover XTextSectionsSupplier XTextShapesSupplier XTextTableCursor XTextTablesSupplier XTextViewCursorSupplier XTiledRenderable ContentProviderProxy XAnyCompare XAnyCompareFactory XCachedContentResultSetFactory XCachedContentResultSetStubFactory XCachedDynamicResultSetFactory XCachedDynamicResultSetStubFactory XCommandEnvironment XCommandInfo XCommandInfoChangeNotifier XCommandProcessor XContent XContentAccess XContentCreator XContentIdentifier XContentIdentifierFactory XContentIdentifierMapping XContentProvider XContentProviderFactory XContentProviderManager XContentProviderSupplier XContentTransmitter XFetchProvider XFetchProviderForContentAccess XFileIdentifierConverter XInteractionHandlerSupplier XParameterizedContentProvider XProgressHandler XPropertyMatcher XPropertyMatcherFactory XPropertySetRegistry XPropertySetRegistryFactory XRecycler XRemoteContentProviderAcceptor XRemoteContentProviderActivator XRemoteContentProviderChangeNotifier XRemoteContentProviderConnectionControl XRemoteContentProviderDistributor XRemoteContentProviderDoneListener XRemoteContentProviderSupplier XSimpleFileAccess XSortedDynamicResultSetFactory XSourceInitialization XAsynchronousExecutableDialog XControlAccess XControlInformation XExecutableDialog XFilePickerNotifier XFilePreview XFilterGroupManager XFilterManager XContextChangeEventMultiplexer XContextMenuInterception XContextMenuInterceptor XDockingAreaAcceptor XModuleUIConfigurationManager XModuleUIConfigurationManagerSupplier XSidebarProvider XUIConfiguration XUIConfigurationManager XUIConfigurationManagerSupplier XUIConfigurationPersistence XUIConfigurationStorage XUIElement XUIElementFactory XUIElementFactoryRegistration XUIElementSettings XUpdateModel XAdapter XAggregation XComponentContext XCurrentContext XNamingService XReference XUnloadingPreference XWeak XUriReference XUriReferenceFactory XUriSchemeParser XVndSunStarScriptUrl XAccounting XAtomServer XBroadcaster XCancellable XChainable XChangesBatch XChangesNotifier XCloneable XCloseBroadcaster XDataEditor XDataEditorListener XFlushable XImportable XIndent XJobManager XLinkUpdate XLocalizedAliases XMacroExpander XMergeable XModeChangeBroadcaster XModeSelector XModifyBroadcaster XNumberFormatPreviewer XNumberFormats XNumberFormatsSupplier XNumberFormatter XNumberFormatTypes XOfficeInstallationDirectories XProtectable XRefreshable XSearchable XSortable XStringAbbreviation XStringEscape XStringMapping XStringSubstitution XStringWidth XTextSearch XTimeStamped XUniqueIDFactory XUpdatable XURLTransformer XControlAccess XLineCursor XPrintable XPrintableBroadcaster XPrintJob XPrintJobBroadcaster XPrintSettingsSupplier XRenderable XScreenCursor XSelectionSupplier XViewCursor XViewSettingsSupplier XFormsSupplier XBlockerMonitor XDecryptionResultBroadcaster XDecryptionResultListener XElementStackKeeper XEncryptionResultBroadcaster XEncryptionResultListener XKeyCollector XMissionTaker XReferenceCollector XReferenceResolvedBroadcaster XReferenceResolvedListener XSAXEventKeeper XSAXEventKeeperStatusChangeBroadcaster XSAXEventKeeperStatusChangeListener XSignatureCreationResultBroadcaster XSignatureCreationResultListener XSignatureVerifyResultBroadcaster XSignatureVerifyResultListener XCipherContext XCipherContextSupplier XDigestContext XDigestContextSupplier XSecurityEnvironment XSEInitializer XUriBinding XXMLEncryption XXMLSecurityContext XXMLSecurityTemplate XXMLSignature XCompressedDocumentHandler XDocumentEvent XEvent XEventListener XEventTarget XAbstractView XDocumentView XDocumentBuilder XDOMImplementation XNamedNodeMap XNode XNodeList XSAXDocumentBuilder XAttributes XElement XNamespaceMapping XRoot XAttributeList XDocumentHandler XDTDHandler XEntityResolver XErrorHandler XFastAttributeList XFastContextHandler XFastNamespaceHandler XFastParser XFastTokenHandler XLocator XParser XXMLDocumentWrapper XXMLElementWrapper XExportFilter XImportFilter XXPathAPI XXPathExtension XXPathObject XModify XQuery

Public Member Functions

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

base interface of all UNO interfaces

It provides lifetime control by reference counting and the possibility of querying for other interfaces of the same logical object.

"Logical Object" in this case means that the interfaces actually can be supported by internal (e.g. aggregated) physical objects.

Deriving from this interface is mandatory for all UNO interfaces.

Each language binding (Java, C++, StarBasic, Python, ... ) may provide a different mapping of this interface, please look into the language dependent documentation.

The UNO object does not export the state of the reference count (acquire() and release() do not have return values). In general, also the UNO object itself should not make any assumption on the concrete value of the reference count (except on the transition from one to zero ).

Developers Guide
ProUNO - Lifetime of UNO objects
FirstSteps - Using Services - Using Interfaces
ProUNO - Using UNO Interfaces
WritingUNO - XInterface
WritingUNO - Core Interfaces to Implement

Member Function Documentation

void acquire ( )

increases the reference counter by one.

When you have called acquire() on the UNO object, it is often said, that you have a reference or a hard reference to the object.

It is only allowed to invoke a method on an UNO object, when you keep a hard reference to it.

Every call to acquire must be followed by a corresponding call to release some time later, which may eventually lead to the destruction of the object.

any queryInterface ( [in] type  aType)

queries for a new interface to an existing UNO object.

The queryInterface() method is the entry point to obtain other interfaces which are exported by the object. The caller asks the implementation of the object, if it supports the interface specified by the type argument. The call may either return with a interface reference of the requested type or with a void any.

There are certain specifications, a queryInterface() implementation must not violate.

1) If queryInterface on a specific object has once returned a valid interface reference for a given type, it must return a valid reference for any successive queryInterface calls on this object for the same type.

2) If queryInterface on a specific object has once returned a null reference for a given type, it must always return a null reference for the same type.

3) If queryInterface on a reference A returns reference B, queryInterface on B for Type A must return interface reference A or calls made on the returned reference must be equivalent to calls made on reference A.

4) If queryInterface on a reference A returns reference B, queryInterface on A and B for XInterface must return the same interface reference (object identity).

The reason for the strong specification is, that a Uno Runtime Environment (URE) may choose to cache queryInterface() calls.

As mentioned above, certain language bindings may map this function differently also with different specifications, please visit the language dependent specification for it. The current C++ binding sticks to the specification state

The rules mentioned above are basically identical to the rules of QueryInterface in MS COM.

Parameters
aTypea UNO interface type, for which an object reference shall be obtained.
Returns
an interface reference in case the requested interface is supported by the object, a void any otherwise.
void release ( )

decreases the reference counter by one.

When the reference counter reaches 0, the object gets deleted.

Calling release() on the object is often called releasing or clearing the reference to an object.


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