Proxy class for a Gui.ViewProviderDocumentObject Server.ViewObject. More...

Inheritance diagram for Server.ViewProviderServerProxy:

Public Member Functions
def	__init__ (self, vp)
	Initialization method for ViewProviderServerProxy. More...

def	onDelete (self, vp, subelements)
	Method called when `FeaturePython` Server is about to be deleted. More...

def	doubleClicked (self, vp)
	Method called when `FeaturePython` Server is double-clicked in the Tree View. More...

def	setupContextMenu (self, vp, menu)
	Method called by the FreeCAD to customize a context menu for a Server. More...

def	getIcon (self)
	Method used to get a path to an icon which will appear in the tree view. More...

def	setProperties (self, vp)
	Method to hide properties and select appropriate icon to show it the Tree View. More...

Detailed Description

Proxy class for a Gui.ViewProviderDocumentObject Server.ViewObject.

A ViewProviderServerProxy instance changes a FeaturePython Server's icon in the Tree view to show if Server is Running or not. It also closes/starts ServerProxy's cmd_server if the FeaturePython is double-clicked, deleted or chosen to be connected/disconnected through its context view. The context view is also provided by this class.

To connect this Proxy object to a Gui.ViewProviderDocumentObject Server.ViewObject do:

a = FreeCAD.ActiveDocument.addObject("Part::FeaturePython", "Server")

ViewProviderServerProxy(a.ViewObject)

Definition at line 236 of file Server.py.

Constructor & Destructor Documentation

◆ init()

def Server.ViewProviderServerProxy.__init__	(	self,
		vp
	)

Initialization method for ViewProviderServerProxy.

A class instance is created and made a Proxy for a generic Gui.ViewProviderDocumentObject Server.ViewObject. This method selects appropriate icon for FeaturePython Server and hides unnecessary unused View properties.

Parameters

vp	A barebone `Gui.ViewProviderDocumentObject` Server.ViewObject.

Definition at line 257 of file Server.py.

     def __init__(self, vp):
         self.setProperties(vp)
         vp.Proxy = self
 

Member Function Documentation

◆ doubleClicked()

def Server.ViewProviderServerProxy.doubleClicked	(	self,
		vp
	)

Method called when FeaturePython Server is double-clicked in the Tree View.

This methods tries to start ServerProxy's cmd_server if it wasn't running and closes it in the opposite case. It shows warning dialogs if something failed. If action is successful, then the icon in the Tree View is changed (You may need to recompute the document to see the change).

Parameters

vp	A double-clicked `Gui.ViewProviderDocumentObject` Server.ViewObject.

Returns: True to specify that it was implemented and executed.

Definition at line 295 of file Server.py.

     def doubleClicked(self, vp):
         if not vp.Object.Running:
             vp.Object.Proxy.cmd_server = com.startServer(vp.Object.Address,
                                                          vp.Object.Port)
             if isinstance(vp.Object.Proxy.cmd_server, int):
                 if vp.Object.Proxy.cmd_server == \
                         com.SERVER_ERROR_INVALID_ADDRESS:
                     QMessageBox.warning(None, 'Error while starting server',
                                         "The address was not in supported "
                                         + "format.")
                 elif vp.Object.Proxy.cmd_server == \
                         com.SERVER_ERROR_PORT_OCCUPIED:
                     QMessageBox.warning(None, 'Error while starting server',
                                         "The port requested is already "
                                         + "occupied.")
             else:
                 vp.Object.setEditorMode("Address", 1)
                 vp.Object.setEditorMode("Port", 1)
                 vp.Object.Running = True
                 self._icon = path.join(PATH_TO_ICONS, "ServerRunning.png")
         elif vp.Object.Running:
             vp.Object.Proxy.cmd_server.close()
             vp.Object.setEditorMode("Address", 0)
             vp.Object.setEditorMode("Port", 0)
             vp.Object.Running = False
             self._icon = path.join(PATH_TO_ICONS, "Server.png")
         return True
 

◆ getIcon()

def Server.ViewProviderServerProxy.getIcon ( self )

Method used to get a path to an icon which will appear in the tree view.

Returns: A path to the icon stored in _icon.

Definition at line 351 of file Server.py.

     def getIcon(self):
         return self._icon
 

◆ onDelete()

def Server.ViewProviderServerProxy.onDelete	(	self,
		vp,
		subelements
	)

Method called when FeaturePython Server is about to be deleted.

This method is used to close ServerProxy's cmd_server as not to leave a Port occupied.

Parameters

vp	A `Gui.ViewProviderDocumentObject` Server.ViewObject being closed.
subelements	An unused argument from C++ binding.

Returns: True to specify that it was implemented and executed.

Definition at line 274 of file Server.py.

     def onDelete(self, vp, subelements):
         if vp.Object.Running:
             FreeCAD.Console.PrintMessage("Deleting server safely.\n")
             vp.Object.Proxy.cmd_server.close()
         return True
 

◆ setProperties()

def Server.ViewProviderServerProxy.setProperties	(	self,
		vp
	)

Method to hide properties and select appropriate icon to show it the Tree View.

This method is called during initialization or document restoration. All unused unnecessary view properties are hidden and icon is chosen in accordance with ServerProxy's Running state.

Parameters

vp	A `Gui.ViewProviderDocumentObject` Server.ViewObject.

Definition at line 364 of file Server.py.

     def setProperties(self, vp):
         vp.setEditorMode("AngularDeflection", 2)
         vp.setEditorMode("BoundingBox", 2)
         vp.setEditorMode("Deviation", 2)
         vp.setEditorMode("DisplayMode", 2)
         vp.setEditorMode("DrawStyle", 2)
         vp.setEditorMode("Lighting", 2)
         vp.setEditorMode("LineColor", 2)
         vp.setEditorMode("LineWidth", 2)
         vp.setEditorMode("PointColor", 2)
         vp.setEditorMode("PointSize", 2)
         vp.setEditorMode("Selectable", 2)
         vp.setEditorMode("SelectionStyle", 2)
         vp.setEditorMode("ShapeColor", 2)
         vp.setEditorMode("Transparency", 2)
         vp.setEditorMode("Visibility", 2)
 
         if vp.Object.Running:
             self._icon = path.join(PATH_TO_ICONS, "ServerRunning.png")
         else:
             self._icon = path.join(PATH_TO_ICONS, "Server.png")
 
 

◆ setupContextMenu()

def Server.ViewProviderServerProxy.setupContextMenu	(	self,
		vp,
		menu
	)

Method called by the FreeCAD to customize a context menu for a Server.

The Transform and Set colors... items are removed from the context menu shown upon right click on FeaturePython Server in the Tree View. The option to Disconnect Server, or Connect Server is added instead.

Parameters

vp	A right-clicked `Gui.ViewProviderDocumentObject` Server.ViewObject.
menu	A Qt's QMenu to be edited.

Definition at line 334 of file Server.py.

     def setupContextMenu(self, vp, menu):
         menu.clear()
         if vp.Object.Running:
             action = menu.addAction("Disconnect Server")
             action.triggered.connect(lambda f=self.doubleClicked,
                                      arg=vp: f(arg))
         else:
             action = menu.addAction("Connect Server")
             action.triggered.connect(lambda f=self.doubleClicked,
                                      arg=vp: f(arg))
 

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

Doxypypy outputs/Server.py

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ doubleClicked()

◆ getIcon()

◆ onDelete()

◆ setProperties()

◆ setupContextMenu()

◆ init()