pqCollaborationPanel is a properties page for the collaborative session. More...

#include <pqCollaborationPanel.h>

Inherits QWidget.

Public Slots
void	writeChatMessage (pqServer *server, int userId, QString &txt)
	Called by pqCollaborationManager when a message is received. More...

void	onUserUpdate ()
	Called by pqCollaborationManager when a user name update occurs (this invalidate the table model) More...

void	onNewMaster (int)
	Called when a new master has been promoted. More...

Signals
void	triggerChatMessage (pqServer *server, int userId, QString &msgContent)
	Emitting this signal will result by adding the message into the UI and if the user is the local one, the message will be broadcasted to the other clients. More...

void	shareLocalMousePointer (bool)
	Emitting this signal when user has allowed its mouse position to be shared and send to the other clients. More...

void	disableFurtherConnections (bool)
	This signal is triggered when user has allowed/disallowed further connections to the server. More...

void	delayUpdateCamera (vtkSMMessage *msg)
	This get triggered internally when it's not a good time to update the camera so the request get pushed to QueuedConnection. More...

void	connectIDChanged (int)
	This signal is triggered when user changes the connect-id. More...

Public Member Functions
	pqCollaborationPanel (QWidget *parent=nullptr)

	~pqCollaborationPanel () override

Protected Slots
void	onUserMessage ()
	Called when user hit enter in the input line of chat message. More...

void	connectViewLocalSlots (pqView *)
	Called when pqView are added/removed so we can listen user interaction. More...

void	disconnectViewLocalSlots (pqView *)

void	stopFollowingCamera ()

void	itemChanged (QTableWidgetItem *item)
	Called when the user change its name (double click in the table on its name) More...

void	cellDoubleClicked (int, int)
	Called when the user double click on any cell. More...

void	followUserCamera (int userId)
	Called when to follow a given user camera. More...

void	onServerChanged ()

void	onConnectIDChanged ()
	Called when the user changes the connect-id. More...

Protected Member Functions
void	promoteToMaster (int masterId)
	Promote a new master. More...

pqCollaborationManager *	getCollaborationManager ()

vtkSMCollaborationManager *	getSMCollaborationManager ()

Protected Attributes
pqInternal *	Internal

Detailed Description

pqCollaborationPanel is a properties page for the collaborative session.

It allows the user to change its name and manage leadership of the session.

Definition at line 21 of file pqCollaborationPanel.h.

Constructor & Destructor Documentation

◆ pqCollaborationPanel()

pqCollaborationPanel::pqCollaborationPanel ( QWidget * parent = nullptr )

◆ ~pqCollaborationPanel()

pqCollaborationPanel::~pqCollaborationPanel ( )

override

Member Function Documentation

◆ triggerChatMessage

void pqCollaborationPanel::triggerChatMessage	(	pqServer *	server,
		int	userId,
		QString &	msgContent
	)

signal

Emitting this signal will result by adding the message into the UI and if the user is the local one, the message will be broadcasted to the other clients.

◆ shareLocalMousePointer

void pqCollaborationPanel::shareLocalMousePointer ( bool )

signal

Emitting this signal when user has allowed its mouse position to be shared and send to the other clients.

◆ disableFurtherConnections

void pqCollaborationPanel::disableFurtherConnections ( bool )

signal

This signal is triggered when user has allowed/disallowed further connections to the server.

◆ delayUpdateCamera

void pqCollaborationPanel::delayUpdateCamera ( vtkSMMessage * msg )

signal

This get triggered internally when it's not a good time to update the camera so the request get pushed to QueuedConnection.

◆ connectIDChanged

void pqCollaborationPanel::connectIDChanged ( int )

signal

This signal is triggered when user changes the connect-id.

◆ writeChatMessage

void pqCollaborationPanel::writeChatMessage	(	pqServer *	server,
		int	userId,
		QString &	txt
	)

slot

Called by pqCollaborationManager when a message is received.

◆ onUserUpdate

void pqCollaborationPanel::onUserUpdate ( )

slot

Called by pqCollaborationManager when a user name update occurs (this invalidate the table model)

◆ onNewMaster

void pqCollaborationPanel::onNewMaster ( int )

slot

Called when a new master has been promoted.

◆ onUserMessage

void pqCollaborationPanel::onUserMessage ( )

protectedslot

Called when user hit enter in the input line of chat message.

◆ connectViewLocalSlots

void pqCollaborationPanel::connectViewLocalSlots ( pqView * )

protectedslot

Called when pqView are added/removed so we can listen user interaction.

◆ disconnectViewLocalSlots

void pqCollaborationPanel::disconnectViewLocalSlots ( pqView * )

protectedslot

◆ stopFollowingCamera

void pqCollaborationPanel::stopFollowingCamera ( )

protectedslot

◆ itemChanged

void pqCollaborationPanel::itemChanged ( QTableWidgetItem * item )

protectedslot

Called when the user change its name (double click in the table on its name)

◆ cellDoubleClicked

void pqCollaborationPanel::cellDoubleClicked	(	int	,
		int
	)

protectedslot

Called when the user double click on any cell.

◆ followUserCamera

void pqCollaborationPanel::followUserCamera ( int userId )

protectedslot

Called when to follow a given user camera.

◆ onServerChanged

void pqCollaborationPanel::onServerChanged ( )

protectedslot

◆ onConnectIDChanged

void pqCollaborationPanel::onConnectIDChanged ( )

protectedslot

Called when the user changes the connect-id.

Emit signal with new value.

◆ promoteToMaster()

void pqCollaborationPanel::promoteToMaster ( int masterId )

protected

Promote a new master.

◆ getCollaborationManager()

pqCollaborationManager* pqCollaborationPanel::getCollaborationManager ( )

protected

◆ getSMCollaborationManager()

vtkSMCollaborationManager* pqCollaborationPanel::getSMCollaborationManager ( )

protected

Member Data Documentation

◆ Internal

pqInternal* pqCollaborationPanel::Internal

protected

Definition at line 123 of file pqCollaborationPanel.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqCollaborationPanel.h

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ pqCollaborationPanel()

◆ ~pqCollaborationPanel()

Member Function Documentation

◆ triggerChatMessage

◆ shareLocalMousePointer

◆ disableFurtherConnections

◆ delayUpdateCamera

◆ connectIDChanged

◆ writeChatMessage

◆ onUserUpdate

◆ onNewMaster

◆ onUserMessage

◆ connectViewLocalSlots

◆ disconnectViewLocalSlots

◆ stopFollowingCamera

◆ itemChanged

◆ cellDoubleClicked

◆ followUserCamera

◆ onServerChanged

◆ onConnectIDChanged

◆ promoteToMaster()

◆ getCollaborationManager()

◆ getSMCollaborationManager()

Member Data Documentation

◆ Internal