gtkIOStream  1.7.0
GTK+ << C++ IOStream operators for GTK+. Now with ORBing, numerical computation, audio client and more ...
ClientIOGui Class Reference

#include <JackPortMonitorGui.H>

Inheritance diagram for ClientIOGui:
[legend]
Collaboration diagram for ClientIOGui:
[legend]

Public Member Functions

 ClientIOGui ()
 
 ClientIOGui (string clientName_)
 
virtual ~ClientIOGui ()
 Destructor. More...
 
void renameClient (string clientName_)
 
void setPorts (vector< string > &portNames)
 
void setPorts (map< string, map< string, vector< string > > > &portNames)
 
void reverseHBoxStacking ()
 
string getClientName (void)
 
string getFullPortName (GtkWidget *wid)
 
void clearAllWidgetConnections (void)
 
void addWidgetConnections (GtkWidget *wid, GtkWidget *cWid)
 
GtkWidget * getPortWidget (string portName)
 
string getWidgetsPortName (GtkWidget *wid)
 
map< GtkWidget *, vector< GtkWidget * > > & getInputWidgetConn ()
 
void setupDrag (DragNDrop &dnd)
 
void setupDrop (DragNDrop &dnd)
 
GtkWidget * getClientWidget ()
 
- Public Member Functions inherited from HBox
 HBox ()
 
- Public Member Functions inherited from Box
 Box (void)
 constructor More...
 
Boxoperator<< (BoxIS bis)
 destructor destroys the widget to neatly cleanup. More...
 
Boxoperator<< (Box &b)
 
Boxoperator<< (int val)
 
Boxoperator<< (Box *b)
 
Boxoperator<< (Container &b)
 
Boxoperator<< (Container *b)
 
Boxoperator<< (GtkWidget *b)
 
Boxoperator<< (Widget *w)
 
Boxoperator<< (Widget &w)
 
Boxoperator<< (LinkList< GtkWidget *> &ll)
 
Boxoperator>> (GtkWidget *b)
 
Boxoperator>> (Container *b)
 
Boxoperator>> (Container &b)
 
Boxoperator= (const Box b)
 
- Public Member Functions inherited from BoxIS
 BoxIS (void)
 
 BoxIS (bool expandIn, bool fillIn)
 
 BoxIS (bool expandIn, bool fillIn, bool startIn)
 
void reset (void)
 
void setDefaultStart (bool startIn)
 
void setDefaultExpand (bool expandIn)
 
void setDefaultFill (bool fillIn)
 
BoxISoperator= (BoxIS &bis)
 
BoxISoperator= (const BoxIS bis)
 
void dump (void)
 
- Public Member Functions inherited from Container
void setBorder (unsigned int size)
 
unsigned int getBorder (void)
 
Containeroperator<< (Container &c)
 
Containeroperator<< (Container *c)
 
Containeroperator<< (Widget &w)
 
Containeroperator<< (Widget *w)
 
Containeroperator<< (LinkList< GtkWidget *> &ll)
 
Containeroperator>> (GtkWidget *w)
 
Containeroperator>> (Container *c)
 
Containeroperator>> (Container &c)
 
Containeroperator>> (LinkList< GtkWidget *> &ll)
 
void setChildrensSensitivity (bool sens)
 
bool areAnyChildrensSensitive (void)
 
unsigned int size ()
 
- Public Member Functions inherited from Widget
 Widget ()
 Construcotr. More...
 
 Widget (GtkWidget *w)
 
virtual ~Widget ()
 Destructor. More...
 
GtkWidget * ref (void)
 
void unref (void)
 
GtkWidget * show (void)
 
GtkWidget * hide (void)
 
bool getVisible (void)
 
GtkWidget * getWidget (void)
 
bool getSensitive (void)
 
void setSensitive (bool sens)
 
void getSize (int &width, int &height)
 
virtual void setSize (int width, int height)
 
void getLocationSize (int &x, int &y, int &width, int &height)
 
void queueDraw ()
 
GdkWindow * getWindow ()
 
void connect (const char *event, GCallback callback, gpointer data)
 
void connectAfter (const char *event, GCallback callback, gpointer data)
 
void connectExposeEventCallback (GCallback callback, void *data)
 
