libyui  3.4.2
YGraphPlugin Class Referenceabstract

Abstract base class for simplified access to UI plugins for graph widget. More...

#include <YGraphPlugin.h>

Inheritance diagram for YGraphPlugin:
YUIPlugin

Public Member Functions

virtual YGraphcreateGraph (YWidget *parent, const std::string &filename, const std::string &layoutAlgorithm)=0
 Create a graph widget. More...
 
- Public Member Functions inherited from YUIPlugin
 YUIPlugin (const char *pluginLibBaseName)
 Constructor: Load the specified plugin library from the standard UI plugin directory (/usr/lib/yui/).
 
virtual ~YUIPlugin ()
 Destructor. More...
 
void unload ()
 Unload this plugin. More...
 
void * locateSymbol (const char *symbol)
 Try to locate the specified symbol (function or global variable) in the plugin library. More...
 
bool error () const
 Returns 'true' if there was an error loading the plugin.
 
bool success () const
 Returns 'true' if there was no error loading the plugin.
 
std::string errorMsg () const
 Returns a human readable (but in most cases untranslated) error message if there was an error.
 

Protected Member Functions

 YGraphPlugin (const char *pluginLibBaseName)
 Constructor: Load the specified plugin library from the standard UI plugin directory (/usr/lib/yui/).
 
virtual ~YGraphPlugin ()
 Destructor. More...
 
- Protected Member Functions inherited from YUIPlugin
void * pluginLibHandle ()
 Returns the dlopen() handle of the plugin library.
 
std::string pluginLibBaseName () const
 Returns the base name of the plugin library.
 
std::string pluginLibFullPath () const
 Returns the full path of the plugin library.
 

Detailed Description

Abstract base class for simplified access to UI plugins for graph widget.

Definition at line 37 of file YGraphPlugin.h.

Constructor & Destructor Documentation

◆ ~YGraphPlugin()

virtual YGraphPlugin::~YGraphPlugin ( )
inlineprotectedvirtual

Destructor.

Calls dlclose() which will unload the plugin library if it is no longer used, i.e. if the reference count dlopen() uses reaches 0.

Definition at line 51 of file YGraphPlugin.h.

Member Function Documentation

◆ createGraph()

virtual YGraph* YGraphPlugin::createGraph ( YWidget parent,
const std::string &  filename,
const std::string &  layoutAlgorithm 
)
pure virtual

Create a graph widget.

Derived classes need to implement this.

This might return 0 if the plugin lib could not be loaded or if the appropriate symbol could not be located in the plugin lib.


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