Ardour  9.0-pre0-582-g084a23a80d
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
ArdourCanvas::Text Class Reference

#include <text.h>

Inheritance diagram for ArdourCanvas::Text:
[legend]

Public Member Functions

 Text (Canvas *)
 
 Text (Item *)
 
 ~Text ()
 
void render (Rect const &, Cairo::RefPtr< Cairo::Context >) const
 
void compute_bounding_box () const
 
void _size_allocate (Rect const &)
 
Gtkmm2ext::Color color () const
 
void set_color (Gtkmm2ext::Color)
 
void set (std::string const &)
 
void set_font_description (Pango::FontDescription)
 
void set_alignment (Pango::Alignment)
 
void clamp_width (double)
 
double width () const
 
double height () const
 
void set_size_chars (int nchars)
 
void dump (std::ostream &) const
 
std::string text () const
 
double text_width () const
 
double text_height () const
 
void set_height_based_on_allocation (bool yn)
 
- Public Member Functions inherited from ArdourCanvas::Item
 Item (Canvas *)
 
 Item (Item *)
 
 Item (Item *, Duple const &p)
 
virtual ~Item ()
 
void redraw () const
 
virtual void prepare_for_render (Rect const &area) const
 
virtual void add_items_at_point (Duple point, std::vector< Item const * > &items) const
 
virtual bool covers (Duple const &point) const
 
void grab ()
 
void ungrab ()
 
void unparent ()
 
void reparent (Item *, bool already_added=false)
 
Item * parent () const
 
uint32_t depth () const
 
const Item * closest_ancestor_with (const Item &other) const
 
bool common_ancestor_within (uint32_t, const Item &other) const
 
bool is_ancestor_of (const Item &candidate) const
 
bool is_descendant_of (const Item &candidate) const
 
void set_position (Duple)
 
void set_x_position (Coord)
 
void set_y_position (Coord)
 
void move (Duple)
 
Duple position () const
 
Duple window_origin () const
 
Duple canvas_origin () const
 
ScrollGroup * scroll_parent () const
 
virtual void size_request (double &w, double &h) const
 
void set_size_request (double w, double h)
 
void set_size_request_to_display_given_text (const std::vector< std::string > &strings, gint hpadding, gint vpadding)
 
void size_allocate (Rect const &)
 
virtual void size_allocate_children (Rect const &r)
 
Rect allocation () const
 
void set_layout_sensitive (bool)
 
bool layout_sensitive () const
 
Rect bounding_box () const
 
Coord height () const
 
Coord width () const
 
Duple item_to_parent (Duple const &) const
 
Rect item_to_parent (Rect const &) const
 
Duple parent_to_item (Duple const &) const
 
Rect parent_to_item (Rect const &) const
 
void canvas_to_item (Coord &, Coord &) const
 
void item_to_canvas (Coord &, Coord &) const
 
Duple canvas_to_item (Duple const &) const
 
Rect item_to_canvas (Rect const &) const
 
Duple item_to_canvas (Duple const &) const
 
Rect canvas_to_item (Rect const &) const
 
Duple item_to_window (Duple const &, bool rounded=true) const
 
Duple window_to_item (Duple const &) const
 
Rect item_to_window (Rect const &, bool rounded=true) const
 
Rect window_to_item (Rect const &) const
 
void raise_to_top ()
 
void raise (int)
 
void lower_to_bottom ()
 
virtual void hide ()
 
virtual void show ()
 
void block_change_notifications ()
 
void unblock_change_notifications ()
 
bool self_visible () const
 
bool visible () const
 
Canvas * canvas () const
 
void set_ignore_events (bool)
 
bool ignore_events () const
 
void set_data (std::string const &, void *)
 
void * get_data (std::string const &) const
 
virtual void add (Item *)
 
virtual void add_front (Item *)
 
virtual void remove (Item *)
 
void clear (bool with_delete=false)
 
std::list< Item * > const & items () const
 
void raise_child_to_top (Item *)
 
void raise_child (Item *, int)
 
void lower_child_to_bottom (Item *)
 
virtual void child_changed (bool bbox_changed)
 
PackOptions pack_options () const
 
void set_pack_options (PackOptions)
 
std::string whoami () const
 
const std::string & tooltip () const
 
void set_tooltip (const std::string &)
 
void start_tooltip_timeout ()
 
void stop_tooltip_timeout ()
 
std::string whatami () const
 
bool resize_queued () const
 
void queue_resize ()
 
bool scroll_translation () const
 
void disable_scroll_translation ()
 
virtual void layout ()
 
Duple position_offset () const
 
- Public Member Functions inherited from ArdourCanvas::Fill
 Fill (Item &self)
 
 Fill (const Fill &)=delete
 
