wxVideoControl Class Reference

#include <wxVideoControl.h>

Inheritance diagram for wxVideoControl:

List of all members.

---

Detailed Description

A control panel for frame-by-frame video navigation.

Definition at line 21 of file wxVideoControl.h.

Public Member Functions
	wxVideoControl ()
	Constructor - Default.
	wxVideoControl (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxVSCROLL|wxSUNKEN_BORDER|wxTAB_TRAVERSAL, const wxString &name=wxT("wxVideoControl"))
	Constructor.
bool	Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxVSCROLL|wxSUNKEN_BORDER|wxTAB_TRAVERSAL, const wxString &name=wxT("wxVideoControl"))
	Creation.
	~wxVideoControl ()
	Destructor.
void	Init ()
	Initialises member variables.
void	CreateControls ()
	Creates the controls and sizers.
void	OnSliderTrack (wxScrollEvent &event)
	Event handler.
void	OnSliderChange (wxScrollEvent &event)
	Event handler.
void	OnEnterText (wxCommandEvent &event)
	Event handler.
void	OnButton (wxCommandEvent &event)
	Event handler.
void	OnKeyDown (wxKeyEvent &event)
	Event handler.
void	OnKillTextFocus (wxCommandEvent &event)
	Handle Textbox loss of focus.
unsigned int	num_frames () const
	Return the number of frames.
unsigned int	frame () const
	Return the current frame.
void	set_num_frames (unsigned int num_frames)
	Set the number of frames.
void	set_frame (unsigned int frame, bool send_message=true)
	Set the current frame.
void	next ()
	Advance to next frame.
void	prev ()
	Step to previous frame.
void	play ()
	Start the video playing.
void	pause ()
	Pause the video.
bool	is_playing () const
	Return true if in play mode.
void	attach (vgui_observer *)
	Attach the given observer to receive notify messages.
void	detach (vgui_observer *)
	Detach the given observer.
void	get_observers (vcl_vector< vgui_observer * > &) const
	Returns a list of all the observers for this observable.
virtual void	notify () const
	Broadcast an update to all observers of this class.
virtual void	notify (const vgui_message &) const
	Broadcast a message to all observers of this class.
Static Public Member Functions
static bool	ShowToolTips ()
	Should we show tooltips?.
Static Public Attributes
static const char	m_preview []
	These static memory address are used to identify vgui_message types.
static const char	m_seek []
static const char	m_next []
static const char	m_prev []
static const char	m_play []
static const char	m_pause []
Private Attributes
wxBitmapButton *	prev_button_
wxBitmapButton *	play_button_
wxBitmapButton *	next_button_
wxSlider *	slider_
wxTextCtrl *	frame_text_
unsigned int	frame_
unsigned int	num_frames_
bool	send_messages_
	used to disable sending of message.
bool	is_playing_
	is the video playing.

---

Constructor & Destructor Documentation

wxVideoControl::wxVideoControl

(

)

Constructor - Default.

Definition at line 54 of file wxVideoControl.cxx.

wxVideoControl::wxVideoControl	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxVSCROLL|wxSUNKEN_BORDER|wxTAB_TRAVERSAL,
		const wxString &	name = wxT("wxVideoControl")
	)

Constructor.

Definition at line 61 of file wxVideoControl.cxx.

wxVideoControl::~wxVideoControl

(

)

Destructor.

Definition at line 89 of file wxVideoControl.cxx.

---

Member Function Documentation

bool wxVideoControl::Create	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxVSCROLL|wxSUNKEN_BORDER|wxTAB_TRAVERSAL,
		const wxString &	name = wxT("wxVideoControl")
	)

Creation.

Definition at line 75 of file wxVideoControl.cxx.

void wxVideoControl::Init

(

)

Initialises member variables.

Definition at line 95 of file wxVideoControl.cxx.

void wxVideoControl::CreateControls

(

)

Creates the controls and sizers.

Definition at line 101 of file wxVideoControl.cxx.

void wxVideoControl::OnSliderTrack

(

wxScrollEvent &

event

)

Event handler.

Definition at line 179 of file wxVideoControl.cxx.

void wxVideoControl::OnSliderChange

(

wxScrollEvent &

event

)

Event handler.

Definition at line 195 of file wxVideoControl.cxx.

void wxVideoControl::OnEnterText

(

wxCommandEvent &

event

)

Event handler.

Definition at line 211 of file wxVideoControl.cxx.

void wxVideoControl::OnButton

(

wxCommandEvent &

event

)

Event handler.

