neoGFX
Cross-platform C++ app/game engine
Loading...
Searching...
No Matches
neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator > Class Template Referenceabstract

#include <glyph_text.hpp>

Inheritance diagram for neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >:
neolib::i_reference_counted

Classes

struct  align_baselines_result
 

Public Types

typedef self_type abstract_type
 
typedef GlyphT value_type
 
typedef value_type const * const_pointer
 
typedef value_typepointer
 
typedef value_type const & const_reference
 
typedef value_typereference
 
typedef ConstIterator const_iterator
 
typedef Iterator iterator
 
typedef std::size_t size_type
 
typedef std::ptrdiff_t difference_type
 

Public Member Functions

virtual void clone (i_ref_ptr< self_type > &aClone) const =0
 
ref_ptr< self_type > clone () const
 
virtual const font & glyph_font () const =0
 
virtual const font & glyph_font (const_reference aGlyphChar) const =0
 
virtual void cache_glyph_font (font_id aFontId) const =0
 
virtual void cache_glyph_font (const font &aFont) const =0
 
virtual const i_glyphglyph (const_reference aGlyphChar) const =0
 
virtual const font & major_font () const =0
 
virtual void set_major_font (const font &aFont)=0
 
virtual scalar baseline () const =0
 
virtual void set_baseline (scalar aBaseline)=0
 
virtual bool empty () const =0
 
virtual size_type size () const =0
 
virtual void clear ()=0
 
virtual void push_back (const_reference aGlyphChar)=0
 
virtual neogfx::size extents () const =0
 
virtual neogfx::size extents (const_reference aGlyphChar) const =0
 
virtual neogfx::size extents (const_iterator aBegin, const_iterator aEnd) const =0
 
virtual void set_extents (const neogfx::size &aExtents)=0
 
virtual self_type & align_baselines ()=0
 
virtual align_baselines_result align_baselines (iterator aBegin, iterator aEnd, bool aJustCalculate=false)=0
 
virtual std::pair< const_iterator, const_iteratorword_break (const_iterator aBegin, const_iterator aFrom) const =0
 
virtual std::pair< iterator, iteratorword_break (const_iterator aBegin, const_iterator aFrom)=0
 
virtual i_vector< size_type > const & line_breaks () const =0
 
virtual i_vector< size_type > & line_breaks ()=0
 
virtual const_iterator cbegin () const =0
 
virtual const_iterator cend () const =0
 
const_iterator begin () const
 
const_iterator end () const
 
virtual iterator begin ()=0
 
virtual iterator end ()=0
 
- Public Member Functions inherited from neolib::i_reference_counted
virtual ~i_reference_counted ()=default
 
virtual void add_ref () const noexcept=0
 
virtual void release () const =0
 
virtual int32_t use_count () const noexcept=0
 
virtual const i_reference_countedrelease_and_take_ownership () const =0
 
virtual i_reference_countedrelease_and_take_ownership ()=0
 
virtual void pin () const noexcept=0
 
virtual void unpin () const =0
 
virtual i_ref_control_blockcontrol_block ()=0
 

Detailed Description

template<typename GlyphT, typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
class neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >

Definition at line 234 of file glyph_text.hpp.

Member Typedef Documentation

◆ abstract_type

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef self_type neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::abstract_type

Definition at line 238 of file glyph_text.hpp.

◆ const_iterator

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef ConstIterator neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::const_iterator

Definition at line 245 of file glyph_text.hpp.

◆ const_pointer

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef value_type const* neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::const_pointer

Definition at line 241 of file glyph_text.hpp.

◆ const_reference

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef value_type const& neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::const_reference

Definition at line 243 of file glyph_text.hpp.

◆ difference_type

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef std::ptrdiff_t neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::difference_type

Definition at line 248 of file glyph_text.hpp.

◆ iterator

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef Iterator neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::iterator

Definition at line 246 of file glyph_text.hpp.

◆ pointer

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef value_type* neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::pointer

Definition at line 242 of file glyph_text.hpp.

