geany  1.38
About: Geany is a text editor (using GTK2) with basic features of an integrated development environment (syntax highlighting, code folding, symbol name auto-completion, ...). F: office T: editor programming GTK+ IDE
  Fossies Dox: geany-1.38.tar.bz2  ("unofficial" and yet experimental doxygen-generated source code documentation)  
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Scintilla::Surface Class Referenceabstract

A surface abstracts a place to draw. More...

#include <Platform.h>

Inheritance diagram for Scintilla::Surface:
[legend]

Public Types

enum class  GradientOptions { leftToRight , topToBottom }
 

Public Member Functions

 Surface () noexcept=default
 
 Surface (const Surface &)=delete
 
 Surface (Surface &&)=delete
 
Surface & operator= (const Surface &)=delete
 
Surface & operator= (Surface &&)=delete
 
virtual ~Surface ()
 
virtual void Init (WindowID wid)=0
 
virtual void Init (SurfaceID sid, WindowID wid)=0
 
virtual void InitPixMap (int width, int height, Surface *surface_, WindowID wid)=0
 
virtual void Release ()=0
 
virtual bool Initialised ()=0
 
virtual void PenColour (ColourDesired fore)=0
 
virtual int LogPixelsY ()=0
 
virtual int DeviceHeightFont (int points)=0
 
virtual void MoveTo (int x_, int y_)=0
 
virtual void LineTo (int x_, int y_)=0
 
virtual void Polygon (Point *pts, size_t npts, ColourDesired fore, ColourDesired back)=0
 
virtual void RectangleDraw (PRectangle rc, ColourDesired fore, ColourDesired back)=0
 
virtual void FillRectangle (PRectangle rc, ColourDesired back)=0
 
virtual void FillRectangle (PRectangle rc, Surface &surfacePattern)=0
 
virtual void RoundedRectangle (PRectangle rc, ColourDesired fore, ColourDesired back)=0
 
virtual void AlphaRectangle (PRectangle rc, int cornerSize, ColourDesired fill, int alphaFill, ColourDesired outline, int alphaOutline, int flags)=0
 
virtual void GradientRectangle (PRectangle rc, const std::vector< ColourStop > &stops, GradientOptions options)=0
 
virtual void DrawRGBAImage (PRectangle rc, int width, int height, const unsigned char *pixelsImage)=0
 
virtual void Ellipse (PRectangle rc, ColourDesired fore, ColourDesired back)=0
 
virtual void Copy (PRectangle rc, Point from, Surface &surfaceSource)=0
 
virtual void DrawTextNoClip (PRectangle rc, Font &font_, XYPOSITION ybase, const char *s, int len, ColourDesired fore, ColourDesired back)=0
 
virtual void DrawTextClipped (PRectangle rc, Font &font_, XYPOSITION ybase, const char *s, int len, ColourDesired fore, ColourDesired back)=0
 
virtual void DrawTextTransparent (PRectangle rc, Font &font_, XYPOSITION ybase, const char *s, int len, ColourDesired fore)=0
 
virtual void MeasureWidths (Font &font_, const char *s, int len, XYPOSITION *positions)=0
 
virtual XYPOSITION WidthText (Font &font_, const char *s, int len)=0
 
virtual XYPOSITION Ascent (Font &font_)=0
 
virtual XYPOSITION Descent (Font &font_)=0
 
virtual XYPOSITION InternalLeading (Font &font_)=0
 
virtual XYPOSITION Height (Font &font_)=0
 
virtual XYPOSITION AverageCharWidth (Font &font_)=0
 
virtual void SetClip (PRectangle rc)=0
 
virtual void FlushCachedState ()=0
 
virtual void SetUnicodeMode (bool unicodeMode_)=0
 
virtual void SetDBCSMode (int codePage)=0
 

Static Public Member Functions

static Surface * Allocate (int technology)
 

Detailed Description

A surface abstracts a place to draw.

Definition at line 340 of file Platform.h.

Member Enumeration Documentation

◆ GradientOptions

enum class Scintilla::Surface::GradientOptions
strong
Enumerator
leftToRight 
topToBottom 

Definition at line 368 of file Platform.h.

Constructor & Destructor Documentation

◆ Surface() [1/3]

Scintilla::Surface::Surface ( )
defaultnoexcept

◆ Surface() [2/3]

Scintilla::Surface::Surface ( const Surface &  )
delete

◆ Surface() [3/3]

Scintilla::Surface::Surface ( Surface &&  )
delete

◆ ~Surface()

virtual Scintilla::Surface::~Surface ( )
inlinevirtual

Definition at line 347 of file Platform.h.

Member Function Documentation

◆ Allocate()

Surface * Surface::Allocate ( int  technology)
static

Definition at line 964 of file PlatGTK.cxx.

References Scintilla::SurfaceImpl::SurfaceImpl().