Definition at line 234 of file wxVideoControl.cxx.

void wxVideoControl::OnKeyDown

(

wxKeyEvent &

event

)

Event handler.

Definition at line 251 of file wxVideoControl.cxx.

void wxVideoControl::OnKillTextFocus

(

wxCommandEvent &

event

)

Handle Textbox loss of focus.

Note:

the "this" argument is invalid because this must be called from the wxTextCtrl itself

Definition at line 334 of file wxVideoControl.cxx.

unsigned int wxVideoControl::num_frames

(

)

const [inline]

Return the number of frames.

Definition at line 71 of file wxVideoControl.h.

unsigned int wxVideoControl::frame

(

)

const [inline]

Return the current frame.

Definition at line 74 of file wxVideoControl.h.

void wxVideoControl::set_num_frames

(

unsigned int

num_frames

)

Set the number of frames.

Definition at line 144 of file wxVideoControl.cxx.

void wxVideoControl::set_frame	(	unsigned int	frame,
		bool	send_message = true
	)

Set the current frame.

Definition at line 160 of file wxVideoControl.cxx.

void wxVideoControl::next

(

)

Advance to next frame.

Definition at line 257 of file wxVideoControl.cxx.

void wxVideoControl::prev

(

)

Step to previous frame.

Definition at line 275 of file wxVideoControl.cxx.

void wxVideoControl::play

(

)

Start the video playing.

Definition at line 294 of file wxVideoControl.cxx.

void wxVideoControl::pause

(

)

Pause the video.

Definition at line 313 of file wxVideoControl.cxx.

bool wxVideoControl::is_playing

(

)

const [inline]

Return true if in play mode.

Definition at line 95 of file wxVideoControl.h.

bool wxVideoControl::ShowToolTips

(

)

[static]

Should we show tooltips?.

Definition at line 172 of file wxVideoControl.cxx.

void vgui_observable::attach

(

vgui_observer *

)

[inherited]

Attach the given observer to receive notify messages.

Definition at line 27 of file vgui_observable.cxx.

void vgui_observable::detach

(

vgui_observer *

)

[inherited]

Detach the given observer.

Definition at line 32 of file vgui_observable.cxx.

void vgui_observable::get_observers

(

vcl_vector< vgui_observer * > &

)

const [inherited]

Returns a list of all the observers for this observable.

Definition at line 42 of file vgui_observable.cxx.

void vgui_observable::notify

(

)

const [virtual, inherited]

Broadcast an update to all observers of this class.

Definition at line 49 of file vgui_observable.cxx.

void vgui_observable::notify

(

const vgui_message &

)

const [virtual, inherited]

Broadcast a message to all observers of this class.

Definition at line 57 of file vgui_observable.cxx.

---

Member Data Documentation

const char wxVideoControl::m_preview[] [static]

These static memory address are used to identify vgui_message types.

Definition at line 101 of file wxVideoControl.h.

const char wxVideoControl::m_seek[] [static]

Definition at line 102 of file wxVideoControl.h.

const char wxVideoControl::m_next [static]

Definition at line 103 of file wxVideoControl.h.

const char wxVideoControl::m_prev [static]

Definition at line 104 of file wxVideoControl.h.

const char wxVideoControl::m_play [static]

Definition at line 105 of file wxVideoControl.h.

const char wxVideoControl::m_pause [static]

Definition at line 106 of file wxVideoControl.h.

wxBitmapButton* wxVideoControl::prev_button_ [private]

Definition at line 109 of file wxVideoControl.h.

wxBitmapButton* wxVideoControl::play_button_ [private]

Definition at line 110 of file wxVideoControl.h.

wxBitmapButton* wxVideoControl::next_button_ [private]

Definition at line 111 of file wxVideoControl.h.

wxSlider* wxVideoControl::slider_ [private]

Definition at line 112 of file wxVideoControl.h.

wxTextCtrl* wxVideoControl::frame_text_ [private]

Definition at line 113 of file wxVideoControl.h.

unsigned int wxVideoControl::frame_ [private]

Definition at line 115 of file wxVideoControl.h.

unsigned int wxVideoControl::num_frames_ [private]

Definition at line 116 of file wxVideoControl.h.

bool wxVideoControl::send_messages_ [private]

used to disable sending of message.

Definition at line 119 of file wxVideoControl.h.

bool wxVideoControl::is_playing_ [private]

is the video playing.

Definition at line 122 of file wxVideoControl.h.

---

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

• core/vgui/wx/wxVideoControl.h
• core/vgui/wx/wxVideoControl.cxx

---