void connectExposeEventCallback (GtkWidget *w, GCallback callback, void *data)
 
void connectConfigureEventCallback (GCallback callback, void *data)
 
void connectConfigureEventCallback (GtkWidget *w, GCallback callback, void *data)
 
Widgetoperator<< (DragNDrop &dnd)
 
Widgetoperator>> (DragNDrop &dnd)
 

Private Member Functions

void init ()
 
virtual void dragDataGet (GtkWidget *w, GtkSelectionData *selectionData, guint info)
 

Private Attributes

Buttons clientNameButton
 Button representing all of the half duplex client ports. More...
 
VBox portVBox
 A holder for the port buttons. More...
 
Buttons portButtons
 The clients half duplex ports. either input or output. More...
 
map< GtkWidget *, vector< GtkWidget * > > inputWidgetConnections
 Each of the port buttons map to connected port buttons. More...
 

Additional Inherited Members

- Public Types inherited from Box
enum  {
  EXPAND =1, FILL =2, START =4, RESET =8,
  END =16, NOFILL =32, NOEXPAND =64
}
 
- Public Attributes inherited from BoxIS
bool expand
 Set to expand the box contents. More...
 
bool fill
 Set to fill the box. More...
 
bool start
 Set to pack the start. More...
 
- Protected Member Functions inherited from Box
virtual void pack (GtkWidget *obj)
 
- Protected Member Functions inherited from Widget
virtual bool checkDropValidity (GtkWidget *w, GtkWidget *sourceWidget, int info, const unsigned char *selectionStoredData)
 
virtual bool dragDataReceived (GtkWidget *w, GtkWidget *sourceWidget, int info, const unsigned char *selectionStoredData, int length)
 
virtual void dragLeave (GtkWidget *w, GtkWidget *sourceWidget)
 
virtual bool dragMotion (GtkWidget *w, GtkWidget *sourceWidget, int x, int y)
 
virtual int chooseTheTargetToUse (GtkWidget *w, GtkWidget *sourceWidget, DragNDrop &dnd)
 
virtual void dragDataDelete (GtkWidget *w)
 
virtual void dragBegin (GtkWidget *w)
 
virtual void dragEnd (GtkWidget *w)
 
- Protected Attributes inherited from Widget
GtkWidget * widget
 The container based widget. More...
 

Detailed Description

Each client has a button for all ports, segmented into input and output ports. This class is a half duplex representation of the client. The client name is packed horizontally next to the vertically stacked port box. Dragging a client button or port button will send either the client's name or the client and port name using ':' as the delimiter name when dropped.

Definition at line 33 of file JackPortMonitorGui.H.

Constructor & Destructor Documentation

◆ ClientIOGui() [1/2]

ClientIOGui::ClientIOGui ( )

Construct a half duplex port Gui representation.

Parameters
clientNameThe name of the client this half duplex lane.

Definition at line 25 of file JackPortMonitorGui.C.

Here is the call graph for this function:

◆ ClientIOGui() [2/2]

ClientIOGui::ClientIOGui ( string  clientName_)

Construct a half duplex port Gui representation.

Parameters
clientName_The name of the client this half duplex lane.

Definition at line 29 of file JackPortMonitorGui.C.

Here is the call graph for this function:

◆ ~ClientIOGui()

virtual ClientIOGui::~ClientIOGui ( )
inlinevirtual

Destructor.

Definition at line 61 of file JackPortMonitorGui.H.

Here is the call graph for this function:

Member Function Documentation

◆ addWidgetConnections()

void ClientIOGui::addWidgetConnections ( GtkWidget *  wid,
GtkWidget *  cWid 
)

Add a widget to the connection map for a specific port button widget.

Parameters
widThe port widget whos connected widgets are of interest.
cWidThe widget which is connected to the port wid.

Definition at line 78 of file JackPortMonitorGui.C.

Here is the caller graph for this function:

◆ clearAllWidgetConnections()

void ClientIOGui::clearAllWidgetConnections ( void  )

Clear the list of know widget connections.

Definition at line 74 of file JackPortMonitorGui.C.

Here is the caller graph for this function:

◆ dragDataGet()