Referenced by Scintilla::EditView::AllocateGraphics(), Scintilla::MarginView::AllocateGraphics(), Scintilla::AutoSurface::AutoSurface(), Scintilla::CallTip::CallTipStart(), Scintilla::ScintillaGTK::ExposeCT(), and Scintilla::ScintillaGTK::ExposeTextThis().

◆ AlphaRectangle()

virtual void Scintilla::Surface::AlphaRectangle ( PRectangle  rc,
int  cornerSize,
ColourDesired  fill,
int  alphaFill,
ColourDesired  outline,
int  alphaOutline,
int  flags 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Indicator::Draw(), DrawFrame(), and SimpleAlphaRectangle().

◆ Ascent()

virtual XYPOSITION Scintilla::Surface::Ascent ( Font &  font_)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::CallTip::PaintContents(), and Scintilla::FontRealised::Realise().

◆ AverageCharWidth()

virtual XYPOSITION Scintilla::Surface::AverageCharWidth ( Font &  font_)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::FontRealised::Realise().

◆ Copy()

virtual void Scintilla::Surface::Copy ( PRectangle  rc,
Point  from,
Surface &  surfaceSource 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::EditView::DrawIndentGuide(), Scintilla::Editor::PaintSelMargin(), and Scintilla::EditView::PaintText().

◆ Descent()

virtual XYPOSITION Scintilla::Surface::Descent ( Font &  font_)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::CallTip::PaintContents(), and Scintilla::FontRealised::Realise().

◆ DeviceHeightFont()

virtual int Scintilla::Surface::DeviceHeightFont ( int  points)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::FontRealised::Realise().

◆ DrawRGBAImage()

virtual void Scintilla::Surface::DrawRGBAImage ( PRectangle  rc,
int  width,
int  height,
const unsigned char *  pixelsImage 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Indicator::Draw(), and Scintilla::LineMarker::Draw().

◆ DrawTextClipped()

virtual void Scintilla::Surface::DrawTextClipped ( PRectangle  rc,
Font &  font_,
XYPOSITION  ybase,
const char *  s,
int  len,
ColourDesired  fore,
ColourDesired  back 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::LineMarker::Draw(), DrawBlockCaret(), and DrawTextBlob().

◆ DrawTextNoClip()

virtual void Scintilla::Surface::DrawTextNoClip ( PRectangle  rc,
Font &  font_,
XYPOSITION  ybase,
const char *  s,
int  len,
ColourDesired  fore,
ColourDesired  back 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::EditView::DrawEOLAnnotationText(), Scintilla::EditView::DrawFoldDisplayText(), Scintilla::EditView::DrawForeground(), Scintilla::DrawTextNoClipPhase(), and Scintilla::EditView::FormatRange().

◆ DrawTextTransparent()

virtual void Scintilla::Surface::DrawTextTransparent ( PRectangle  rc,
Font &  font_,
XYPOSITION  ybase,
const char *  s,
int  len,
ColourDesired  fore 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::CallTip::DrawChunk(), Scintilla::EditView::DrawEOLAnnotationText(), Scintilla::EditView::DrawFoldDisplayText(), Scintilla::EditView::DrawForeground(), and Scintilla::DrawTextNoClipPhase().

◆ Ellipse()

virtual void Scintilla::Surface::Ellipse ( PRectangle  rc,
ColourDesired  fore,
ColourDesired  back 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::LineMarker::Draw(), and DrawCircle().

◆ FillRectangle() [1/2]

virtual void Scintilla::Surface::FillRectangle ( PRectangle  rc,
ColourDesired  back 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Indicator::Draw(), Scintilla::LineMarker::Draw(), Scintilla::EditView::DrawAnnotation(), Scintilla::EditView::DrawBackground(), Scintilla::EditView::DrawCarets(), DrawEdgeLine(), Scintilla::EditView::DrawEOL(), Scintilla::EditView::DrawEOLAnnotationText(), Scintilla::EditView::DrawFoldDisplayText(), DrawFoldLines(), Scintilla::EditView::DrawForeground(), DrawFrame(), DrawMarkUnderline(), DrawMinus(), DrawPlus(), DrawTextBlob(), Scintilla::DrawTextNoClipPhase(), DrawWrapIndentAndMarker(), Scintilla::EditView::FillLineRemainder(), Scintilla::XPM::FillRun(), Scintilla::Editor::Paint(), Scintilla::CallTip::PaintCT(), Scintilla::MarginView::PaintMargin(), and Scintilla::EditView::PaintText().

◆ FillRectangle() [2/2]

virtual void Scintilla::Surface::FillRectangle ( PRectangle  rc,
Surface &  surfacePattern 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

◆ FlushCachedState()

virtual void Scintilla::Surface::FlushCachedState ( )
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::EditView::FormatRange().

◆ GradientRectangle()

virtual void Scintilla::Surface::GradientRectangle ( PRectangle  rc,
const std::vector< ColourStop > &  stops,
GradientOptions  options 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Indicator::Draw().

◆ Height()

virtual XYPOSITION Scintilla::Surface::Height ( Font &  font_)
pure virtual

Implemented in Scintilla::SurfaceImpl.

◆ Init() [1/2]

virtual void Scintilla::Surface::Init ( SurfaceID  sid,
WindowID  wid 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

◆ Init() [2/2]

virtual void Scintilla::Surface::Init ( WindowID  wid)
pure virtual

Implemented in Scintilla::SurfaceImpl.

◆ Initialised()

virtual bool Scintilla::Surface::Initialised ( )
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Editor::PaintSelMargin().

◆ InitPixMap()

virtual void Scintilla::Surface::InitPixMap ( int  width,
int  height,
Surface *  surface_,
WindowID  wid 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

◆ InternalLeading()

virtual XYPOSITION Scintilla::Surface::InternalLeading ( Font &  font_)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::CallTip::PaintContents(), and Scintilla::FontRealised::Realise().

◆ LineTo()

virtual void Scintilla::Surface::LineTo ( int  x_,
int  y_ 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Indicator::Draw(), Scintilla::LineMarker::Draw(), Scintilla::EditView::DrawAnnotation(), Scintilla::EditView::DrawEOLAnnotationText(), Scintilla::EditView::DrawFoldDisplayText(), DrawTabArrow(), Scintilla::DrawWrapMarker(), and Scintilla::CallTip::PaintCT().

◆ LogPixelsY()

virtual int Scintilla::Surface::LogPixelsY ( )
pure virtual

Implemented in Scintilla::SurfaceImpl.

◆ MeasureWidths()

virtual void Scintilla::Surface::MeasureWidths ( Font &  font_,
const char *  s,
int  len,
XYPOSITION *  positions 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::PositionCache::MeasureWidths().

◆ MoveTo()

virtual void Scintilla::Surface::MoveTo ( int  x_,
int  y_ 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Indicator::Draw(), Scintilla::LineMarker::Draw(), Scintilla::EditView::DrawAnnotation(), Scintilla::EditView::DrawEOLAnnotationText(), Scintilla::EditView::DrawFoldDisplayText(), DrawTabArrow(), Scintilla::DrawWrapMarker(), and Scintilla::CallTip::PaintCT().

◆ operator=() [1/2]

Surface & Scintilla::Surface::operator= ( const Surface &  )
delete

◆ operator=() [2/2]

Surface & Scintilla::Surface::operator= ( Surface &&  )
delete

◆ PenColour()

virtual void Scintilla::Surface::PenColour ( ColourDesired  fore)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Indicator::Draw(), Scintilla::LineMarker::Draw(), Scintilla::EditView::DrawAnnotation(), Scintilla::EditView::DrawEOLAnnotationText(), Scintilla::EditView::DrawFoldDisplayText(), Scintilla::EditView::DrawForeground(), Scintilla::DrawWrapMarker(), and Scintilla::CallTip::PaintCT().

◆ Polygon()

virtual void Scintilla::Surface::Polygon ( Point *  pts,
size_t  npts,
ColourDesired  fore,
ColourDesired  back 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Indicator::Draw(), and Scintilla::LineMarker::Draw().

◆ RectangleDraw()

virtual void Scintilla::Surface::RectangleDraw ( PRectangle  rc,
ColourDesired  fore,
ColourDesired  back 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::LineMarker::Draw(), and DrawBox().

◆ Release()

virtual void Scintilla::Surface::Release ( )
pure virtual

Implemented in Scintilla::SurfaceImpl.

◆ RoundedRectangle()

virtual void Scintilla::Surface::RoundedRectangle ( PRectangle  rc,
ColourDesired  fore,
ColourDesired  back 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::LineMarker::Draw().

◆ SetClip()

virtual void Scintilla::Surface::SetClip ( PRectangle  rc)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::Editor::Paint(), and Scintilla::EditView::PaintText().

◆ SetDBCSMode()

virtual void Scintilla::Surface::SetDBCSMode ( int  codePage)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::EditView::PaintText().

◆ SetUnicodeMode()

virtual void Scintilla::Surface::SetUnicodeMode ( bool  unicodeMode_)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::EditView::PaintText().

◆ WidthText()

virtual XYPOSITION Scintilla::Surface::WidthText ( Font &  font_,
const char *  s,
int  len 
)
pure virtual

Implemented in Scintilla::SurfaceImpl.

Referenced by Scintilla::LineMarker::Draw(), Scintilla::CallTip::DrawChunk(), Scintilla::EditView::DrawEOLAnnotationText(), Scintilla::EditView::DrawFoldDisplayText(), Scintilla::DrawStyledText(), Scintilla::EditView::FormatRange(), Scintilla::MarginView::PaintMargin(), Scintilla::FontRealised::Realise(), Scintilla::ViewStyle::Refresh(), Scintilla::Editor::TextWidth(), Scintilla::WidestLineWidth(), and Scintilla::WidthStyledText().

The documentation for this class was generated from the following files: