LibreOffice
LibreOffice 6.4 SDK API Reference
XObjectInspectorUI.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 #ifndef __com_sun_star_inspection_XObjectInspectorUI_idl__
20 #define __com_sun_star_inspection_XObjectInspectorUI_idl__
21 
26 
27 module com { module sun { module star { module inspection {
28 
29 interface XPropertyControlObserver;
30 
45 {
56  void enablePropertyUI( [in] string PropertyName, [in] boolean Enable );
57 
78  [in] string PropertyName,
79  [in] short Elements,
80  [in] boolean Enable
81  );
82 
98  void rebuildPropertyUI( [in] string PropertyName );
99 
105  void showPropertyUI( [in] string PropertyName );
106 
112  void hidePropertyUI( [in] string PropertyName );
113 
118  void showCategory( [in] string Category, [in] boolean Show );
119 
130  getPropertyControl( [in] string PropertyName );
131 
142 
150 
160  void setHelpSectionText( [in] string HelpText )
162 };
163 
164 
165 }; }; }; };
166 
167 #endif
168 
169 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::inspection::XObjectInspectorUI::showCategory
void showCategory([in] string Category, [in] boolean Show)
shows or hides all properties belonging to a given category
com::sun::star::inspection::XObjectInspectorUI::hidePropertyUI
void hidePropertyUI([in] string PropertyName)
hides the UI for a given property
com::sun::star::inspection::XObjectInspectorUI::revokeControlObserver
void revokeControlObserver([in] XPropertyControlObserver Observer)
revokes a previously registered control observer
com::sun::star::inspection::XObjectInspectorUI
grants access to certain aspects of the user interface of an object inspector
Definition: XObjectInspectorUI.idl:45
com::sun::star::inspection::XObjectInspectorUI::getPropertyControl
XPropertyControl getPropertyControl([in] string PropertyName)
retrieves the control currently used to display a given property
com::sun::star::inspection::XPropertyControlObserver
specifies an interface for components to observer certain aspects of an XPropertyControl.
Definition: XPropertyControlObserver.idl:37
com::sun::star::inspection::XObjectInspectorUI::setHelpSectionText
void setHelpSectionText([in] string HelpText)
sets the text of the help section, if the object inspector contains one.
com::sun::star::inspection::XObjectInspectorUI::rebuildPropertyUI
void rebuildPropertyUI([in] string PropertyName)
completely rebuilds the UI for the given property.
XPropertyControl.idl
com::sun::star::inspection::XObjectInspectorUI::enablePropertyUIElements
void enablePropertyUIElements([in] string PropertyName, [in] short Elements, [in] boolean Enable)
enables or disables the single elements which can be part of the UI representation of a property
com::sun::star::inspection::XObjectInspectorUI::registerControlObserver
void registerControlObserver([in] XPropertyControlObserver Observer)
registers an observer for all property controls
com::sun::star::inspection::XObjectInspectorUI::enablePropertyUI
void enablePropertyUI([in] string PropertyName, [in] boolean Enable)
enables or disables all components belonging to the UI representation of a property
com::sun::star::inspection::XPropertyControl
defines the interface for a single control in an ObjectInspector
Definition: XPropertyControl.idl:35
Optional.idl
com
Definition: Ambiguous.idl:22
NoSuchElementException.idl
NoSupportException.idl
com::sun::star::lang::NoSupportException
This exception is thrown when a feature of an interface is not supported.
Definition: NoSupportException.idl:39
com::sun::star::inspection::XObjectInspectorUI::showPropertyUI
void showPropertyUI([in] string PropertyName)
shows the UI for a given property