Package x2go :: Module mimeboxactions :: Class X2goMIMEboxActionSAVEAS
[frames] | no frames]

Class X2goMIMEboxActionSAVEAS

source code

       object --+    
                |    
X2goMIMEboxAction --+
                    |
                   X2goMIMEboxActionSAVEAS

MIME box action that allows saving incoming MIME box files to a local folder. What this MIME box actually does is calling a hook method in the X2goClient instance that can be hi-jacked by one of your application's methods which then can handle the ,,Save as...'' request.

Instance Methods
 
__init__(self, client_instance=None, logger=None, loglevel=56)
This is a meta class and has no functionality as such.
source code
 
do_process(self, mimebox_file, mimebox_dir)
Call an X2goClient hook method (HOOK_open_mimebox_saveas_dialog) that can handle the MIME box's SAVEAS action.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
  __name__ = 'SAVEAS'
  __decription__ = 'Save incoming file as...'

Inherited from X2goMIMEboxAction: __description__

Properties

Inherited from X2goMIMEboxAction: description, name

Inherited from object: __class__

Method Details

__init__(self, client_instance=None, logger=None, loglevel=56)
(Constructor)

source code 

This is a meta class and has no functionality as such. It is used as parent class by »real« X2go MIME box actions.

Parameters:
  • client_instance (instance) - an X2goClient instance, within your customized X2goClient make sure you have a HOOK_open_mimebox_saveas_dialog(filename=<str>) method defined that will actually handle the incoming mimebox file.
  • logger (instance) - you can pass an X2goLogger object to the X2goMIMEboxActionSAVEAS constructor
  • loglevel (int) - if no X2goLogger object has been supplied a new one will be constructed with the given loglevel
Overrides: object.__init__

do_process(self, mimebox_file, mimebox_dir)

source code 

Call an X2goClient hook method (HOOK_open_mimebox_saveas_dialog) that can handle the MIME box's SAVEAS action.

Parameters:
  • mimebox_file (str) - file name as placed in to the MIME box directory
  • mimebox_dir (str) - location of the X2go session's MIME box directory
  • mimebox_file (str) - PDF file name as placed in to the X2go spool directory
Overrides: X2goMIMEboxAction.do_process