ApplicationInterface Class Reference

#include <ApplicationInterface.h>

Collaboration diagram for ApplicationInterface:

Collaboration graph
[legend]

Public Member Functions

 ApplicationInterface (MdiInterface *mdiInt)
 ~ApplicationInterface ()
virtual MdiInterface * mdiInterface ()
 Get the MdiInterface pointer. Not very nice method to access at a protected variable.

virtual QIcon * icon (unsigned index=0)
 Get the application icon.

virtual unsigned uniqueId (void *objectPtr)
 Get the unique identifier of selected object Each created object in MDI system have a unique 32 bit identifier.

virtual QWidget * create (unsigned alias=0, AppBatchList &par=AppBatchList())
 Create an application.

virtual QWidget * open (unsigned alias=0, const char *fileNamePath=0, AppBatchList &par=AppBatchList())
 Create an application and load a specific file.

virtual const char * fileName (void *objectPtr)
virtual bool saveAs (const char *filePath, void *objectPtr)
virtual bool save (void *objectPtr)
virtual bool print (void *objectPtr)
virtual void undo (void *objectPtr)
virtual void redo (void *objectPtr)
virtual void cut (void *objectPtr)
virtual void copy (void *objectPtr)
virtual void paste (void *objectPtr)
virtual bool close (void *objectPtr)
virtual void update (void *objectPtr)
virtual void help (unsigned alias=0)
virtual void script (void *sctx)
virtual void basic (void *sctx)

Data Fields

MethodLibrary library

Protected Attributes

MdiInterface * mInt

Constructor & Destructor Documentation

ApplicationInterface::ApplicationInterface (  MdiInterface *  mdiInt  )  [inline]
 

Definition at line 68 of file ApplicationInterface.h.

References mInt.

ApplicationInterface::~ApplicationInterface (   )  [inline]
 

Definition at line 69 of file ApplicationInterface.h.

Member Function Documentation

virtual void ApplicationInterface::basic (  void *  sctx  )  [inline, virtual]
 

Definition at line 176 of file ApplicationInterface.h.

virtual bool ApplicationInterface::close (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 164 of file ApplicationInterface.h.

virtual void ApplicationInterface::copy (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 158 of file ApplicationInterface.h.

virtual QWidget* ApplicationInterface::create (  unsigned  alias = 0,
AppBatchList &  par = AppBatchList()
)  [inline, virtual]
 

Create an application.

Parameters:
alias Alias index
par Parameters list
Returns:
The QWidget pointer of the created application

Usage:

 AppBatchList bl;
 bl << AppComPar("title", "Calorimeter Monitor", "Time (s)", "Temperature (ºC)", "Cell Power (W)");
 // Get the address of the application interface
 ApplicationInterface * plot = mInt->applicationInterface("PLOT2D");
 QWidget * plotWidget = plot->create(0, bl);

Definition at line 124 of file ApplicationInterface.h.

virtual void ApplicationInterface::cut (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 157 of file ApplicationInterface.h.

virtual const char* ApplicationInterface::fileName (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 147 of file ApplicationInterface.h.

virtual void ApplicationInterface::help (  unsigned  alias = 0  )  [inline, virtual]
 

Definition at line 166 of file ApplicationInterface.h.

virtual QIcon* ApplicationInterface::icon (  unsigned  index = 0  )  [inline, virtual]
 

Get the application icon.

Parameters:
index Alias index
Returns:
The QIcon pointer

Usage:

 // Get the address of the application interface
 ApplicationInterface * te = mInt->applicationInterface("TextEditor");
 QIcon * icon = te->icon(0);

Definition at line 84 of file ApplicationInterface.h.

virtual MdiInterface* ApplicationInterface::mdiInterface (   )  [inline, virtual]
 

Get the MdiInterface pointer. Not very nice method to access at a protected variable.

Returns:
MdiInterface pointer

Definition at line 106 of file ApplicationInterface.h.

References mInt.

virtual QWidget* ApplicationInterface::open (  unsigned  alias = 0,
const char *  fileNamePath = 0,
AppBatchList &  par = AppBatchList()
)  [inline, virtual]
 

Create an application and load a specific file.

Parameters:
alias Alias index
fileNamePath File name
par Parameters list
Returns:
The QWidget pointer of the created application

Usage:

 ApplicationInterface * textEditor = mInt->applicationInterface("TextEditor");
 AppBatchList bl;
 bl << AppComPar("clearFilter");
 bl << AppComPar("setFilter", "JS - Java script file (*.js)");
 bl << AppComPar("setHighLighter", "js");
 QWidget * wd = textEditor->open(alias, fileName, bl);

Definition at line 142 of file ApplicationInterface.h.

virtual void ApplicationInterface::paste (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 159 of file ApplicationInterface.h.

virtual bool ApplicationInterface::print (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 150 of file ApplicationInterface.h.

virtual void ApplicationInterface::redo (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 156 of file ApplicationInterface.h.

virtual bool ApplicationInterface::save (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 149 of file ApplicationInterface.h.

virtual bool ApplicationInterface::saveAs (  const char *  filePath,
void *  objectPtr
)  [inline, virtual]
 

Definition at line 148 of file ApplicationInterface.h.

virtual void ApplicationInterface::script (  void *  sctx  )  [inline, virtual]
 

Definition at line 171 of file ApplicationInterface.h.

virtual void ApplicationInterface::undo (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 155 of file ApplicationInterface.h.

virtual unsigned ApplicationInterface::uniqueId (  void *  objectPtr  )  [inline, virtual]
 

Get the unique identifier of selected object Each created object in MDI system have a unique 32 bit identifier.

Parameters:
objectPtr Object pointer
Returns:
Object identifier

Usage:

 // Get the address of the application interface
 ApplicationInterface * rte = mInt->applicationInterface("RichTextEditor");
 unsigned id = te->uniqueId(mInt->selectedWindow());

Definition at line 98 of file ApplicationInterface.h.

virtual void ApplicationInterface::update (  void *  objectPtr  )  [inline, virtual]
 

Definition at line 165 of file ApplicationInterface.h.

Field Documentation

MethodLibrary ApplicationInterface::library
 

Definition at line 179 of file ApplicationInterface.h.

MdiInterface* ApplicationInterface::mInt [protected]
 

Definition at line 182 of file ApplicationInterface.h.

Referenced by ApplicationInterface(), and mdiInterface().

Generated on Thu Jun 22 12:01:33 2017 for Multi Document Interface by doxygen 1.3.1