AxMediaCtrlPanel Class Reference
[AxTk resource classes]

A player window for audio and video files. More...

#include <ax_resource/ax_mediactrlpanel.h>

List of all members.

Public Types

enum {
ID_MEDIACTRLPANEL_MEDIACTRL = 17401, ID_MEDIACTRLPANEL_PLAYLIST = 17402, ID_MEDIACTRLPANEL_TIME_SLIDER = 17407, ID_MEDIACTRLPANEL_PREVIOUS = 17403,
ID_MEDIACTRLPANEL_PLAY = 17404, ID_MEDIACTRLPANEL_STOP = 17405, ID_MEDIACTRLPANEL_NEXT = 17406, ID_MEDIACTRLPANEL_VOLUME_SLIDER = 17408
}

Control identifiers. More...

Public Member Functions

AxMediaCtrlPanel ()

Constructors.

AxMediaCtrlPanel (wxWindow *parent, wxWindowID id=SYMBOL_AXMEDIACTRLPANEL_IDNAME, const wxPoint &pos=SYMBOL_AXMEDIACTRLPANEL_POSITION, const wxSize &size=SYMBOL_AXMEDIACTRLPANEL_SIZE, long style=SYMBOL_AXMEDIACTRLPANEL_STYLE)

bool Create (wxWindow *parent, wxWindowID id=SYMBOL_AXMEDIACTRLPANEL_IDNAME, const wxPoint &pos=SYMBOL_AXMEDIACTRLPANEL_POSITION, const wxSize &size=SYMBOL_AXMEDIACTRLPANEL_SIZE, long style=SYMBOL_AXMEDIACTRLPANEL_STYLE)

Creation.

~AxMediaCtrlPanel ()

Destructor.

void Init ()

Initialises member variables.

void CreateControls ()

Creates the controls and sizers.

void SetPlaylist (const wxArrayString &playlist, bool clearFirst=true)

Set current playlist.

void SetPlaylist (const AxResource &playlist, bool clearFirst=true)

int GetCurrentItem () const

Get playlist.

bool Play (int idx=-1)

Play. Choose first if idx is -1.

bool IsPlaying () const

Is the control playing?

bool IsPaused () const

Is the control paused?

bool Pause ()

Pause.

bool Resume ()

Resume.

bool Stop ()

Stop.

void ClearPlaylist ()

Clear playlist.

bool GoToStart ()

Go to start of the current item.

bool GoToEnd ()

Go to end of the current item.

bool GoToNext ()

Go to next item.

bool GoToPrevious ()

Go to previous item.

void OnMediaFinished (wxMediaEvent &event)

Finished.

void OnMediaLoaded (wxMediaEvent &event)

Media event handlers.

bool IsBeingDragged ()

Returns true if the user is dragging the slider.

void Notify (wxTimerEvent &event)

Timer notification.

void OnBeginSeek (wxScrollEvent &event)

void OnEndSeek (wxScrollEvent &event)

int FindByFilename (const wxString &filename) const

Find index of parts by filename.

void SetAutoPlay (bool autoPlay)

bool GetAutoPlay () const

void OnMediactrlpanelPlaylistSelected (wxCommandEvent &event)

wxEVT_COMMAND_LISTBOX_SELECTED event handler for ID_MEDIACTRLPANEL_PLAYLIST

void OnMediactrlpanelPreviousClick (wxCommandEvent &event)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_PREVIOUS

void OnMediactrlpanelPreviousUpdate (wxUpdateUIEvent &event)

wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_PREVIOUS

void OnMediactrlpanelPlayClick (wxCommandEvent &event)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_PLAY

void OnMediactrlpanelPlayUpdate (wxUpdateUIEvent &event)

wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_PLAY

void OnMediactrlpanelStopClick (wxCommandEvent &event)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_STOP

void OnMediactrlpanelStopUpdate (wxUpdateUIEvent &event)

wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_STOP

void OnMediactrlpanelNextClick (wxCommandEvent &event)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_NEXT

void OnMediactrlpanelNextUpdate (wxUpdateUIEvent &event)

wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_NEXT

void OnMediactrlpanelVolumeSliderUpdated (wxCommandEvent &event)

wxEVT_COMMAND_SLIDER_UPDATED event handler for ID_MEDIACTRLPANEL_VOLUME_SLIDER

