GDKAudioFilterRepository Class Reference

Public class for exposing each of the registered filters through a selectable GUI component (in this case, only an OptionMenu is provided). More...

#include <audio_filters.h>

Inheritance diagram for GDKAudioFilterRepository:

[legend]Collaboration diagram for GDKAudioFilterRepository:

[legend]List of all members.

Public Member Functions
	GDKAudioFilterRepository ()
	Constructor for the audio filter repository.
	~GDKAudioFilterRepository ()
	Destructor for the image repository - clears all the registered filters.
void	Register (GDKAudioFilter *filter)
	Register an audio filter.
void	Initialise (GtkOptionMenu *menu, GtkBin *container)
	Initialise the option menu with the current list of registered filters.
GDKAudioFilter *	Get () const
	Get the currently selected audio filter.
void	SelectionChange ()
	Handle attach/detach widgets on last selected/selected items.
Private Attributes
vector< GDKAudioFilter * >	filters
GDKAudioFilter *	selected_filter
GtkOptionMenu *	menu
GtkBin *	container

---

Detailed Description

Public class for exposing each of the registered filters through a selectable GUI component (in this case, only an OptionMenu is provided).

Filters are currently registered in the repositories constructor and added to the OptionMenu provided via the Initialise function.

Additional filters can be registered before an Initialise call (using the Register method), and Initialise can be called many times if necessary.

The Initialise method is called with the menu to contain the selectable entries and a container for the filter specific widget handling.

Definition at line 111 of file audio_filters.h.

---

Constructor & Destructor Documentation

GDKAudioFilterRepository::GDKAudioFilterRepository (   )

Constructor for the audio filter repository. Registers an instance of each known filter for later GUI exposure via the Initialise method. Definition at line 574 of file audio_filters.cc. References Register(). : selected_filter( NULL ), menu( NULL ), container( NULL ) { // Register an instance of each object (adapting raw filters to GDK filters where necessary) Register( new GDKAudioFilterAdapter( new AudioFilterKeep() ) ); Register( new AudioDub() ); Register( new GDKAudioFilterAdapter( new AudioFilterFadeIn() ) ); Register( new GDKAudioFilterAdapter( new AudioFilterFadeOut() ) ); Register( new AudioGain() ); Register( new AudioMix() ); Register( new GDKAudioFilterAdapter( new AudioFilterSilence() ) ); }

GDKAudioFilterRepository::~GDKAudioFilterRepository (   )

Destructor for the image repository - clears all the registered filters. Definition at line 589 of file audio_filters.cc. References filters. { // Remove the filters in the repository for ( unsigned int index = 0; index < filters.size(); index ++ ) delete filters[ index ]; }

---

Member Function Documentation

GDKAudioFilter * GDKAudioFilterRepository::Get (   )  const

Get the currently selected audio filter. Definition at line 633 of file audio_filters.cc. References filters, and menu. Referenced by PageMagick::GetAudioFilter(), and SelectionChange(). { GtkMenu * filterMenu = GTK_MENU( gtk_option_menu_get_menu( menu ) ); GtkWidget *active_item = gtk_menu_get_active( filterMenu ); return filters[ g_list_index( GTK_MENU_SHELL( filterMenu ) ->children, active_item ) ]; }

void GDKAudioFilterRepository::Initialise (  GtkOptionMenu *  menu, GtkBin *  container )

Initialise the option menu with the current list of registered filters. Definition at line 608 of file audio_filters.cc. References filters, on_optionmenu_selected(), and SelectionChange(). Referenced by PageMagick::PageMagick(). { // Store these for future reference this->menu = menu; this->container = container; // Add the filters to the menu GtkMenu *menu_new = GTK_MENU( gtk_menu_new( ) ); for ( unsigned int index = 0; index < filters.size(); index ++ ) { GtkWidget *item = gtk_menu_item_new_with_label( filters[ index ] ->GetDescription( ) ); gtk_widget_show( item ); gtk_menu_append( menu_new, item ); g_signal_connect( G_OBJECT( item ), "activate", G_CALLBACK( on_optionmenu_selected ), this ); } gtk_menu_set_active( menu_new, 0 ); gtk_option_menu_set_menu( menu, GTK_WIDGET( menu_new ) ); // Register the selected items widgets SelectionChange(); }

void GDKAudioFilterRepository::Register (  GDKAudioFilter *  filter  )

Register an audio filter. Definition at line 599 of file audio_filters.cc. References filters, and AudioFilter::GetDescription(). Referenced by GDKAudioFilterRepository(), and PluginAudioFilterRepository::InstallPlugins(). { std::cerr << ">>> Audio Filter: " << filter->GetDescription() << std::endl; filters.push_back( filter ); }

void GDKAudioFilterRepository::SelectionChange (   )

Handle attach/detach widgets on last selected/selected items. Definition at line 643 of file audio_filters.cc. References GDKAudioFilter::AttachWidgets(), common, container, GDKAudioFilter::DetachWidgets(), Get(), KinoCommon::getPageMagick(), PageMagick::IsPreviewing(), selected_filter, and PageMagick::StopPreview(). Referenced by Initialise(). { bool isPreviewing = false; PageMagick* magick = 0; if ( common && common->getPageMagick( ) ) magick = common->getPageMagick( ); if ( magick && magick->IsPreviewing() ) { isPreviewing = true; magick->StopPreview(); } // Detach the selected filters widgets if ( selected_filter != NULL ) selected_filter->DetachWidgets( container ); // Get the new selection selected_filter = Get(); // Attach the new filters widgets if ( selected_filter != NULL ) selected_filter->AttachWidgets( container ); if ( magick ) { if ( isPreviewing ) magick->StartPreview(); else magick->PreviewFrame(); } }

---

Member Data Documentation

GtkBin* GDKAudioFilterRepository::container [private]

Definition at line 117 of file audio_filters.h. Referenced by SelectionChange().

vector<GDKAudioFilter *> GDKAudioFilterRepository::filters [private]

Definition at line 114 of file audio_filters.h. Referenced by Get(), Initialise(), Register(), and ~GDKAudioFilterRepository().

GtkOptionMenu* GDKAudioFilterRepository::menu [private]

Definition at line 116 of file audio_filters.h. Referenced by Get().

GDKAudioFilter* GDKAudioFilterRepository::selected_filter [private]

Definition at line 115 of file audio_filters.h. Referenced by SelectionChange().

---

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

• audio_filters.h
• audio_filters.cc

---