Fill & operator= (const Fill &)=delete
 
virtual ~Fill ()
 
virtual void set_fill_color (Gtkmm2ext::Color)
 
virtual void set_fill (bool)
 
Gtkmm2ext::Color fill_color () const
 
bool fill () const
 
void set_gradient (StopList const &stops, bool is_vertical)
 
void set_pattern (Cairo::RefPtr< Cairo::Pattern >)
 
- Public Member Functions inherited from ArdourCanvas::Outline
 Outline (Item &self)
 
 Outline (const Outline &)=delete
 
Outline & operator= (const Outline &)=delete
 
virtual ~Outline ()
 
Gtkmm2ext::Color outline_color () const
 
virtual void set_outline_color (Gtkmm2ext::Color)
 
Distance outline_width () const
 
virtual void set_outline_width (Distance)
 
bool outline () const
 
virtual void set_outline (bool)
 

Static Public Member Functions

static int font_size_for_height (Distance height, std::string const &font_family, Glib::RefPtr< Pango::Context > const &)
 
static void drop_height_maps ()
 

Private Types

typedef std::map< Distance, int > FontSizeMap
 
typedef std::map< std::string, FontSizeMap > FontSizeMaps
 

Private Member Functions

void _redraw () const
 

Private Attributes

std::string _text
 
Gtkmm2ext::Color _color
 
Pango::FontDescription * _font_description
 
Pango::Alignment _alignment
 
Cairo::RefPtr< Cairo::ImageSurface > _image
 
Duple _origin
 
double _width
 
double _height
 
bool _need_redraw
 
double _width_correction
 
double _clamped_width
 
bool _height_based_on_allocation
 

Static Private Attributes

static FontSizeMaps font_size_maps
 

Additional Inherited Members

- Public Types inherited from ArdourCanvas::Fill
typedef std::vector< std::pair< double, Gtkmm2ext::Color > > StopList
 
- Public Attributes inherited from ArdourCanvas::Item
sigc::signal1< bool, GdkEvent *, EventAccumulator< bool > > Event
 
bool _resize_queued
 
double _requested_width
 
double _requested_height
 
- Static Public Attributes inherited from ArdourCanvas::Item
static int default_items_per_cell
 
- Protected Member Functions inherited from ArdourCanvas::Item
void begin_change ()
 
void end_change ()
 
void begin_visual_change ()
 
void end_visual_change ()
 
void set_bbox_clean () const
 
void set_bbox_dirty () const
 
bool bbox_dirty () const
 
void invalidate_lut () const
 
void clear_items (bool with_delete)
 
void ensure_lut () const
 
void add_child_bounding_boxes (bool include_hidden=false) const
 
void render_children (Rect const &area, Cairo::RefPtr< Cairo::Context > context) const
 
void prepare_for_render_children (Rect const &area) const
 
Duple scroll_offset () const
 
- Protected Member Functions inherited from ArdourCanvas::Fill
void setup_fill_context (Cairo::RefPtr< Cairo::Context >) const
 
void setup_gradient_context (Cairo::RefPtr< Cairo::Context >, Rect const &, Duple const &) const
 
- Protected Member Functions inherited from ArdourCanvas::Outline
void setup_outline_context (Cairo::RefPtr< Cairo::Context >) const
 
- Protected Attributes inherited from ArdourCanvas::Item
Canvas * _canvas
 
Item * _parent
 
ScrollGroup * _scroll_parent
 
Duple _position
 
bool _visible
 
Rect _pre_change_bounding_box
 
Rect _bounding_box
 
PackOptions _pack_options
 
Rect _allocation
 
bool _layout_sensitive
 
std::map< std::string, void * > _data
 
LookupTable * _lut
 
std::list< Item * > _items
 
- Protected Attributes inherited from ArdourCanvas::Fill
Item & _self
 
Gtkmm2ext::Color _fill_color
 
bool _fill
 
bool _transparent
 
StopList _stops
 
bool _vertical_gradient
 
Cairo::RefPtr< Cairo::Pattern > _pattern
 
- Protected Attributes inherited from ArdourCanvas::Outline
Item & _self
 
Gtkmm2ext::Color _outline_color
 
Distance _outline_width
 
bool _outline
 

Detailed Description

Definition at line 34 of file text.h.

Member Typedef Documentation

◆ FontSizeMap

typedef std::map<Distance,int> ArdourCanvas::Text::FontSizeMap
private

Definition at line 85 of file text.h.

◆ FontSizeMaps

typedef std::map<std::string,FontSizeMap> ArdourCanvas::Text::FontSizeMaps
private

Definition at line 86 of file text.h.

