ArdourKeyboard Class Reference

#include <keyboard.h>

Inheritance diagram for ArdourKeyboard:

Public Member Functions
	ArdourKeyboard (ARDOUR_UI &)
XMLNode &	get_state () const
int	set_state (const XMLNode &, int version)
void	setup_keybindings ()
void	reset_relevant_modifier_key_mask ()
Public Member Functions inherited from Gtkmm2ext::Keyboard
	Keyboard ()
	~Keyboard ()
XMLNode &	get_state () const
int	set_state (const XMLNode &, int version)
bool	key_is_down (uint32_t keyval)
guint	modifier_state ()
bool	leave_window (GdkEventCrossing *ev, Gtk::Window *)
bool	enter_window (GdkEventCrossing *ev, Gtk::Window *)
bool	focus_in_window (GdkEventFocus *ev, Gtk::Window *)
bool	focus_out_window (GdkEventFocus *ev, Gtk::Window *)
int	reset_bindings ()

Static Public Member Functions
static ARDOUR::SelectionOperation	selection_type (guint state)
static bool	indicates_snap (guint state)
static bool	indicates_snap_delta (guint state)
static bool	indicates_copy (guint state)
static bool	indicates_constraint (guint state)
static void	set_constraint_modifier (guint)
static ModifierMask	constraint_modifier ()
static void	set_slip_contents_modifier (guint)
static ModifierMask	slip_contents_modifier ()
static void	set_trim_overlap_modifier (guint)
static ModifierMask	trim_overlap_modifier ()
static void	set_trim_anchored_modifier (guint)
static ModifierMask	trim_anchored_modifier ()
static void	set_fine_adjust_modifier (guint)
static ModifierMask	fine_adjust_modifier ()
static void	set_push_points_modifier (guint)
static ModifierMask	push_points_modifier ()
static void	set_note_size_relative_modifier (guint)
static ModifierMask	note_size_relative_modifier ()
Static Public Member Functions inherited from Gtkmm2ext::Keyboard
static void	reset_relevant_modifier_key_mask ()
static const char *	primary_modifier_name ()
static const char *	secondary_modifier_name ()
static const char *	tertiary_modifier_name ()
static const char *	level4_modifier_name ()
static const char *	primary_modifier_short_name ()
static const char *	secondary_modifier_short_name ()
static const char *	tertiary_modifier_short_name ()
static const char *	level4_modifier_short_name ()
static const char *	button2_name ()
static const char *	momentary_push_name ()
static const char *	group_override_event_name ()
static std::string	format_modifier (uint32_t)
static bool	no_modifier_keys_pressed (GdkEventButton *ev)
static bool	no_modifier_keys_pressed (GdkEventKey *ev)
static bool	modifier_state_contains (guint state, ModifierMask)
static bool	modifier_state_equals (guint state, ModifierMask)
static bool	no_modifiers_active (guint state)
static void	set_copy_modifier (uint32_t newval)
static void	set_range_select_modifier (uint32_t newval)
static void	set_snap_modifier (guint)
static void	set_snap_delta_modifier (guint)
static void	set_edit_button (guint)
static void	set_edit_modifier (guint)
static void	set_delete_button (guint)
static void	set_delete_modifier (guint)
static void	set_insert_note_button (guint)
static void	set_insert_note_modifier (guint)
static ModifierMask	snap_modifier ()
static ModifierMask	snap_delta_modifier ()
static guint	edit_button ()
static guint	edit_modifier ()
static guint	delete_button ()
static guint	delete_modifier ()
static guint	insert_note_button ()
static guint	insert_note_modifier ()
static guint	button2_modifier ()
static guint	momentary_push_modifier ()
static guint	group_override_modifier ()
static bool	is_edit_event (GdkEventButton *)
static bool	is_delete_event (GdkEventButton *)
static bool	is_insert_note_event (GdkEventButton *)
static bool	is_context_menu_event (GdkEventButton *)
static bool	is_button2_event (GdkEventButton *)
static bool	is_momentary_push_event (GdkEventButton *)
static bool	is_group_override_event (GdkEventButton *)
static Keyboard &	the_keyboard ()
static bool	some_magic_widget_has_focus ()
static void	magic_widget_grab_focus ()
static void	magic_widget_drop_focus ()
static Gtk::Window *	get_current_window ()
static bool	close_current_dialog ()
static void	keybindings_changed ()
static void	save_keybindings ()
static void	set_can_save_keybindings (bool yn)
static std::string	current_binding_name ()
static bool	catch_user_event_for_pre_dialog_focus (GdkEvent *ev, Gtk::Window *w)
static bool	load_keybindings (std::string const &path)
static void	save_keybindings (std::string const &path)

