Main Page | Modules | Class Hierarchy | Class List | Class Members

Ipelet Class Reference
[The Ipelet interface]

Abstract base class for Ipelets. More...

List of all members.

Public Member Functions


Detailed Description

Abstract base class for Ipelets.


Constructor & Destructor Documentation

Ipelet::~Ipelet  )  [pure virtual]
 

Pure virtual destructor.


Member Function Documentation

virtual int Ipelet::IpelibVersion  )  const [pure virtual]
 

Return the version of Ipelib the Ipelet was linked against.

int Ipelet::NumFunctions  )  const [virtual]
 

Return the number of functions implemented by this Ipelet.

The default implementation returns 1.

virtual const char* Ipelet::Label  )  const [pure virtual]
 

Return the label of the Ipelet (to be shown in the menu).

const char * Ipelet::SubLabel int  function  )  const [virtual]
 

Return a label for each function implemented by this Ipelet.

This is not called if NumFunctions returns 1.

const char * Ipelet::KeySequence int  function  )  const [virtual]
 

Return a key sequence to be used as keyboard shortcut for this ipelet.

Null if no shortcut. The default implementation returns null.

virtual void Ipelet::Run int  function,
IpePage page,
IpeletHelper helper
[pure virtual]
 

Run a function from the Ipelet.


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