src/Font/Font_SystemFont.cdl

   1 -- Created on: 2008-01-20
   2 -- Created by: Alexander A. BORODIN
   3 -- Copyright (c) 2008-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20 class SystemFont from Font inherits TShared from MMgt
  21 ---Purpose: Structure for store of Font System Information
  22
  23 uses FontAspect,
  24      HAsciiString from TCollection
  25
  26 is
  27   Create returns SystemFont;
  28   ---Purpose: Creates empty font object
  29   ---Level: Public
  30
  31   Create (FontName : HAsciiString;
  32           Aspect   : FontAspect;
  33           FilePath : HAsciiString ) returns SystemFont;
  34   ---Purpose: Creates Font object initialized with <FontName> as name
  35   ---         <FontAspect>.... TODO
  36   ---Level: Public
  37
  38   Create (XLFD     : HAsciiString;
  39           FilePath : HAsciiString ) returns SystemFont;
  40   ---Purpose: TODO
  41   ---Level: Public
  42
  43   FontName (me) returns HAsciiString;
  44   --- Purpose: Returns font family name
  45   ---Level: Public
  46
  47   FontPath (me) returns HAsciiString;
  48   --- Purpose: Returns font file path
  49   --- Level: Public
  50
  51   FontAspect (me) returns FontAspect;
  52   --- Purpose: Returns font aspect
  53   --- Level: Public
  54
  55   FontHeight (me) returns Integer from Standard;
  56   --- Purpose: Returns font height
  57   --- If returned value is equal -1 it means that font is resizable
  58   --- Level: Public
  59
  60   IsValid (me) returns Boolean;
  61
  62 fields
  63   MyFontName:           HAsciiString;  --Font family name
  64   MyFontAspect:         FontAspect;
  65   MyFaceSize:           Integer;       --height of font
  66   MyFilePath:           HAsciiString;  --absolute path to font file
  67   MyVerification:       Boolean;       --indicator of font initialization errors. False if initialization is failed.
  68
  69 end SystemFont;