Public Attributes
ARDOUR_UI &	ui
Public Attributes inherited from Gtkmm2ext::Keyboard
sigc::signal0< void >	ZoomVerticalModifierReleased

Private Member Functions
void	find_bindings_files (std::map< std::string, std::string > &files)

Static Private Attributes
static guint	constraint_mod
static guint	slip_contents_mod
static guint	trim_overlap_mod
static guint	trim_anchored_mod
static guint	fine_adjust_mod
static guint	push_points_mod
static guint	note_size_relative_mod

Additional Inherited Members
Public Types inherited from Gtkmm2ext::Keyboard
typedef std::vector< uint32_t >	State
typedef uint32_t	ModifierMask
Static Public Attributes inherited from Gtkmm2ext::Keyboard
static const uint32_t	PrimaryModifier
static const uint32_t	SecondaryModifier
static const uint32_t	TertiaryModifier
static const uint32_t	Level4Modifier
static uint32_t	CopyModifier
static uint32_t	RangeSelectModifier
static uint32_t	GainFineScaleModifier
static uint32_t	GainExtraFineScaleModifier
static uint32_t	ScrollZoomVerticalModifier
static uint32_t	ScrollZoomHorizontalModifier
static uint32_t	ScrollHorizontalModifier
static GdkModifierType	RelevantModifierKeyMask
static std::map< std::string, std::string >	binding_files
static std::string	binding_filename_suffix
static const int	close_window_key
static guint	close_window_modifier
static sigc::signal0< void >	RelevantModifierKeysChanged
static sigc::signal1< void, Gtk::Window * >	HideMightMeanQuit
Protected Types inherited from Gtkmm2ext::Keyboard
typedef std::pair< std::string, std::string >	two_strings
Protected Member Functions inherited from Gtkmm2ext::Keyboard
gint	snooper (GtkWidget *, GdkEventKey *)
Static Protected Member Functions inherited from Gtkmm2ext::Keyboard
static gint	_snooper (GtkWidget *, GdkEventKey *, gpointer)
static void	set_modifier (uint32_t newval, uint32_t &variable)
static int	read_keybindings (std::string const &path)
static int	store_keybindings (std::string const &path)
Protected Attributes inherited from Gtkmm2ext::Keyboard
guint	snooper_id
State	state
Static Protected Attributes inherited from Gtkmm2ext::Keyboard
static Keyboard *	_the_keyboard
static guint	edit_but
static guint	edit_mod
static guint	delete_but
static guint	delete_mod
static guint	insert_note_but
static guint	insert_note_mod
static guint	snap_mod
static guint	snap_delta_mod
static guint	button2_modifiers
static guint	momentary_push_modifiers
static guint	group_override_modifiers
static Gtk::Window *	current_window
static std::string	user_keybindings_path
static bool	can_save_keybindings
static bool	bindings_changed_after_save_became_legal
static std::string	_current_binding_name
static bool	_some_magic_widget_has_focus
static Gtk::Window *	pre_dialog_active_window

Detailed Description

Definition at line 35 of file gtk2_ardour/keyboard.h.

Constructor & Destructor Documentation

ArdourKeyboard()

ArdourKeyboard::ArdourKeyboard

(

ARDOUR_UI &

)

Member Function Documentation

constraint_modifier()

static ModifierMask ArdourKeyboard::constraint_modifier ( )

inlinestatic

Returns

Modifier mask to constrain drags in a particular direction;

Definition at line 73 of file gtk2_ardour/keyboard.h.

find_bindings_files()

void ArdourKeyboard::find_bindings_files ( std::map< std::string, std::string > &  files )

private

fine_adjust_modifier()

static ModifierMask ArdourKeyboard::fine_adjust_modifier ( )

inlinestatic

Returns

Modifier mask to fine adjust (control points only atm);

Definition at line 89 of file gtk2_ardour/keyboard.h.

get_state()

XMLNode& ArdourKeyboard::get_state ( ) const

virtual

Implements PBD::Stateful.

indicates_constraint()

static bool ArdourKeyboard::indicates_constraint ( guint  state )

static

Parameters

state

The button state from a GdkEvent.

Returns

true if the modifier state indicates constraint modifier

indicates_copy()

static bool ArdourKeyboard::indicates_copy ( guint  state )

static

Parameters

state

The button state from a GdkEvent.

Returns

true if the modifier state indicates copy modifier

indicates_snap()

static bool ArdourKeyboard::indicates_snap ( guint  state )

static

Parameters

state

The button state from a GdkEvent.

Returns

true if the modifier state indicates snap modifier

indicates_snap_delta()

static bool ArdourKeyboard::indicates_snap_delta ( guint  state )

static

Parameters

state

The button state from a GdkEvent.

Returns

true if the modifier state indicates snap delta

note_size_relative_modifier()

static ModifierMask ArdourKeyboard::note_size_relative_modifier ( )

inlinestatic

Returns

Modifier mask to resize notes relatively;

Definition at line 97 of file gtk2_ardour/keyboard.h.

push_points_modifier()

static ModifierMask ArdourKeyboard::push_points_modifier ( )

inlinestatic

Returns

Modifier mask to push proceeding points;

Definition at line 93 of file gtk2_ardour/keyboard.h.

reset_relevant_modifier_key_mask()

void ArdourKeyboard::reset_relevant_modifier_key_mask

(

)

selection_type()

static ARDOUR::SelectionOperation ArdourKeyboard::selection_type ( guint  state )

static

set_constraint_modifier()

static void ArdourKeyboard::set_constraint_modifier ( guint  )

static

set_fine_adjust_modifier()

static void ArdourKeyboard::set_fine_adjust_modifier ( guint  )

static

set_note_size_relative_modifier()

static void ArdourKeyboard::set_note_size_relative_modifier ( guint  )

static

set_push_points_modifier()

static void ArdourKeyboard::set_push_points_modifier ( guint  )

static

set_slip_contents_modifier()

static void ArdourKeyboard::set_slip_contents_modifier ( guint  )

static

set_state()

int ArdourKeyboard::set_state ( const XMLNode &  , int  version  )

virtual

Implements PBD::Stateful.

set_trim_anchored_modifier()

static void ArdourKeyboard::set_trim_anchored_modifier ( guint  )

static

set_trim_overlap_modifier()

static void ArdourKeyboard::set_trim_overlap_modifier ( guint  )

static

setup_keybindings()

void ArdourKeyboard::setup_keybindings ( )

virtual

Implements Gtkmm2ext::Keyboard.

slip_contents_modifier()

static ModifierMask ArdourKeyboard::slip_contents_modifier ( )

inlinestatic

Returns

Modifier mask to move contents rather than region bounds during trim;

Definition at line 77 of file gtk2_ardour/keyboard.h.

trim_anchored_modifier()

static ModifierMask ArdourKeyboard::trim_anchored_modifier ( )

inlinestatic

Returns

Modifier mask to use anchored trim;

Definition at line 85 of file gtk2_ardour/keyboard.h.

trim_overlap_modifier()

static ModifierMask ArdourKeyboard::trim_overlap_modifier ( )

inlinestatic

Returns

Modifier mask to remove region overlaps during trim;

Definition at line 81 of file gtk2_ardour/keyboard.h.

Member Data Documentation

constraint_mod

guint ArdourKeyboard::constraint_mod

staticprivate

Definition at line 99 of file gtk2_ardour/keyboard.h.

fine_adjust_mod

guint ArdourKeyboard::fine_adjust_mod

staticprivate

Definition at line 103 of file gtk2_ardour/keyboard.h.

note_size_relative_mod

guint ArdourKeyboard::note_size_relative_mod

staticprivate

Definition at line 105 of file gtk2_ardour/keyboard.h.

push_points_mod

guint ArdourKeyboard::push_points_mod

staticprivate

Definition at line 104 of file gtk2_ardour/keyboard.h.

slip_contents_mod

guint ArdourKeyboard::slip_contents_mod

staticprivate

Definition at line 100 of file gtk2_ardour/keyboard.h.

trim_anchored_mod

guint ArdourKeyboard::trim_anchored_mod

staticprivate

Definition at line 102 of file gtk2_ardour/keyboard.h.

trim_overlap_mod

guint ArdourKeyboard::trim_overlap_mod

staticprivate

Definition at line 101 of file gtk2_ardour/keyboard.h.

ui

ARDOUR_UI& ArdourKeyboard::ui

Definition at line 47 of file gtk2_ardour/keyboard.h.

---

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

• gtk2_ardour/keyboard.h