offapi/com/sun/star/inspection/XPropertyControl.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
  20 #ifndef __com_sun_star_inspection_XPropertyControl_idl__
  21 #define __com_sun_star_inspection_XPropertyControl_idl__
  22
  23 #include <com/sun/star/beans/IllegalTypeException.idl>
  24 #include <com/sun/star/awt/XWindow.idl>
  25
  26 module com {  module sun {  module star {  module inspection {
  27
  28 interface XPropertyControlContext;
  29
  30 /** defines the interface for a single control in an ObjectInspector
  31
  32     @since OOo 2.0.3
  33 */
  34 interface XPropertyControl
  35 {
  36     /** denotes the type of the control, as one of the PropertyControlType
  37         constants
  38     */
  39     [attribute, readonly] short ControlType;
  40
  41     /** denotes the current content of the control.
  42
  43         <p>At every point in time, this value is either `VOID`, or of the type
  44         described by #ValueType.</p>
  45
  46         @throws com::sun::star::beans::IllegalTypeException
  47             if an attempt is made to set a value which is not `VOID` and whose
  48             type does not equal #ValueType.
  49     */
  50     [attribute] any Value
  51     {
  52         set raises ( com::sun::star::beans::IllegalTypeException );
  53     };
  54
  55     /** denotes the value type of the control.
  56
  57         @see Value
  58     */
  59     [attribute, readonly] type ValueType;
  60
  61     /** specifies the context of the control within the ObjectInspector.
  62
  63         <p>The property control should actively notify its state changes to the context.
  64         In particular, changes in the focus and the value of the control must be notified.
  65     */
  66     [attribute] XPropertyControlContext ControlContext;
  67
  68     /** determines whether the control content is currently modified
  69
  70         <p>An XPropertyControl internally manages a flag indicating whether
  71         its content is modified. This flag is reset to `FALSE` every time our
  72         #ControlContext is notified of our current value. Also, the control
  73         implementation must set this flag to `TRUE` if and only if the user changed the
  74         control content.</p>
  75
  76         @see notifyModifiedValue
  77         @see ControlContext
  78         @see XPropertyControlContext::valueChanged
  79     */
  80     boolean isModified();
  81
  82     /** notifies the context in which the control lives of the current control value,
  83         if this value is currently modified
  84
  85         @see isModified
  86         @see ControlContext
  87         @see XPropertyControlListener::valueChanged
  88     */
  89     void notifyModifiedValue();
  90
  91     /** denotes the window which is the real UI representation of the property control.
  92
  93         <p>The ObjectInspector will automatically position and size this control
  94         as needed, care for its Z-order, and so on.</p>
  95
  96         <p>This Window must not be `NULL`, else the whole control is not usable.</p>
  97     */
  98     [attribute, readonly] com::sun::star::awt::XWindow ControlWindow;
  99 };
 100
 101
 102 }; }; }; };
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */