// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _Graphic2d_Paragraph_HeaderFile #define _Graphic2d_Paragraph_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_DefineHandle_HeaderFile #include #endif #ifndef _Handle_Graphic2d_Paragraph_HeaderFile #include #endif #ifndef _Standard_ShortReal_HeaderFile #include #endif #ifndef _Aspect_CardinalPoints_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Graphic2d_TypeOfAlignment_HeaderFile #include #endif #ifndef _TColStd_SequenceOfExtendedString_HeaderFile #include #endif #ifndef _TColStd_SequenceOfInteger_HeaderFile #include #endif #ifndef _TShort_SequenceOfShortReal_HeaderFile #include #endif #ifndef _Graphic2d_Primitive_HeaderFile #include #endif #ifndef _Handle_Graphic2d_GraphicObject_HeaderFile #include #endif #ifndef _Standard_Real_HeaderFile #include #endif #ifndef _Quantity_PlaneAngle_HeaderFile #include #endif #ifndef _Quantity_Factor_HeaderFile #include #endif #ifndef _Quantity_Ratio_HeaderFile #include #endif #ifndef _Quantity_Length_HeaderFile #include #endif #ifndef _Handle_Graphic2d_Drawer_HeaderFile #include #endif #ifndef _Aspect_FStream_HeaderFile #include #endif class Standard_OutOfRange; class Graphic2d_GraphicObject; class TCollection_ExtendedString; class Graphic2d_Drawer; //! The primitive Paragraph
//! contains a row column of editable texts
//! each text can have a different color and font index.
class Graphic2d_Paragraph : public Graphic2d_Primitive { public: //! Creates a paragraph in a graphic object
//! The reference point is , .
//! The orientation angle is .
//! The offset position of the reference point is
//! 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.
Standard_EXPORT 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); //! Sets the slant angle of the paragraph .
Standard_EXPORT void SetSlant(const Quantity_PlaneAngle aSlant = 0.0) ; //! Sets the line spacing ratio for the paragraph .
//! the spacing height between two lines depends of
//! the spacing factor apply on the height of the line currently -- writen.
Standard_EXPORT void SetSpacing(const Quantity_Ratio aSpacing = 0.5) ; //! Sets the fixed margin for the paragraph .
Standard_EXPORT void SetMargin(const Quantity_Length aMargin = 0.0) ; //! The paragraph follows the scale factor of the view
//! if the flag is Standard_True.
Standard_EXPORT void SetZoomable(const Standard_Boolean aFlag = Standard_False) ; //! Sets the frame color index for the paragraph .
//! Warning: Note that the paragraph frame is drawn only when index
//! is > 0.
Standard_EXPORT void SetFrameColorIndex(const Standard_Integer anIndex = 0) ; //! Sets the width index for the frame of the paragraph .
//! default width is 0 (1 pixel out line frame is drawn).
Standard_EXPORT void SetFrameWidthIndex(const Standard_Integer anIndex = 0) ; //! Sets the hiding color index for the paragraph .
//! 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.
Standard_EXPORT void SetHidingColorIndex(const Standard_Integer anIndex = 0) ; //! Sets the current color index for the paragraph .
//! Warning: Note that the index 0 can be undefined as a ColorMapEntry,
//! in this case the default color is taken.
Standard_EXPORT void SetCurrentColorIndex(const Standard_Integer anIndex = 1) ; //! Sets the current font index and scales for the paragraph .
//! Warning: Note that the index 0 can be undefined as a FontMapEntry ,
//! in this case the default system text font is taken.
Standard_EXPORT void SetCurrentFontIndex(const Standard_Integer anIndex = 0,const Quantity_Length aHScale = 1.0,const Quantity_Length aWScale = 1.0) ; //! Sets the current text alignment for the paragraph .
Standard_EXPORT void SetCurrentAlignment(const Graphic2d_TypeOfAlignment anAlignment = Graphic2d_TOA_LEFT) ; //! Sets the current text underline flag for the paragraph .
Standard_EXPORT void SetCurrentUnderline(const Standard_Boolean isUnderlined = Standard_False) ; //! Adds a text at a row-column position in the paragraph
//! with the current Color,Font,Alignment attributes
//! at the position if and are > 0
//! or at the end of the line if is 0,
//! or at the end of the paragraph if is 0.
Standard_EXPORT void AddText(const TCollection_ExtendedString& aText,const Standard_Integer aRow = 0,const Standard_Integer aColumn = 0) ; //! 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.
Standard_EXPORT void ChangeText(const TCollection_ExtendedString& aText,const Standard_Integer aRow,const Standard_Integer aColumn) ; //! Clear ALL the text in the paragraph .
Standard_EXPORT void Clear() ; //! Returns Standard_True if the Paragraph follows
//! the scale factor of the view.
Standard_EXPORT Standard_Boolean IsZoomable() const; //! Returns the size of the paragraph .
Standard_EXPORT void Size(Quantity_Length& aWidth,Quantity_Length& aHeight) const; //! Returns the paragraph position.
Standard_EXPORT void Position(Quantity_Length& X,Quantity_Length& Y) const; //! Returns the paragraph Offset.
Standard_EXPORT Aspect_CardinalPoints Offset(Quantity_Length& Dx,Quantity_Length& Dy) const; //! Returns the paragraph orientation.
Standard_EXPORT Quantity_PlaneAngle Angle() const; //! Returns the paragraph slant.
Standard_EXPORT Quantity_PlaneAngle Slant() const; //! Returns the paragraph spacing ratio.
Standard_EXPORT Quantity_Ratio Spacing() const; //! Returns the paragraph margin value.
Standard_EXPORT Quantity_Length Margin() const; //! Returns the paragraph hiding color index.
Standard_EXPORT Standard_Integer HidingColorIndex() const; //! Returns the paragraph frame color index.
Standard_EXPORT Standard_Integer FrameColorIndex() const; //! Returns the paragraph frame width index.
Standard_EXPORT Standard_Integer FrameWidthIndex() const; //! Returns the text string and attributes of rank .
Standard_EXPORT TCollection_ExtendedString Text(const Standard_Integer aRank,Standard_Integer& aRow,Standard_Integer& aColumn,Standard_Integer& aColorIndex,Standard_Integer& aFontIndex,Graphic2d_TypeOfAlignment& anAlignment) const; //! Returns Standard_True if the current Driver used is enabled
//! to get the right size and offsets in the
//! world size parameter ,,,
//! depending of the attributes of the paragraph text position
//! 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_EXPORT Standard_Boolean TextSize(const Standard_Integer aRank,Quantity_Length& aWidth,Quantity_Length& aHeight,Quantity_Length& anXoffset,Quantity_Length& anYoffset) const; //! Returns the number of Text of the paragraph .
Standard_EXPORT Standard_Integer Length() const; //! Returns the number of Row of the paragraph .
Standard_EXPORT Standard_Integer MaxRow() const; //! Returns the number of Column of the paragraph .
Standard_EXPORT Standard_Integer MaxColumn() const; //! Computes the MinMax of the paragraph if possible.
Standard_EXPORT Standard_Boolean ComputeMinMax() ; Standard_EXPORT virtual void Save(Aspect_FStream& aFStream) const; DEFINE_STANDARD_RTTI(Graphic2d_Paragraph) protected: //! Draws the paragraph .
Standard_EXPORT void Draw(const Handle(Graphic2d_Drawer)& aDrawer) ; //! Returns Standard_True if the paragraph is picked,
//! Standard_False if not.
Standard_EXPORT Standard_Boolean Pick(const Standard_ShortReal X,const Standard_ShortReal Y,const Standard_ShortReal aPrecision,const Handle(Graphic2d_Drawer)& aDrawer) ; private: Standard_ShortReal myX; Standard_ShortReal myY; Standard_ShortReal myXoffset; Standard_ShortReal myYoffset; Aspect_CardinalPoints myOffset; Standard_ShortReal myWidth; Standard_ShortReal myHeight; Standard_ShortReal myAngle; Standard_ShortReal mySlant; Standard_ShortReal mySpacing; Standard_ShortReal myMargin; Standard_ShortReal myScale; Standard_Boolean myIsZoomable; Standard_Integer myFrameColorIndex; Standard_Integer myFrameWidthIndex; Standard_Integer myHidingColorIndex; Standard_Integer myCurrentColorIndex; Standard_Integer myCurrentFontIndex; Standard_ShortReal myCurrentFontHScale; Standard_ShortReal myCurrentFontWScale; Graphic2d_TypeOfAlignment myCurrentAlignment; Standard_Boolean myCurrentUnderline; TColStd_SequenceOfExtendedString myTextStringList; TColStd_SequenceOfInteger myTextDescriptorList; TShort_SequenceOfShortReal myTextXpositionList; TShort_SequenceOfShortReal myTextYpositionList; TShort_SequenceOfShortReal myTextFheightList; TShort_SequenceOfShortReal myTextFoffsetList; TShort_SequenceOfShortReal myTextHScaleList; TShort_SequenceOfShortReal myTextWScaleList; }; // other Inline functions and methods (like "C++: function call" methods) #endif