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

#include <marker.h>

Inheritance diagram for ArdourMarker:
[legend]

Public Types

enum  Type {
  Mark , Tempo , Meter , BBTPosition ,
  SessionStart , SessionEnd , Section , RangeStart ,
  RangeEnd , LoopStart , LoopEnd , PunchIn ,
  PunchOut , RegionCue , Cue , SelectionStart ,
  SelectionEnd
}
 

Public Member Functions

 ArdourMarker (PublicEditor &editor, ArdourCanvas::Item &, std::string const &color_name, std::string const &text, Type, Temporal::timepos_t const &position, bool handle_events=true, RegionView *rv=nullptr, bool use_tooltip=true)
 
virtual ~ArdourMarker ()
 
ArdourCanvas::Item & the_item () const
 
void set_selected (bool)
 
void set_entered (bool)
 
void set_show_line (bool)
 
void set_line_height (double)
 
virtual void reposition ()
 
virtual void set_position (Temporal::timepos_t const &)
 
void set_name (const std::string &, const std::string &tooltip=std::string())
 
void set_color (std::string const &color_name)
 
void set_points_color (std::string const &color_name)
 
void setup_line ()
 
ARDOUR::timepos_t position () const
 
ArdourCanvas::Item * get_parent ()
 
void reparent (ArdourCanvas::Item &parent)
 
void hide ()
 
void show ()
 
Type type ()
 
void set_left_label_limit (double)
 
void set_right_label_limit (double)
 
std::string name () const
 
bool label_on_left () const
 
RegionView * region_view () const
 
void set_cue_index (int c)
 
int cue_index () const
 

Static Public Member Functions

static void setup_sizes (const double timebar_height)
 

Static Public Attributes

static PBD::Signal< void(ArdourMarker *)> CatchDeletion
 

Protected Member Functions

void setup_line_x ()
 
void setup_name_display ()
 

Protected Attributes

PublicEditor & editor
 
Pango::FontDescription name_font
 
ArdourCanvas::Item * _parent
 
ArdourCanvas::Item * group
 
ArdourCanvas::Circle * _pcue
 
ArdourCanvas::Polygon * _pmark
 
ArdourCanvas::Text * _name_item
 
ArdourCanvas::Points * points
 
ArdourCanvas::Line * _track_canvas_line
 
ArdourCanvas::Rectangle * _name_flag
 
std::string _name
 
double unit_position
 
ARDOUR::timepos_t _position
 
double _shift
 
Type _type
 
int name_height
 
int name_descent
 
bool _selected
 
bool _entered
 
bool _shown
 
bool _line_shown
 
bool _use_tooltip
 
std::string _color
 
std::string _points_color
 
double _left_label_limit
 the number of pixels available to the left of this marker for a label More...
 
double _right_label_limit
 the number of pixels available to the right of this marker for a label More...
 
double _label_offset
 
double _line_height
 
RegionView * _region_view
 
int _cue_index
 

Private Member Functions

 ArdourMarker (ArdourMarker const &)
 
ArdourMarker & operator= (ArdourMarker const &)
 
void apply_color ()
 
void color_handler ()
 

Static Private Member Functions

static uint32_t color (std::string const &)
 

Detailed Description

Location Marker

Editor ruler representation of a location marker or range on the timeline.

Definition at line 54 of file marker.h.

Member Enumeration Documentation

◆ Type

enum ArdourMarker::Type
Enumerator
Mark 
Tempo 
Meter 
BBTPosition 
SessionStart 

session start

SessionEnd 

session end

Section 
RangeStart 
RangeEnd 
LoopStart 
LoopEnd 
PunchIn 
PunchOut 
RegionCue 
Cue 
SelectionStart 
SelectionEnd 

Definition at line 57 of file marker.h.

Constructor & Destructor Documentation

◆ ArdourMarker() [1/2]

ArdourMarker::ArdourMarker ( PublicEditor &  editor,
ArdourCanvas::Item &  ,
std::string const &  color_name,
std::string const &  text,
Type  ,
Temporal::timepos_t const &  position,
bool  handle_events = true,
RegionView *  rv = nullptr,
bool  use_tooltip = true 
)

◆ ~ArdourMarker()

virtual ArdourMarker::~ArdourMarker ( )
virtual

◆ ArdourMarker() [2/2]

ArdourMarker::ArdourMarker ( ArdourMarker const &  )
private

Member Function Documentation

◆ apply_color()

void ArdourMarker::apply_color ( )
private

◆ color()

static uint32_t ArdourMarker::color ( std::string const &  )
staticprivate

◆ color_handler()

void ArdourMarker::color_handler ( )
private

◆ cue_index()

int ArdourMarker::cue_index ( ) const
inline

Definition at line 127 of file marker.h.

◆ get_parent()

ArdourCanvas::Item* ArdourMarker::get_parent ( )
inline

Definition at line 103 of file marker.h.

◆ hide()

void ArdourMarker::hide ( )

◆ label_on_left()

bool ArdourMarker::label_on_left ( ) const

◆ name()

std::string ArdourMarker::name ( ) const
inline

Definition at line 114 of file marker.h.

◆ operator=()

ArdourMarker& ArdourMarker::operator= ( ArdourMarker const &  )
private

◆ position()

ARDOUR::timepos_t ArdourMarker::position ( ) const
inline

Definition at line 101 of file marker.h.

◆ region_view()

RegionView* ArdourMarker::region_view ( ) const
inline

Definition at line 122 of file marker.h.

◆ reparent()

void ArdourMarker::reparent ( ArdourCanvas::Item &  parent)

◆ reposition()

virtual void ArdourMarker::reposition ( )
virtual

Reimplemented in TempoMarker.

◆ set_color()

void ArdourMarker::set_color ( std::string const &  color_name)

◆ set_cue_index()

void ArdourMarker::set_cue_index ( int  c)
inline

Definition at line 126 of file marker.h.

◆ set_entered()

void ArdourMarker::set_entered ( bool  )

◆ set_left_label_limit()

void ArdourMarker::set_left_label_limit ( double  )

◆ set_line_height()

void ArdourMarker::set_line_height ( double  )

◆ set_name()

void ArdourMarker::set_name ( const std::string &  ,
const std::string &  tooltip = std::string() 
)

◆ set_points_color()

void ArdourMarker::set_points_color ( std::string const &  color_name)

◆ set_position()

virtual void ArdourMarker::set_position ( Temporal::timepos_t const &  )
virtual

Reimplemented in BBTMarker.

◆ set_right_label_limit()

void ArdourMarker::set_right_label_limit ( double  )

◆ set_selected()

void ArdourMarker::set_selected ( bool  )

◆ set_show_line()

void ArdourMarker::set_show_line ( bool  )

◆ setup_line()

void ArdourMarker::setup_line ( )

◆ setup_line_x()

void ArdourMarker::setup_line_x ( )
protected

◆ setup_name_display()

void ArdourMarker::setup_name_display ( )
protected

◆ setup_sizes()

static void ArdourMarker::setup_sizes ( const double  timebar_height)
static

◆ show()

void ArdourMarker::show ( )

◆ the_item()

ArdourCanvas::Item& ArdourMarker::the_item ( ) const

◆ type()

Type ArdourMarker::type ( )
inline

Definition at line 109 of file marker.h.

Member Data Documentation

◆ _color

std::string ArdourMarker::_color
protected

Definition at line 156 of file marker.h.

◆ _cue_index

int ArdourMarker::_cue_index
protected

Definition at line 166 of file marker.h.

◆ _entered

bool ArdourMarker::_entered
protected

Definition at line 151 of file marker.h.

◆ _label_offset

double ArdourMarker::_label_offset
protected

Definition at line 161 of file marker.h.

◆ _left_label_limit

double ArdourMarker::_left_label_limit
protected

the number of pixels available to the left of this marker for a label

Definition at line 159 of file marker.h.

◆ _line_height

double ArdourMarker::_line_height
protected

Definition at line 162 of file marker.h.

◆ _line_shown

bool ArdourMarker::_line_shown
protected

Definition at line 153 of file marker.h.

◆ _name

std::string ArdourMarker::_name
protected

Definition at line 143 of file marker.h.

◆ _name_flag

ArdourCanvas::Rectangle* ArdourMarker::_name_flag
protected

Definition at line 141 of file marker.h.

◆ _name_item

ArdourCanvas::Text* ArdourMarker::_name_item
protected

Definition at line 138 of file marker.h.

◆ _parent

ArdourCanvas::Item* ArdourMarker::_parent
protected

Definition at line 134 of file marker.h.

◆ _pcue

ArdourCanvas::Circle* ArdourMarker::_pcue
protected

Definition at line 136 of file marker.h.

◆ _pmark

ArdourCanvas::Polygon* ArdourMarker::_pmark
protected

Definition at line 137 of file marker.h.

◆ _points_color

std::string ArdourMarker::_points_color
protected

Definition at line 157 of file marker.h.

◆ _position

ARDOUR::timepos_t ArdourMarker::_position
protected

Definition at line 145 of file marker.h.

◆ _region_view

RegionView* ArdourMarker::_region_view
protected

Definition at line 164 of file marker.h.

◆ _right_label_limit

double ArdourMarker::_right_label_limit
protected

the number of pixels available to the right of this marker for a label

Definition at line 160 of file marker.h.

◆ _selected

bool ArdourMarker::_selected
protected

Definition at line 150 of file marker.h.

◆ _shift

double ArdourMarker::_shift
protected

Definition at line 146 of file marker.h.

◆ _shown

bool ArdourMarker::_shown
protected

Definition at line 152 of file marker.h.

◆ _track_canvas_line

ArdourCanvas::Line* ArdourMarker::_track_canvas_line
protected

Definition at line 140 of file marker.h.

◆ _type

Type ArdourMarker::_type
protected

Definition at line 147 of file marker.h.

◆ _use_tooltip

bool ArdourMarker::_use_tooltip
protected

Definition at line 154 of file marker.h.

◆ CatchDeletion

PBD::Signal<void(ArdourMarker*)> ArdourMarker::CatchDeletion
static

Definition at line 83 of file marker.h.

◆ editor

PublicEditor& ArdourMarker::editor
protected

Definition at line 130 of file marker.h.

◆ group

ArdourCanvas::Item* ArdourMarker::group
protected

Definition at line 135 of file marker.h.

◆ name_descent

int ArdourMarker::name_descent
protected

Definition at line 149 of file marker.h.

◆ name_font

Pango::FontDescription ArdourMarker::name_font
protected

Definition at line 132 of file marker.h.

◆ name_height

int ArdourMarker::name_height
protected

Definition at line 148 of file marker.h.

◆ points

ArdourCanvas::Points* ArdourMarker::points
protected

Definition at line 139 of file marker.h.

◆ unit_position

double ArdourMarker::unit_position
protected

Definition at line 144 of file marker.h.

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