Ardour  9.0-pre0-582-g084a23a80d
ArdourCanvas::StatefulImage Class Reference

#include <stateful_image.h>

Inheritance diagram for ArdourCanvas::StatefulImage:
[legend]

Classes

class  State
 

Public Member Functions

 StatefulImage (Canvas *, const XMLNode &)
 
 StatefulImage (Item *, const XMLNode &)
 
 ~StatefulImage ()
 
bool set_state (States::size_type)
 
void set_text (const std::string &)
 
void render (Rect const &area, Cairo::RefPtr< Cairo::Context >) const
 
void compute_bounding_box () const
 
- 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)
 
Itemparent () const
 
uint32_t depth () const
 
const Itemclosest_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
 
ScrollGroupscroll_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 (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
 
Canvascanvas () 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 ()
 
virtual void dump (std::ostream &) const
 
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
 
Filloperator= (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
 
Outlineoperator= (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 void set_image_search_path (const std::string &)
 

Private Types

typedef Cairo::RefPtr< Cairo::ImageSurface > ImageHandle
 
typedef std::vector< StateStates
 
typedef std::map< std::string, Cairo::RefPtr< Cairo::ImageSurface > > ImageCache
 

Private Member Functions

int load_states (const XMLNode &)
 

Static Private Member Functions

static ImageHandle find_image (const std::string &)
 

Private Attributes

States _states
 
States::size_type _state
 
std::string _text
 
Pango::FontDescription * _font
 
uint32_t _text_color
 
double _text_x
 
double _text_y
 

Static Private Attributes

static ImageCache _image_cache
 
static PBD::Searchpath _image_search_path
 

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 40 of file stateful_image.h.

Member Typedef Documentation

◆ ImageCache

typedef std::map<std::string,Cairo::RefPtr<Cairo::ImageSurface> > ArdourCanvas::StatefulImage::ImageCache
private

Definition at line 77 of file stateful_image.h.

◆ ImageHandle

typedef Cairo::RefPtr<Cairo::ImageSurface> ArdourCanvas::StatefulImage::ImageHandle
private

Definition at line 43 of file stateful_image.h.

◆ States

typedef std::vector<State> ArdourCanvas::StatefulImage::States
private

Definition at line 50 of file stateful_image.h.

Constructor & Destructor Documentation

◆ StatefulImage() [1/2]

ArdourCanvas::StatefulImage::StatefulImage ( Canvas ,
const XMLNode  
)

◆ StatefulImage() [2/2]

ArdourCanvas::StatefulImage::StatefulImage ( Item ,
const XMLNode  
)

◆ ~StatefulImage()

ArdourCanvas::StatefulImage::~StatefulImage ( )

Member Function Documentation

◆ compute_bounding_box()

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

Update _bounding_box and _bounding_box_dirty

Implements ArdourCanvas::Item.

◆ find_image()

static ImageHandle ArdourCanvas::StatefulImage::find_image ( const std::string &  )
staticprivate

◆ load_states()

int ArdourCanvas::StatefulImage::load_states ( const XMLNode )
private

◆ render()

void ArdourCanvas::StatefulImage::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_image_search_path()

static void ArdourCanvas::StatefulImage::set_image_search_path ( const std::string &  )
static

◆ set_state()

bool ArdourCanvas::StatefulImage::set_state ( States::size_type  )

◆ set_text()

void ArdourCanvas::StatefulImage::set_text ( const std::string &  )

Member Data Documentation

◆ _font

Pango::FontDescription* ArdourCanvas::StatefulImage::_font
private

Definition at line 70 of file stateful_image.h.

◆ _image_cache

ImageCache ArdourCanvas::StatefulImage::_image_cache
staticprivate

Definition at line 78 of file stateful_image.h.

◆ _image_search_path

PBD::Searchpath ArdourCanvas::StatefulImage::_image_search_path
staticprivate

Definition at line 79 of file stateful_image.h.

◆ _state

States::size_type ArdourCanvas::StatefulImage::_state
private

Definition at line 68 of file stateful_image.h.

◆ _states

States ArdourCanvas::StatefulImage::_states
private

Definition at line 67 of file stateful_image.h.

◆ _text

std::string ArdourCanvas::StatefulImage::_text
private

Definition at line 69 of file stateful_image.h.

◆ _text_color

uint32_t ArdourCanvas::StatefulImage::_text_color
private

Definition at line 71 of file stateful_image.h.

◆ _text_x

double ArdourCanvas::StatefulImage::_text_x
private

Definition at line 72 of file stateful_image.h.

◆ _text_y

double ArdourCanvas::StatefulImage::_text_y
private

Definition at line 73 of file stateful_image.h.


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