offapi/com/sun/star/inspection/DefaultHelpProvider.idl

   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_DefaultHelpProvider_idl__
  20 #define __com_sun_star_inspection_DefaultHelpProvider_idl__
  21
  22 #include <com/sun/star/lang/IllegalArgumentException.idl>
  23
  24
  25 module com { module sun { module star { module inspection {
  26
  27 interface XObjectInspectorUI;
  28
  29
  30 /** implements a component which can default-fill the help section of an
  31     ObjectInspector.
  32
  33     <p>The component registers a XPropertyControlObserver at an
  34     XObjectInspectoryUI interface. Whenever it then is notified
  35     of a XPropertyControl getting the focus, it will try to deduce
  36     the extended help text of this control's window, and set this help text at the
  37     object inspector's help section.</p>
  38  */
  39 service DefaultHelpProvider : com::sun::star::uno::XInterface
  40 {
  41     /** creates a help provider instance
  42         @param InspectorUI
  43             provides access to the UI of the ObjectInspector which should be
  44             observed. Must not be `NULL`.
  45         @throws ::com::sun::star::lang::IllegalArgumentException
  46             if the given inspector UI is `NULL`.
  47     */
  48     create( [in] XObjectInspectorUI InspectorUI )
  49         raises ( ::com::sun::star::lang::IllegalArgumentException );
  50 };
  51
  52
  53 }; }; }; };
  54
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */