offapi/com/sun/star/awt/XMetricField.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
  21  module com {  module sun {  module star {  module awt {
  22
  23
  24 /** gives access to the value and formatting of a metric field.
  25  */
  26 interface XMetricField: com::sun::star::uno::XInterface
  27 {
  28
  29     /** sets the value which is displayed in the metric field.
  30      */
  31     void setValue( [in] hyper Value, [in] short FieldUnit );
  32
  33
  34     /** sets the user value which is displayed in the metric field.
  35      */
  36     void setUserValue( [in] hyper Value, [in] short FieldUnit );
  37
  38
  39     /** returns the value which is currently displayed in the metric field.
  40      */
  41     hyper getValue( [in] short FieldUnit );
  42
  43
  44     /** returns the corrected value which is displayed in the metric field.
  45      */
  46     hyper getCorrectedValue( [in] short FieldUnit );
  47
  48
  49     /** sets the minimum value that can be entered by the user.
  50      */
  51     void setMin( [in] hyper Value, [in] short FieldUnit );
  52
  53
  54     /** returns the currently set minimum value that can be entered by the
  55         user.
  56      */
  57     hyper getMin( [in] short FieldUnit );
  58
  59
  60     /** sets the maximum value that can be entered by the user.
  61      */
  62     void setMax( [in] hyper Value, [in] short FieldUnit );
  63
  64
  65     /** returns the currently set maximum value that can be entered by the
  66         user.
  67      */
  68     hyper getMax( [in] short FieldUnit );
  69
  70
  71     /** sets the first value to be set on POS1 key.
  72      */
  73     void setFirst( [in] hyper Value, [in] short FieldUnit );
  74
  75
  76     /** returns the currently set first value which is set on POS1 key.
  77      */
  78     hyper getFirst( [in] short FieldUnit );
  79
  80
  81     /** sets the last value to be set on END key.
  82      */
  83     void setLast( [in] hyper Value, [in] short FieldUnit );
  84
  85
  86     /** returns the currently set last value which is set on END key.
  87      */
  88     hyper getLast( [in] short FieldUnit );
  89
  90
  91     /** sets the increment value for the spin button.
  92      */
  93     void setSpinSize( [in] hyper Value );
  94
  95
  96     /** returns the currently set increment value for the spin button.
  97      */
  98     hyper getSpinSize();
  99
 100
 101     /** sets the number of decimals.
 102      */
 103     void setDecimalDigits( [in] short nDigits );
 104
 105
 106     /** returns the currently set number of decimals.
 107      */
 108     short getDecimalDigits();
 109
 110
 111     /** determines if the format is checked during user input.
 112      */
 113     void setStrictFormat( [in] boolean bStrict );
 114
 115
 116     /** returns whether the format is currently checked during user input.
 117      */
 118     boolean isStrictFormat();
 119
 120 };
 121
 122
 123 }; }; }; };
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */