Lumiera  0.pre.03
»edityourfreedom«
ArrowTool Class Reference

#include "gui/widget/timeline/timeline-arrow-tool.hpp"

Description

A helper class to implement the timeline arrow tool.

Definition at line 47 of file timeline-arrow-tool.hpp.

Public Member Functions

 ArrowTool (TimelineBody &timelineBody)
 Constructor. More...
 
ToolType get_type () const
 Gets the type of tool represented by this class. More...
 
- Public Member Functions inherited from Tool
virtual ~Tool ()
 
bool apply_cursor ()
 Re-applies the cursor for the current tool at the current moment. More...
 

Protected Member Functions

Glib::RefPtr< Gdk::Cursor > get_cursor () const
 Gets the cursor to display for this tool at this moment. More...
 
void on_button_press_event (GdkEventButton *event)
 The event handler for button press events. More...
 
void on_button_release_event (GdkEventButton *event)
 The event handler for button release events. More...
 
void on_motion_notify_event (GdkEventMotion *event)
 The event handler for mouse move events. More...
 
- Protected Member Functions inherited from Tool
 Tool (TimelineBody &owner)
 
Gdk::Rectangle get_body_rectangle () const
 Helper function which retrieves the rectangle of the timeline body. More...
 
shared_ptr< TimelineStateget_state () const
 A helper function to get the state. More...
 
gui::widget::TimelineWidgetget_timeline_widget () const
 Helper function which retrieves the pointer to owner timeline widget object, which is the owner of the timeline body. More...
 
TimelineViewWindowview_window () const
 A helper function to get the view window. More...
 

Private Member Functions

shared_ptr< timeline::TrackgetHoveringTrack ()
 

Private Attributes

bool selectionRectangleActive
 

Additional Inherited Members

- Protected Attributes inherited from Tool
bool isDragging
 
Gdk::Point mousePoint
 
TimelineBodytimelineBody
 

Constructor & Destructor Documentation

◆ ArrowTool()

ArrowTool ( TimelineBody timelineBody)

Constructor.

Parameters
timelineBodyThe owner timeline body object

Definition at line 38 of file timeline-arrow-tool.cpp.

Member Function Documentation

◆ get_type()

ToolType get_type ( ) const
virtual

Gets the type of tool represented by this class.

Implements Tool.

Definition at line 45 of file timeline-arrow-tool.cpp.

References gui::widget::timeline::Arrow.

◆ get_cursor()

Glib::RefPtr< Gdk::Cursor > get_cursor ( ) const
protectedvirtual

Gets the cursor to display for this tool at this moment.

Implements Tool.

Definition at line 51 of file timeline-arrow-tool.cpp.

◆ on_button_press_event()

void on_button_press_event ( GdkEventButton *  event)
protectedvirtual

The event handler for button press events.

Reimplemented from Tool.

Definition at line 57 of file timeline-arrow-tool.cpp.

References TimelineWidget::get_state(), ArrowTool::getHoveringTrack(), TimelineBody::getTimelineWidget(), Tool::mousePoint, NULL, Tool::on_button_press_event(), Tool::timelineBody, and TimelineViewWindow::x_to_time().

+ Here is the call graph for this function:

◆ on_button_release_event()

void on_button_release_event ( GdkEventButton *  event)
protectedvirtual

The event handler for button release events.

Reimplemented from Tool.

Definition at line 80 of file timeline-arrow-tool.cpp.

References ArrowTool::getHoveringTrack(), NULL, and Tool::on_button_release_event().

+ Here is the call graph for this function:

◆ on_motion_notify_event()

void on_motion_notify_event ( GdkEventMotion *  event)
protectedvirtual

The event handler for mouse move events.

Reimplemented from Tool.

Definition at line 89 of file timeline-arrow-tool.cpp.

References Tool::isDragging, NULL, and Tool::on_motion_notify_event().

+ Here is the call graph for this function:

◆ getHoveringTrack()

shared_ptr< timeline::Track > getHoveringTrack ( )
private

Definition at line 100 of file timeline-arrow-tool.cpp.

References TimelineWidget::get_hovering_track(), TimelineBody::getTimelineWidget(), and Tool::timelineBody.

Referenced by ArrowTool::on_button_press_event(), and ArrowTool::on_button_release_event().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ selectionRectangleActive

bool selectionRectangleActive
private

Definition at line 88 of file timeline-arrow-tool.hpp.

+ Inheritance diagram for ArrowTool:
+ Collaboration diagram for ArrowTool:

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