wxBitmap GetBitmapResource (const wxString &name)

Retrieves bitmap resources.

wxIcon GetIconResource (const wxString &name)

Retrieves icon resources.

Static Public Member Functions

static bool ShowToolTips ()

Should we show tooltips?

Public Attributes

wxMediaCtrl * m_mediaCtrl

wxListBox * m_playlistCtrl

wxSlider * m_timerSliderCtrl

wxButton * m_previousCtrl

wxButton * m_playCtrl

wxButton * m_stopCtrl

wxButton * m_nextCtrl

wxSlider * m_volumeSliderCtrl

AxResource m_playlist

int m_currentItem

bool m_bIsBeingDragged

wxTimer m_timer

bool m_disableUpdates

bool m_autoPlay

AxSelfVoicing m_selfVoicing

Detailed Description

A player window for audio and video files.

Member Enumeration Documentation

anonymous enum

Control identifiers.

Enumerator:

ID_MEDIACTRLPANEL_MEDIACTRL
ID_MEDIACTRLPANEL_PLAYLIST
ID_MEDIACTRLPANEL_TIME_SLIDER
ID_MEDIACTRLPANEL_PREVIOUS
ID_MEDIACTRLPANEL_PLAY
ID_MEDIACTRLPANEL_STOP
ID_MEDIACTRLPANEL_NEXT
ID_MEDIACTRLPANEL_VOLUME_SLIDER

Constructor & Destructor Documentation

AxMediaCtrlPanel::AxMediaCtrlPanel ( )

Constructors.

AxMediaCtrlPanel::AxMediaCtrlPanel	(	wxWindow *	parent,
		wxWindowID	id = `SYMBOL_AXMEDIACTRLPANEL_IDNAME`,
		const wxPoint &	pos = `SYMBOL_AXMEDIACTRLPANEL_POSITION`,
		const wxSize &	size = `SYMBOL_AXMEDIACTRLPANEL_SIZE`,
		long	style = `SYMBOL_AXMEDIACTRLPANEL_STYLE`
	)

AxMediaCtrlPanel::~AxMediaCtrlPanel ( )

Destructor.

Member Function Documentation

void AxMediaCtrlPanel::ClearPlaylist ( )

Clear playlist.

bool AxMediaCtrlPanel::Create	(	wxWindow *	parent,
		wxWindowID	id = `SYMBOL_AXMEDIACTRLPANEL_IDNAME`,
		const wxPoint &	pos = `SYMBOL_AXMEDIACTRLPANEL_POSITION`,
		const wxSize &	size = `SYMBOL_AXMEDIACTRLPANEL_SIZE`,
		long	style = `SYMBOL_AXMEDIACTRLPANEL_STYLE`
	)

Creation.

void AxMediaCtrlPanel::CreateControls ( )

Creates the controls and sizers.

int AxMediaCtrlPanel::FindByFilename ( const wxString & filename ) const

Find index of parts by filename.

bool AxMediaCtrlPanel::GetAutoPlay ( ) const [inline]

wxBitmap AxMediaCtrlPanel::GetBitmapResource ( const wxString & name )

Retrieves bitmap resources.

int AxMediaCtrlPanel::GetCurrentItem ( ) const [inline]

Get playlist.

Get current track

wxIcon AxMediaCtrlPanel::GetIconResource ( const wxString & name )

Retrieves icon resources.

bool AxMediaCtrlPanel::GoToEnd ( )

Go to end of the current item.

bool AxMediaCtrlPanel::GoToNext ( )

Go to next item.

bool AxMediaCtrlPanel::GoToPrevious ( )

Go to previous item.

bool AxMediaCtrlPanel::GoToStart ( )

Go to start of the current item.

void AxMediaCtrlPanel::Init ( )

Initialises member variables.

bool AxMediaCtrlPanel::IsBeingDragged ( )

Returns true if the user is dragging the slider.

bool AxMediaCtrlPanel::IsPaused ( ) const

Is the control paused?

bool AxMediaCtrlPanel::IsPlaying ( ) const

Is the control playing?

void AxMediaCtrlPanel::Notify ( wxTimerEvent & event )

Timer notification.

void AxMediaCtrlPanel::OnBeginSeek ( wxScrollEvent & event )

void AxMediaCtrlPanel::OnEndSeek ( wxScrollEvent & event )