◆ reference

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef value_type& neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::reference

Definition at line 244 of file glyph_text.hpp.

◆ size_type

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef std::size_t neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::size_type

Definition at line 247 of file glyph_text.hpp.

◆ value_type

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
typedef GlyphT neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::value_type

Definition at line 240 of file glyph_text.hpp.

Member Function Documentation

◆ align_baselines() [1/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual self_type & neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::align_baselines ( )
pure virtual

◆ align_baselines() [2/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual align_baselines_result neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::align_baselines ( iterator  aBegin,
iterator  aEnd,
bool  aJustCalculate = false 
)
pure virtual

◆ baseline()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual scalar neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::baseline ( ) const
pure virtual

◆ begin() [1/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
const_iterator neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::begin ( ) const
inline

Definition at line 296 of file glyph_text.hpp.

◆ begin() [2/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual iterator neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::begin ( )
pure virtual

◆ cache_glyph_font() [1/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual void neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::cache_glyph_font ( const font &  aFont) const
pure virtual

◆ cache_glyph_font() [2/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual void neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::cache_glyph_font ( font_id  aFontId) const
pure virtual

◆ cbegin()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual const_iterator neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::cbegin ( ) const
pure virtual

◆ cend()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual const_iterator neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::cend ( ) const
pure virtual

◆ clear()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual void neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::clear ( )
pure virtual

◆ clone() [1/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
ref_ptr< self_type > neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::clone ( ) const
inline

Definition at line 257 of file glyph_text.hpp.

◆ clone() [2/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual void neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::clone ( i_ref_ptr< self_type > &  aClone) const
pure virtual

◆ empty()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual bool neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::empty ( ) const
pure virtual

◆ end() [1/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
const_iterator neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::end ( ) const
inline

Definition at line 300 of file glyph_text.hpp.

◆ end() [2/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual iterator neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::end ( )
pure virtual

◆ extents() [1/3]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual neogfx::size neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::extents ( ) const
pure virtual

◆ extents() [2/3]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual neogfx::size neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::extents ( const_iterator  aBegin,
const_iterator  aEnd 
) const
pure virtual

◆ extents() [3/3]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual neogfx::size neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::extents ( const_reference  aGlyphChar) const
pure virtual

◆ glyph()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual const i_glyph & neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::glyph ( const_reference  aGlyphChar) const
pure virtual

◆ glyph_font() [1/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual const font & neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::glyph_font ( ) const
pure virtual

◆ glyph_font() [2/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual const font & neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::glyph_font ( const_reference  aGlyphChar) const
pure virtual

◆ line_breaks() [1/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual i_vector< size_type > const & neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::line_breaks ( ) const
pure virtual

◆ line_breaks() [2/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual i_vector< size_type > & neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::line_breaks ( )
pure virtual

◆ major_font()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual const font & neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::major_font ( ) const
pure virtual

◆ push_back()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual void neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::push_back ( const_reference  aGlyphChar)
pure virtual

◆ set_baseline()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual void neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::set_baseline ( scalar  aBaseline)
pure virtual

◆ set_extents()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual void neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::set_extents ( const neogfx::size aExtents)
pure virtual

◆ set_major_font()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual void neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::set_major_font ( const font &  aFont)
pure virtual

◆ size()

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual size_type neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::size ( ) const
pure virtual

◆ word_break() [1/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual std::pair< const_iterator, const_iterator > neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::word_break ( const_iterator  aBegin,
const_iterator  aFrom 
) const
pure virtual

◆ word_break() [2/2]

template<typename GlyphT , typename ConstIterator = GlyphT const*, typename Iterator = GlyphT*>
virtual std::pair< iterator, iterator > neogfx::i_basic_glyph_text< GlyphT, ConstIterator, Iterator >::word_break ( const_iterator  aBegin,
const_iterator  aFrom 
)
pure virtual

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