modules/gui/wxwidgets/dialogs/vlvc/vlvc_frame.cpp

VlvcFrame::OnClientUnauth

Returns

void

Parameters

int i_client_id : Id of the client who just signed in or out

Description

Called when a user is unauthorized

OnClientUnauth

Returns

void

Parameters

int id : Id of the user who just signed in or left
void* inst : The instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Used to notify a client has been unauthorized

VlvcFrame::OnButtonSendPress

Returns

void

Parameters

wxCommandEvent& event : Unused

Description

Called when the send button is pressed.

DisableHandBtn

Returns

void

Parameters

void *inst : the instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Used to disable the "Raise hand" button

VlvcFrame::OnStopVlvc

Returns

void

Description

Closes the window

VlvcFrame::OnButtonAuthPress

Returns

void

Parameters

wxCommandEvent& event : Unused

Description

Called when the hand button is pressed.

VlvcFrame::InitControls

Returns

void

Description

Creates all the controls of the window

VlvcFrame::GetSendPanel

Returns

wxPanel* : object corresponding to the Send panel

Parameters

wxFrame *parent : the parent frame

Description

Creates the Send panel.

OnNbClientChange

Returns

void

Parameters

int id : Id of the user who just signed in or left
void* inst : The instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Used to notify a client has joined or left.

OnStopVlvc

Returns

void

Parameters

void* inst : The instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Called when the core module is stopped.

VlvcFrame::VlvcFrame

Parameters

intf_thread_t *p_intf : Thread interface instance
wxWindow *p_parent : Parent window containing this frame

Description

VlvcFrame Constructor

VlvcFrame::OnCoreModuleMessage

Returns

void

Parameters

char *psz_message : the message to be shown
int i_critical : the severity level

Description

Called by the core module to Display a message in a message box.

VlvcFrame::OnNbClientChange

Returns

void

Parameters

int i_client_id : Id of the client who just signed in or out

Description

Called when a new user is connected or a user disconnects.

VlvcFrame::DelUser

Returns

void

Parameters

int i_client_id : client Id of the client to delete

Description

This method is called when a user leaves the conversation.
It generates the event needed to delete the user from the list.

VlvcFrame::EnableAuthBtn

Returns

void

Description

Used to enable the "Authorize" button

VlvcFrame::OnDelUser

Returns

void

Parameters

wxCommandEvent &evt : event object

Description

Event generated to delete a user from the list.

VlvcFrame::AddUser

Returns

void

Parameters

int i_client_id : client Id of the client to add

Description

This method is called when a user is added to the conversation.
It generates the event needed to add the user in the list.

VlvcFrame::ShowMessage

Returns

void

Parameters

char *psz_message : the message to be shown
int i_critical : the severity level

Description

Generates the event needed to display the specified message ina message box.

VlvcFrame::ChatMessage

Returns

void

Parameters

const char *message : the message to be displayed in
the chat textbox
wxColour &color : the color of the message
bool bShowTimeStamp : used to enable or disable the
time for this message.
Default is true.

Description

Displays a message in the Chat window

VlvcFrame::GetChatPanel

Parameters

wxFrame *parent : the parent frame
Returns :
wxPanel* : object corresponding to the Chat panel

Description

Creates the Chat panel.

VlvcFrame::OnButtonStopPress

Returns

void

Parameters

wxCommandEvent& event : Unused

Description

Called when the stop button is pressed.

EnableUnauthBtn

Returns

void

Parameters

void *inst : the instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Used to disable the "Unauthorize" button

VlvcFrame::OnClientAuth

Returns

void

Parameters

int i_client_id : Id of the client who just signed in or out

Description

Called when a user is authorized

OnIncomingChatMessage

Returns

void

Parameters

int i_id_user : Id of the user who sent a message
char *psz_message : Message
int i_message_type : type of the message
void *inst : The instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Used to display a message in the chat area.

VlvcFrame::OnMessage

Returns

void

Parameters

wxCommandEvent &evt : event object

Description

Event generated to display a message box

VlvcFrame::GetMainPanel

Returns

wxPanel* : object corresponding to the main panel

Parameters

wxFrame *parent : the parent frame

Description

Creates the main panel.

VlvcFrame::OnCloseWindow

Returns

void

Parameters

wxCloseEvent& event : Unused

Description

Destroys the window

VlvcFrame::~VlvcFrame

Description

VlvcFrame Destructor

VlvcFrame::GetBtnPanel

Returns

wxPanel* : object corresponding to the buttons panel

Parameters

wxFrame *parent : the parent frame

Description

Creates the buttons panel

VlvcFrame::OnUserListRightClick

Returns

void

Parameters

wxListEvent& WXUNUSED( event ) : unused list event object.

Description

Event generated when the user right-clicks on the user list.

VlvcFrame::EnableUnauthBtn

Returns

void

Description

Used to enable the "Unauthorize" button

VlvcFrame::OnButtonPlayPress

Returns

void

Parameters

wxCommandEvent& event : Unused

Description

Called when the play button is pressed.

VlvcFrame::OnIncomingChatMessage

Returns

void

Parameters

int i_user_id : user who sent the message
const char *psz_message : message
int i_message_type : type of message

Description

Callback wrapped by ::OnIncomingChatMessage(), used by the coremodule when a new chat message arrives. Generates the eventneeded to display the message in the chat area.

VlvcFrame::GetTopPanel

Returns

wxPanel* : object corresponding to the top panel

Parameters

wxFrame *parent : the parent frame

Description

Creates the top panel.

VlvcFrame::ChangeColorUser

Returns

void

Parameters

long i_user_item_id : Id of the user item whose color
will change.
int b_event : the color is different for the
2 events Authorize and Unauthorize.

Description

Change the user color in the list as either authorize or not

EnableAuthBtn

Returns

void

Parameters

void *inst : the instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Used to disable the "Authorize" button

OnClientAuth

Returns

void

Parameters

int id : Id of the user who just signed in or left
void* inst : The instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Used to notify a client has been authorized

VlvcFrame::OnButtonHandPress

Returns

void

Parameters

wxCommandEvent& event : Unused

Description

Called when the hand button is pressed.

OnCoreModuleMessage

Returns

void

Parameters

char *psz_message : message to display
int i_critical : critical level
void *inst : the instance of VlvcFrame

Description

This function is called by the core module to call the classmethod. Used to display a message box.

VlvcFrame::OnButtonUnauthPress

Returns

void

Parameters

wxCommandEvent& event : Unused

Description

Called when the hand button is pressed.

VlvcFrame::OnAddUser

Returns

void

Parameters

wxCommandEvent &evt : event object

Description

Event generated to add a user in the list.

VlvcFrame::GetCbxPanel

Returns

wxPanel* : object corresponding to the combo panel

Parameters

wxFrame *parent : the parent frame

Description

Creates the combo panel

VlvcFrame::DisableHandBtn

Returns

void

Description

Used to disable the "Raise hand" button

VlvcFrame::GetActionPanel

Returns

wxPanel* : object corresponding to the action panel

Parameters

wxFrame *parent : the parent frame

Description

Creates the action panel

VlvcFrame::OnChatMessage

Returns

void

Parameters

wxCommandEvent &evt : event object

Description

Event generated to display a message in the chat area