void ClientIOGui::dragDataGet ( GtkWidget *  w,
GtkSelectionData *  selectionData,
guint  info 
)
privatevirtual

When the drag widget is dropped, this is executed on the widget from where it drag started.

Parameters
wthe object which is the source of the drag.
selectionDatathe data to send.
infothe info that has been registered with the target in the GtkTargetList.

Reimplemented from Widget.

Definition at line 124 of file JackPortMonitorGui.C.

Here is the call graph for this function:

◆ getClientName()

string ClientIOGui::getClientName ( void  )
inline

Get the client name this class represents.

Returns
The client name.

Definition at line 80 of file JackPortMonitorGui.H.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getClientWidget()

GtkWidget* ClientIOGui::getClientWidget ( )
inline

Return the GtkWidget of the client.

Returns
The client widget on success or NULL if it doesn't exist.

Definition at line 130 of file JackPortMonitorGui.H.

Here is the call graph for this function:

◆ getFullPortName()

string ClientIOGui::getFullPortName ( GtkWidget *  wid)

Given a widget, return the full port name "client:port".

Parameters
widThe port widget to find and create the full port name for.
Returns
A full port name "client:port" or an empty string if not found.

Definition at line 64 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getInputWidgetConn()

map<GtkWidget*, vector<GtkWidget*> >& ClientIOGui::getInputWidgetConn ( )
inline

Get the input widget connections.

Returns
The mapping of all output widgets to this input widget.

Definition at line 115 of file JackPortMonitorGui.H.

Here is the call graph for this function:

◆ getPortWidget()

GtkWidget * ClientIOGui::getPortWidget ( string  portName)

Find the port button widget which has the same name as the portName.

Parameters
portNameThe port name to search for.
Returns
The widget which matches the port name, NULL if not found.

Definition at line 85 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getWidgetsPortName()

string ClientIOGui::getWidgetsPortName ( GtkWidget *  wid)

Get the port name from the widget.

Parameters
widThe port widget whos connected widgets are of interest.
Returns
The port name if found, or an empty string on error.

Definition at line 108 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ init()

void ClientIOGui::init ( void  )
private

Initialiser loads the vBox and shows the hBox.

Definition at line 20 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ renameClient()

void ClientIOGui::renameClient ( string  clientName_)

Definition at line 34 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reverseHBoxStacking()

void ClientIOGui::reverseHBoxStacking ( )

Definition at line 57 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setPorts() [1/2]

void ClientIOGui::setPorts ( vector< string > &  portNames)

Create the widgets for each of the ports.

Parameters
portNameA vector of port names.

Definition at line 41 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setPorts() [2/2]

void ClientIOGui::setPorts ( map< string, map< string, vector< string > > > &  portNames)

Create the widgets for each of the ports.

Parameters
portNamesPorts which are mapped to their connected ports.

Definition at line 49 of file JackPortMonitorGui.C.

Here is the call graph for this function:

◆ setupDrag()

void ClientIOGui::setupDrag ( DragNDrop dnd)

Setup the drag connections for widgets.

Parameters
dndThe drag and drop class.

Definition at line 95 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setupDrop()

void ClientIOGui::setupDrop ( DragNDrop dnd)

Setup the drop connections for widgets.

Parameters
dndThe drag and drop class.

Definition at line 102 of file JackPortMonitorGui.C.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ clientNameButton

Buttons ClientIOGui::clientNameButton
private

Button representing all of the half duplex client ports.

Definition at line 34 of file JackPortMonitorGui.H.

◆ inputWidgetConnections

map<GtkWidget*, vector<GtkWidget*> > ClientIOGui::inputWidgetConnections
private

Each of the port buttons map to connected port buttons.

Definition at line 37 of file JackPortMonitorGui.H.

◆ portButtons

Buttons ClientIOGui::portButtons
private

The clients half duplex ports. either input or output.

Definition at line 36 of file JackPortMonitorGui.H.

◆ portVBox

VBox ClientIOGui::portVBox
private

A holder for the port buttons.

Definition at line 35 of file JackPortMonitorGui.H.


The documentation for this class was generated from the following files:
gtkIOStream: ClientIOGui Class Reference
GTK+ IOStream  Beta