void AxMediaCtrlPanel::OnMediactrlpanelNextClick ( wxCommandEvent & event )

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_NEXT

void AxMediaCtrlPanel::OnMediactrlpanelNextUpdate ( wxUpdateUIEvent & event )

wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_NEXT

void AxMediaCtrlPanel::OnMediactrlpanelPlayClick ( wxCommandEvent & event )

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_PLAY

void AxMediaCtrlPanel::OnMediactrlpanelPlaylistSelected ( wxCommandEvent & event )

wxEVT_COMMAND_LISTBOX_SELECTED event handler for ID_MEDIACTRLPANEL_PLAYLIST

void AxMediaCtrlPanel::OnMediactrlpanelPlayUpdate ( wxUpdateUIEvent & event )

wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_PLAY

void AxMediaCtrlPanel::OnMediactrlpanelPreviousClick ( wxCommandEvent & event )

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_PREVIOUS

void AxMediaCtrlPanel::OnMediactrlpanelPreviousUpdate ( wxUpdateUIEvent & event )

wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_PREVIOUS

void AxMediaCtrlPanel::OnMediactrlpanelStopClick ( wxCommandEvent & event )

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_STOP

void AxMediaCtrlPanel::OnMediactrlpanelStopUpdate ( wxUpdateUIEvent & event )

wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_STOP

void AxMediaCtrlPanel::OnMediactrlpanelVolumeSliderUpdated ( wxCommandEvent & event )

wxEVT_COMMAND_SLIDER_UPDATED event handler for ID_MEDIACTRLPANEL_VOLUME_SLIDER

void AxMediaCtrlPanel::OnMediaFinished ( wxMediaEvent & event )

Finished.

void AxMediaCtrlPanel::OnMediaLoaded ( wxMediaEvent & event )

Media event handlers.

bool AxMediaCtrlPanel::Pause ( )

Pause.

bool AxMediaCtrlPanel::Play ( int idx = -1 )

Play. Choose first if idx is -1.

bool AxMediaCtrlPanel::Resume ( )

Resume.

void AxMediaCtrlPanel::SetAutoPlay ( bool autoPlay ) [inline]

void AxMediaCtrlPanel::SetPlaylist	(	const AxResource &	playlist,
		bool	clearFirst = `true`
	)

void AxMediaCtrlPanel::SetPlaylist	(	const wxArrayString &	playlist,
		bool	clearFirst = `true`
	)

Set current playlist.

static bool AxMediaCtrlPanel::ShowToolTips ( ) [static]

Should we show tooltips?

bool AxMediaCtrlPanel::Stop ( )

Stop.

Member Data Documentation

bool AxMediaCtrlPanel::m_autoPlay

bool AxMediaCtrlPanel::m_bIsBeingDragged

int AxMediaCtrlPanel::m_currentItem

bool AxMediaCtrlPanel::m_disableUpdates

wxMediaCtrl* AxMediaCtrlPanel::m_mediaCtrl

wxButton* AxMediaCtrlPanel::m_nextCtrl

wxButton* AxMediaCtrlPanel::m_playCtrl

AxResource AxMediaCtrlPanel::m_playlist

wxListBox* AxMediaCtrlPanel::m_playlistCtrl

wxButton* AxMediaCtrlPanel::m_previousCtrl

AxSelfVoicing AxMediaCtrlPanel::m_selfVoicing

wxButton* AxMediaCtrlPanel::m_stopCtrl

wxTimer AxMediaCtrlPanel::m_timer

wxSlider* AxMediaCtrlPanel::m_timerSliderCtrl

wxSlider* AxMediaCtrlPanel::m_volumeSliderCtrl

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

include/ax_resource/ax_mediactrlpanel.h


Public Types
enum	{ ID_MEDIACTRLPANEL_MEDIACTRL = 17401, ID_MEDIACTRLPANEL_PLAYLIST = 17402, ID_MEDIACTRLPANEL_TIME_SLIDER = 17407, ID_MEDIACTRLPANEL_PREVIOUS = 17403, ID_MEDIACTRLPANEL_PLAY = 17404, ID_MEDIACTRLPANEL_STOP = 17405, ID_MEDIACTRLPANEL_NEXT = 17406, ID_MEDIACTRLPANEL_VOLUME_SLIDER = 17408 }
	Control identifiers. More...
