1
0
Fork 0
libreoffice/offapi/com/sun/star/ui/dialogs/XControlInformation.idl
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

86 lines
2.9 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module ui { module dialogs {
/** Interface to query for controls and control properties supported by the
implementing instance.
@since OOo 1.1.2
*/
published interface XControlInformation: com::sun::star::uno::XInterface
{
/** Query for the supported controls of a service instance.
@returns
a sequence with the names of the supported controls.
*/
sequence<string> getSupportedControls( );
/** Returns whether the specified control is supported or not.
@param aControlName
The name of the control. Common control names are for
instance "OkButton" or "CancelButton".
@returns
`TRUE` if the specified control is supported.
`FALSE` if the specified control is not supported.
*/
boolean isControlSupported( [in] string aControlName );
/** Returns a sequence with properties supported by the specified
control.
@param aControlName
The name of the control. Common control names are for
instance "OkButton" or "CancelButton".
@returns
a sequence of control properties supported by the specified control.
@throws com::sun::star::lang::IllegalArgumentException
when the specified control is not supported.
*/
sequence<string> getSupportedControlProperties( [in] string aControlName )
raises( com::sun::star::lang::IllegalArgumentException );
/** Returns whether control property is supported by a control.
@param aControlName
The name of the control.
@param aControlProperty
The control property to query for.
@returns
`TRUE` if the specified control action is supported.
`FALSE` if the specified control action is not supported.
@throws com::sun::star::lang::IllegalArgumentException
when the specified control is not supported.
*/
boolean isControlPropertySupported( [in] string aControlName, [in] string aControlProperty )
raises( com::sun::star::lang::IllegalArgumentException );
};
}; }; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */