Open CASCADE Technology
6.5.4
|
The primitive Paragraph
contains a row column of editable texts
each text can have a different color and font index.
#include <Graphic2d_Paragraph.hxx>
Public Member Functions | |
Graphic2d_Paragraph (const Handle< Graphic2d_GraphicObject > &aGraphicObject, const Standard_Real X, const Standard_Real Y, const Quantity_PlaneAngle anAngle=0.0, const Aspect_CardinalPoints anOffset=Aspect_CP_Center, const Quantity_Factor aScale=1.0) | |
Creates a paragraph in a graphic object <aGraphicObject> The reference point is <X>, <Y>. The orientation angle is <anAngle>. The offset position of the reference point is <aPosition> depending of the size of paragraph. The paragraph scale. Angles are measured counterclockwise with 0 radian at 3 o'clock. Warning: a paragraph can be orientable.slantable and zoomable only when this options are enable regardless of the graphic driver. i.e: Xw driver does not,but Xdps or PS driver does. | |
void | SetSlant (const Quantity_PlaneAngle aSlant=0.0) |
Sets the slant angle of the paragraph <me>. | |
void | SetSpacing (const Quantity_Ratio aSpacing=0.5) |
Sets the line spacing ratio for the paragraph <me>. the spacing height between two lines depends of the spacing factor apply on the height of the line currently -- writen. | |
void | SetMargin (const Quantity_Length aMargin=0.0) |
Sets the fixed margin for the paragraph <me>. | |
void | SetZoomable (const Standard_Boolean aFlag=Standard_False) |
The paragraph <me> follows the scale factor of the view if the flag is Standard_True. | |
void | SetFrameColorIndex (const Standard_Integer anIndex=0) |
Sets the frame color index for the paragraph <me>. Warning: Note that the paragraph frame is drawn only when index is > 0. | |
void | SetFrameWidthIndex (const Standard_Integer anIndex=0) |
Sets the width index for the frame of the paragraph <me>. default width is 0 (1 pixel out line frame is drawn). | |
void | SetHidingColorIndex (const Standard_Integer anIndex=0) |
Sets the hiding color index for the paragraph <me>. Warning: Note that the paragraph background is filled only when index is >= 0. A value of 0 permits to drawn the paragraph background with the current view background color. | |
void | SetCurrentColorIndex (const Standard_Integer anIndex=1) |
Sets the current color index for the paragraph <me>. Warning: Note that the index 0 can be undefined as a ColorMapEntry, in this case the default color is taken. | |
void | SetCurrentFontIndex (const Standard_Integer anIndex=0, const Quantity_Length aHScale=1.0, const Quantity_Length aWScale=1.0) |
Sets the current font index and scales for the paragraph <me>. Warning: Note that the index 0 can be undefined as a FontMapEntry , in this case the default system text font is taken. | |
void | SetCurrentAlignment (const Graphic2d_TypeOfAlignment anAlignment=Graphic2d_TOA_LEFT) |
Sets the current text alignment for the paragraph <me>. | |
void | SetCurrentUnderline (const Standard_Boolean isUnderlined=Standard_False) |
Sets the current text underline flag for the paragraph <me>. | |
void | AddText (const TCollection_ExtendedString &aText, const Standard_Integer aRow=0, const Standard_Integer aColumn=0) |
Adds a text at a row-column position in the paragraph <me> with the current Color,Font,Alignment attributes at the position <aColumn,aRow> if <aColumn> and <aRow> are > 0 or at the end of the line if <aColumn> is 0, or at the end of the paragraph if <aRow> is 0. | |
void | ChangeText (const TCollection_ExtendedString &aText, const Standard_Integer aRow, const Standard_Integer aColumn) |
Changes a text in the paragraph at a row-column position, don't change the attributes of the text. Warning: May do nothing if the row-column don't exist in the paragraph. | |
void | Clear () |
Clear ALL the text in the paragraph <me>. | |
Standard_Boolean | IsZoomable () const |
Returns Standard_True if the Paragraph <me> follows the scale factor of the view. | |
void | Size (Quantity_Length &aWidth, Quantity_Length &aHeight) const |
Returns the size of the paragraph <me> . | |
void | Position (Quantity_Length &X, Quantity_Length &Y) const |
Returns the paragraph position. | |
Aspect_CardinalPoints | Offset (Quantity_Length &Dx, Quantity_Length &Dy) const |
Returns the paragraph Offset. | |
Quantity_PlaneAngle | Angle () const |
Returns the paragraph orientation. | |
Quantity_PlaneAngle | Slant () const |
Returns the paragraph slant. | |
Quantity_Ratio | Spacing () const |
Returns the paragraph spacing ratio. | |
Quantity_Length | Margin () const |
Returns the paragraph margin value. | |
Standard_Integer | HidingColorIndex () const |
Returns the paragraph hiding color index. | |
Standard_Integer | FrameColorIndex () const |
Returns the paragraph frame color index. | |
Standard_Integer | FrameWidthIndex () const |
Returns the paragraph frame width index. | |
TCollection_ExtendedString | Text (const Standard_Integer aRank, Standard_Integer &aRow, Standard_Integer &aColumn, Standard_Integer &aColorIndex, Standard_Integer &aFontIndex, Graphic2d_TypeOfAlignment &anAlignment) const |
Returns the text string and attributes of rank <aRank>. | |
Standard_Boolean | TextSize (const Standard_Integer aRank, Quantity_Length &aWidth, Quantity_Length &aHeight, Quantity_Length &anXoffset, Quantity_Length &anYoffset) const |
Returns Standard_True if the current Driver used is enabled to get the right size and offsets in the world size parameter <aWidth>,<aHeight>,<anXoffset>,<anYoffset> depending of the attributes of the paragraph text position <aRank> 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 text boundary limits. | |
Standard_Integer | Length () const |
Returns the number of Text of the paragraph <me>. | |
Standard_Integer | MaxRow () const |
Returns the number of Row of the paragraph <me>. | |
Standard_Integer | MaxColumn () const |
Returns the number of Column of the paragraph <me>. | |
Standard_Boolean | ComputeMinMax () |
Computes the MinMax of the paragraph if possible. | |
virtual void | Save (Aspect_FStream &aFStream) const |
Protected Member Functions | |
void | Draw (const Handle< Graphic2d_Drawer > &aDrawer) |
Draws the paragraph <me>. | |
Standard_Boolean | Pick (const Standard_ShortReal X, const Standard_ShortReal Y, const Standard_ShortReal aPrecision, const Handle< Graphic2d_Drawer > &aDrawer) |
Returns Standard_True if the paragraph <me> is picked, Standard_False if not. |
Graphic2d_Paragraph::Graphic2d_Paragraph | ( | const Handle< Graphic2d_GraphicObject > & | aGraphicObject, |
const Standard_Real | X, | ||
const Standard_Real | Y, | ||
const Quantity_PlaneAngle | anAngle = 0.0 , |
||
const Aspect_CardinalPoints | anOffset = Aspect_CP_Center , |
||
const Quantity_Factor | aScale = 1.0 |
||
) |
void Graphic2d_Paragraph::AddText | ( | const TCollection_ExtendedString & | aText, |
const Standard_Integer | aRow = 0 , |
||
const Standard_Integer | aColumn = 0 |
||
) |
void Graphic2d_Paragraph::ChangeText | ( | const TCollection_ExtendedString & | aText, |
const Standard_Integer | aRow, | ||
const Standard_Integer | aColumn | ||
) |
Standard_Boolean Graphic2d_Paragraph::ComputeMinMax | ( | ) | [virtual] |
Reimplemented from Graphic2d_Primitive.
void Graphic2d_Paragraph::Draw | ( | const Handle< Graphic2d_Drawer > & | aDrawer | ) | [protected, virtual] |
Implements Graphic2d_Primitive.
Standard_Integer Graphic2d_Paragraph::Length | ( | ) | const |
Quantity_Length Graphic2d_Paragraph::Margin | ( | ) | const |
Standard_Integer Graphic2d_Paragraph::MaxRow | ( | ) | const |
Aspect_CardinalPoints Graphic2d_Paragraph::Offset | ( | Quantity_Length & | Dx, |
Quantity_Length & | Dy | ||
) | const |
Standard_Boolean Graphic2d_Paragraph::Pick | ( | const Standard_ShortReal | X, |
const Standard_ShortReal | Y, | ||
const Standard_ShortReal | aPrecision, | ||
const Handle< Graphic2d_Drawer > & | aDrawer | ||
) | [protected, virtual] |
Implements Graphic2d_Primitive.
void Graphic2d_Paragraph::Position | ( | Quantity_Length & | X, |
Quantity_Length & | Y | ||
) | const |
virtual void Graphic2d_Paragraph::Save | ( | Aspect_FStream & | aFStream | ) | const [virtual] |
Implements Graphic2d_Primitive.
void Graphic2d_Paragraph::SetCurrentAlignment | ( | const Graphic2d_TypeOfAlignment | anAlignment = Graphic2d_TOA_LEFT | ) |
void Graphic2d_Paragraph::SetCurrentColorIndex | ( | const Standard_Integer | anIndex = 1 | ) |
void Graphic2d_Paragraph::SetCurrentFontIndex | ( | const Standard_Integer | anIndex = 0 , |
const Quantity_Length | aHScale = 1.0 , |
||
const Quantity_Length | aWScale = 1.0 |
||
) |
void Graphic2d_Paragraph::SetCurrentUnderline | ( | const Standard_Boolean | isUnderlined = Standard_False | ) |
void Graphic2d_Paragraph::SetFrameColorIndex | ( | const Standard_Integer | anIndex = 0 | ) |
void Graphic2d_Paragraph::SetFrameWidthIndex | ( | const Standard_Integer | anIndex = 0 | ) |
void Graphic2d_Paragraph::SetHidingColorIndex | ( | const Standard_Integer | anIndex = 0 | ) |
void Graphic2d_Paragraph::SetMargin | ( | const Quantity_Length | aMargin = 0.0 | ) |
void Graphic2d_Paragraph::SetSlant | ( | const Quantity_PlaneAngle | aSlant = 0.0 | ) |
void Graphic2d_Paragraph::SetSpacing | ( | const Quantity_Ratio | aSpacing = 0.5 | ) |
void Graphic2d_Paragraph::Size | ( | Quantity_Length & | aWidth, |
Quantity_Length & | aHeight | ||
) | const |
Quantity_Ratio Graphic2d_Paragraph::Spacing | ( | ) | const |
TCollection_ExtendedString Graphic2d_Paragraph::Text | ( | const Standard_Integer | aRank, |
Standard_Integer & | aRow, | ||
Standard_Integer & | aColumn, | ||
Standard_Integer & | aColorIndex, | ||
Standard_Integer & | aFontIndex, | ||
Graphic2d_TypeOfAlignment & | anAlignment | ||
) | const |
Standard_Boolean Graphic2d_Paragraph::TextSize | ( | const Standard_Integer | aRank, |
Quantity_Length & | aWidth, | ||
Quantity_Length & | aHeight, | ||
Quantity_Length & | anXoffset, | ||
Quantity_Length & | anYoffset | ||
) | const |