Public Member Functions
	AxMediaCtrlPanel ()
	Constructors.
	AxMediaCtrlPanel (wxWindow *parent, wxWindowID id=SYMBOL_AXMEDIACTRLPANEL_IDNAME, const wxPoint &pos=SYMBOL_AXMEDIACTRLPANEL_POSITION, const wxSize &size=SYMBOL_AXMEDIACTRLPANEL_SIZE, long style=SYMBOL_AXMEDIACTRLPANEL_STYLE)
bool	Create (wxWindow *parent, wxWindowID id=SYMBOL_AXMEDIACTRLPANEL_IDNAME, const wxPoint &pos=SYMBOL_AXMEDIACTRLPANEL_POSITION, const wxSize &size=SYMBOL_AXMEDIACTRLPANEL_SIZE, long style=SYMBOL_AXMEDIACTRLPANEL_STYLE)
	Creation.
	~AxMediaCtrlPanel ()
	Destructor.
void	Init ()
	Initialises member variables.
void	CreateControls ()
	Creates the controls and sizers.
void	SetPlaylist (const wxArrayString &playlist, bool clearFirst=true)
	Set current playlist.
void	SetPlaylist (const AxResource &playlist, bool clearFirst=true)
int	GetCurrentItem () const
	Get playlist.
bool	Play (int idx=-1)
	Play. Choose first if idx is -1.
bool	IsPlaying () const
	Is the control playing?
bool	IsPaused () const
	Is the control paused?
bool	Pause ()
	Pause.
bool	Resume ()
	Resume.
bool	Stop ()
	Stop.
void	ClearPlaylist ()
	Clear playlist.
bool	GoToStart ()
	Go to start of the current item.
bool	GoToEnd ()
	Go to end of the current item.
bool	GoToNext ()
	Go to next item.
bool	GoToPrevious ()
	Go to previous item.
void	OnMediaFinished (wxMediaEvent &event)
	Finished.
void	OnMediaLoaded (wxMediaEvent &event)
	Media event handlers.
bool	IsBeingDragged ()
	Returns true if the user is dragging the slider.
void	Notify (wxTimerEvent &event)
	Timer notification.
void	OnBeginSeek (wxScrollEvent &event)
void	OnEndSeek (wxScrollEvent &event)
int	FindByFilename (const wxString &filename) const
	Find index of parts by filename.
void	SetAutoPlay (bool autoPlay)
bool	GetAutoPlay () const
void	OnMediactrlpanelPlaylistSelected (wxCommandEvent &event)
	wxEVT_COMMAND_LISTBOX_SELECTED event handler for ID_MEDIACTRLPANEL_PLAYLIST
void	OnMediactrlpanelPreviousClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_PREVIOUS
void	OnMediactrlpanelPreviousUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_PREVIOUS
void	OnMediactrlpanelPlayClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_PLAY
void	OnMediactrlpanelPlayUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_PLAY
void	OnMediactrlpanelStopClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_STOP
void	OnMediactrlpanelStopUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_STOP
void	OnMediactrlpanelNextClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_MEDIACTRLPANEL_NEXT
void	OnMediactrlpanelNextUpdate (wxUpdateUIEvent &event)
	wxEVT_UPDATE_UI event handler for ID_MEDIACTRLPANEL_NEXT
void	OnMediactrlpanelVolumeSliderUpdated (wxCommandEvent &event)
	wxEVT_COMMAND_SLIDER_UPDATED event handler for ID_MEDIACTRLPANEL_VOLUME_SLIDER
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources.
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources.
Static Public Member Functions
static bool	ShowToolTips ()
	Should we show tooltips?
Public Attributes
wxMediaCtrl *	m_mediaCtrl
wxListBox *	m_playlistCtrl
wxSlider *	m_timerSliderCtrl
wxButton *	m_previousCtrl
wxButton *	m_playCtrl
wxButton *	m_stopCtrl
wxButton *	m_nextCtrl
wxSlider *	m_volumeSliderCtrl
AxResource	m_playlist
int	m_currentItem
bool	m_bIsBeingDragged
wxTimer	m_timer
bool	m_disableUpdates
bool	m_autoPlay
AxSelfVoicing	m_selfVoicing

AxMediaCtrlPanel Class Reference [AxTk resource classes]

Public Types

Public Member Functions