Constructor & Destructor Documentation

◆ Text() [1/2]

ArdourCanvas::Text::Text ( Canvas *  )

◆ Text() [2/2]

ArdourCanvas::Text::Text ( Item *  )

◆ ~Text()

ArdourCanvas::Text::~Text ( )

Member Function Documentation

◆ _redraw()

void ArdourCanvas::Text::_redraw ( ) const
private

◆ _size_allocate()

void ArdourCanvas::Text::_size_allocate ( Rect const &  )
virtual

Reimplemented from ArdourCanvas::Item.

◆ clamp_width()

void ArdourCanvas::Text::clamp_width ( double  )

◆ color()

Gtkmm2ext::Color ArdourCanvas::Text::color ( ) const
inline

Definition at line 45 of file text.h.

◆ compute_bounding_box()

void ArdourCanvas::Text::compute_bounding_box ( ) const
virtual

Update _bounding_box and _bounding_box_dirty

Implements ArdourCanvas::Item.

◆ drop_height_maps()

static void ArdourCanvas::Text::drop_height_maps ( )
static

◆ dump()

void ArdourCanvas::Text::dump ( std::ostream &  ) const
virtual

Reimplemented from ArdourCanvas::Item.

◆ font_size_for_height()

static int ArdourCanvas::Text::font_size_for_height ( Distance  height,
std::string const &  font_family,
Glib::RefPtr< Pango::Context > const &   
)
static

◆ height()

double ArdourCanvas::Text::height ( ) const

◆ render()

void ArdourCanvas::Text::render ( Rect const &  area,
Cairo::RefPtr< Cairo::Context >   
) const
virtual

Render this item to a Cairo context.

Parameters
areaArea to draw, in window coordinates

Items must convert their own coordinates into window coordinates because Cairo is limited to a fixed point coordinate space that does not extend as far as the Ardour timeline. All rendering must be done using coordinates that do not exceed the (rough) limits of the canvas' window, to avoid odd errors within Cairo as it converts doubles into its fixed point format and then tesselates the results.

Implements ArdourCanvas::Item.

◆ set()

void ArdourCanvas::Text::set ( std::string const &  )

◆ set_alignment()

void ArdourCanvas::Text::set_alignment ( Pango::Alignment  )

◆ set_color()

void ArdourCanvas::Text::set_color ( Gtkmm2ext::Color  )

◆ set_font_description()

void ArdourCanvas::Text::set_font_description ( Pango::FontDescription  )

◆ set_height_based_on_allocation()

void ArdourCanvas::Text::set_height_based_on_allocation ( bool  yn)

◆ set_size_chars()

void ArdourCanvas::Text::set_size_chars ( int  nchars)

◆ text()

std::string ArdourCanvas::Text::text ( ) const
inline

Definition at line 60 of file text.h.

◆ text_height()

double ArdourCanvas::Text::text_height ( ) const

◆ text_width()

double ArdourCanvas::Text::text_width ( ) const

◆ width()

double ArdourCanvas::Text::width ( ) const

Member Data Documentation

◆ _alignment

Pango::Alignment ArdourCanvas::Text::_alignment
private

Definition at line 73 of file text.h.

◆ _clamped_width

double ArdourCanvas::Text::_clamped_width
private

Definition at line 80 of file text.h.

◆ _color

Gtkmm2ext::Color ArdourCanvas::Text::_color
private

Definition at line 71 of file text.h.

◆ _font_description

Pango::FontDescription* ArdourCanvas::Text::_font_description
private

Definition at line 72 of file text.h.

◆ _height

double ArdourCanvas::Text::_height
mutableprivate

Definition at line 77 of file text.h.

◆ _height_based_on_allocation

bool ArdourCanvas::Text::_height_based_on_allocation
private

Definition at line 81 of file text.h.

◆ _image

Cairo::RefPtr<Cairo::ImageSurface> ArdourCanvas::Text::_image
mutableprivate

Definition at line 74 of file text.h.

◆ _need_redraw

bool ArdourCanvas::Text::_need_redraw
mutableprivate

Definition at line 78 of file text.h.

◆ _origin

Duple ArdourCanvas::Text::_origin
mutableprivate

Definition at line 75 of file text.h.

◆ _text

std::string ArdourCanvas::Text::_text
private

Definition at line 70 of file text.h.

◆ _width

double ArdourCanvas::Text::_width
mutableprivate

Definition at line 76 of file text.h.

◆ _width_correction

double ArdourCanvas::Text::_width_correction
mutableprivate

Definition at line 79 of file text.h.

◆ font_size_maps

FontSizeMaps ArdourCanvas::Text::font_size_maps
staticprivate

Definition at line 88 of file text.h.

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