+++ /dev/null
--- Created on: 1993-06-22
--- Created by: Jean Louis FRENKEL, Gerard GRAS
--- Copyright (c) 1993-1999 Matra Datavision
--- Copyright (c) 1999-2012 OPEN CASCADE SAS
---
--- The content of this file is subject to the Open CASCADE Technology Public
--- License Version 6.5 (the "License"). You may not use the content of this file
--- except in compliance with the License. Please obtain a copy of the License
--- at http://www.opencascade.org and read it completely before using this file.
---
--- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
--- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
---
--- The Original Code and all software distributed under the License is
--- distributed on an "AS IS" basis, without warranty of any kind, and the
--- Initial Developer hereby disclaims all such warranties, including without
--- limitation, any warranties of merchantability, fitness for a particular
--- purpose or non-infringement. Please see the License for the specific terms
--- and conditions governing the rights and limitations under the License.
-
-
-
-
-class FramedText from Graphic2d inherits Text from Graphic2d
-
- ---Purpose: The class defines the primitive FramedText
-
-uses
- Drawer from Graphic2d,
- GraphicObject from Graphic2d,
- PlaneAngle from Quantity,
- Length from Quantity,
- Ratio from Quantity,
- Factor from Quantity,
- ExtendedString from TCollection,
- TypeOfText from Aspect,
- FStream from Aspect,
- IFStream from Aspect
-
-
-is
- -------------------------
- -- Category: Constructors
- -------------------------
-
- Create (aGraphicObject: GraphicObject from Graphic2d;
- aText: ExtendedString from TCollection;
- X, Y: Real from Standard;
- anAngle: PlaneAngle from Quantity = 0.0;
- aMargin: Ratio from Quantity = 0.1;
- aType: TypeOfText from Aspect = Aspect_TOT_SOLID;
- aScale: Factor from Quantity = 1.0)
- returns mutable FramedText from Graphic2d;
- ---Level: Public
- ---Purpose: Creates a framed text in a graphic object <aGraphicObject>
- -- The text is <aText>.
- -- The reference point is <X>, <Y>.
- -- The orientation angle is <anAngle>.
- -- The margin ratio is <aMargin>,defines the proportional
- -- margin between the text height and the outline frame.
- -- The type of text is <aType> and must be one of :
- -- Aspect_TOT_SOLID,
- -- Aspect_TOT_OUTLINE,
- -- The scale factor apply to the original font size,
- -- Angles are measured counterclockwise with 0 radian
- -- at 3 o'clock.
- --
- -- Warning: a text can be orientable,slantable,zoomable or outlinable
- -- only when this options are enable regardless of the graphic driver.
- -- i.e: Xw driver does not,but Xdps or PS driver does.
- ---Category: Constructors
-
- ---------------------------------------------------
- -- Category: Methods to modify the class definition
- ---------------------------------------------------
-
- SetFrameColorIndex (me:mutable; anIndex: Integer from Standard = 0)
- is static;
- ---Level: Public
- ---Purpose: Sets the color index for the frame of the text <me>.
- -- default color is 0 (the same color that the text).
-
- SetFrameWidthIndex (me:mutable; anIndex: Integer from Standard = 0)
- is static;
- ---Level: Public
- ---Purpose: Sets the width index for the frame of the text <me>.
- -- default width is 0 (1 pixel out line frame is drawn).
-
- Fit (me:mutable; aWidth,aHeight: Length from Quantity;
- Adjust: Boolean from Standard = Standard_True;
- Expand: Boolean from Standard = Standard_True)
- returns Boolean from Standard is redefined;
- ---Level: Public
- ---Purpose: Defines the size of the text according to a bounding
- -- box. If Adjust corresponds to TRUE, text positioning
- -- depends on the text origin and bottom line. The
- -- method returns Standard_True if the current Driver is
- -- compatible with the text size.
- -- Warning
- -- Fit computation is executed only if the dimension is > 0.
-
- Trunc (me:mutable; aWidth: Length from Quantity)
- returns Boolean from Standard is redefined;
- ---Level: Public
- ---Purpose: Trunc the text when the Width of the text is greater
- -- that the defined Width Max,
- -- and returns Standard_True if the current Driver used is
- -- enable to trunc the text size.
-
- --------------------------
- -- Category: Draw and Pick
- --------------------------
-
- Draw (me : mutable; aDrawer: Drawer from Graphic2d)
- is redefined protected;
- ---Level: Internal
- ---Purpose: Draws the framed text <me>.
-
- Pick (me : mutable; X, Y: ShortReal from Standard;
- aPrecision: ShortReal from Standard;
- aDrawer: Drawer from Graphic2d)
- returns Boolean from Standard
- is redefined protected;
- ---Level: Internal
- ---Purpose: Returns Standard_True if the framed text <me> is picked,
- -- Standard_False if not.
-
- ----------------------------
- -- Category: Inquire methods
- ----------------------------
-
- TextSize (me; aWidth,aHeight,anXoffset,anYoffset: out Length from Quantity)
- returns Boolean from Standard is redefined;
- ---Level: Public
- ---Purpose: Returns Standard_True if the current Driver used is enabled
- -- to get the right size and framed text offsets in the
- -- world size parameter <aWidth>,<aHeight>,<anXoffset>,<anYoffset>
- -- depending of the attributes of the text and the current scale
- -- of the view.
- -- NOTE that the text offsets defines the relative position of the
- -- of the text string origin from the lower left corner of the framed text
- -- boundary limits.
- ---Category: Text management
-
- Margin (me) returns Ratio from Quantity is static;
- ---Level: Public
- ---Purpose: Returns the text margin.
-
- FrameColorIndex (me) returns Integer from Standard is static;
- ---Level: Public
- ---Purpose: Returns the text frame color index.
-
- FrameWidthIndex (me) returns Integer from Standard is static;
- ---Level: Public
- ---Purpose: Returns the text frame width index.
-
- ----------------------------
- -- Category: Private methods
- ----------------------------
-
- ComputeMinMax (me : mutable)
- returns Boolean from Standard is redefined private;
- ---Level: Internal
- ---Purpose: Computes the MinMax of the text if possible.
-
- ----------------------------------------------------------------------
-
- Save( me; aFStream: in out FStream from Aspect ) is virtual;
--- Retrieve( myclass; anIFStream: in out IFStream from Aspect );
-
-fields
- myFrameColorIndex: Integer from Standard;
- myFrameWidthIndex: Integer from Standard;
- myMargin: ShortReal from Standard;
-
-end FramedText from Graphic2d;
projects / occt.git / blobdiff