7cb13e25de22e7a97191a5b55fa4dd8e523800b8
[occt.git] / src / Font / Font_SystemFont.hxx
1 // Created on: 2008-01-20
2 // Created by: Alexander A. BORODIN
3 // Copyright (c) 2008-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _Font_SystemFont_HeaderFile
17 #define _Font_SystemFont_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <Font_FontAspect.hxx>
23 #include <Standard_Integer.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Transient.hxx>
26 class TCollection_HAsciiString;
27
28 //! This class stores information about the font, which is merely a file path and cached metadata about the font.
29 class Font_SystemFont : public Standard_Transient
30 {
31   DEFINE_STANDARD_RTTIEXT(Font_SystemFont, Standard_Transient)
32 public:
33
34   //! Creates an empty font object.
35   Standard_EXPORT Font_SystemFont();
36
37   //! Creates a new font object.
38   Standard_EXPORT Font_SystemFont (const Handle(TCollection_HAsciiString)& theFontName,
39                                    const Font_FontAspect theFontAspect,
40                                    const Handle(TCollection_HAsciiString)& theFilePath);
41
42   //! Creates a font object and initialize class fields with values taken from XLFD (X Logical Font Description)
43   Standard_EXPORT Font_SystemFont (const Handle(TCollection_HAsciiString)& theXLFD,
44                                    const Handle(TCollection_HAsciiString)& theFilePath);
45
46   //! Returns font family name.
47   const Handle(TCollection_HAsciiString)& FontName() const { return myFontName; }
48   
49   //! Returns font file path.
50   const Handle(TCollection_HAsciiString)& FontPath() const { return myFilePath; }
51   
52   //! Returns font aspect.
53   Font_FontAspect FontAspect() const { return myFontAspect; }
54   
55   //! Returns font height.
56   //! If returned value is equal -1 it means that font is resizable.
57   Standard_Integer FontHeight() const { return myFaceSize; }
58
59   Standard_EXPORT Standard_Boolean IsValid() const;
60   
61   //! Return true if the FontName, FontAspect and FontSize are the same.
62   Standard_EXPORT Standard_Boolean IsEqual (const Handle(Font_SystemFont)& theOtherFont) const;
63
64   //! Return TRUE if this is single-stroke (one-line) font, FALSE by default.
65   //! Such fonts define single-line glyphs instead of closed contours, so that they are rendered incorrectly by normal software.
66   Standard_Boolean IsSingleStrokeFont() const { return myIsSingleLine; }
67
68   //! Set if this font should be rendered as single-stroke (one-line).
69   void SetSingleStrokeFont (Standard_Boolean theIsSingleLine) { myIsSingleLine = theIsSingleLine; }
70
71 private:
72
73   Handle(TCollection_HAsciiString) myFontName;
74   Font_FontAspect                  myFontAspect;
75   Standard_Integer                 myFaceSize;
76   Handle(TCollection_HAsciiString) myFilePath;
77   Standard_Boolean                 myIsSingleLine; //!< single stroke font flag, FALSE by default
78   Standard_Boolean                 myIsDefined;
79
80 };
81
82 DEFINE_STANDARD_HANDLE(Font_SystemFont, Standard_Transient)
83
84 #endif // _Font_SystemFont_HeaderFile