HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UT_HelpManager Class Referenceabstract

#include <UT_HelpManager.h>

Public Member Functions

 UT_HelpManager ()
 
virtual ~UT_HelpManager ()
 
virtual void openContents ()=0
 
virtual void openStartup ()=0
 
virtual void openFile (const char *path)=0
 
virtual void openURL (const char *url)=0
 
virtual void openHelpPath (const char *help_path)=0
 
virtual void displayData (const char *data, bool is_html)=0
 
virtual bool getTooltip (const char *url, UT_String &tooltip)=0
 Obtains a tool tip from the help page pointed to by the URL. More...
 
virtual bool getTooltip (const PRM_Parm *parm, UT_String &tooltip)=0
 Obtains a tool tip for the specified parameter. More...
 
virtual bool getParsedTooltip (const char *url_key, const char *full_help, UT_String &tooltip)=0
 
virtual void openHelpCard (OP_Node *node)=0
 
virtual void openHelpCard (OP_Operator *op, const char *node_path=nullptr)=0
 
virtual void openHelpCard (BM_State *state)=0
 
virtual void openHelpCard (SHLF_Tool *tool)=0
 
virtual void openHelpCard (const PYP_Interface *interface)=0
 
virtual void openHelpCard (OP_GalleryEntry *entry)=0
 
virtual void openHelpCard (const PRM_ScriptParm *prop)=0
 
virtual void getHelpCardURL (OP_Operator *op, UT_String &str)=0
 
virtual void getHelpCardURL (BM_State *state, UT_String &url)=0
 
virtual void getHelpCardURL (SHLF_Tool *tool, UT_String &url)=0
 
virtual void getHelpCardURL (const PYP_Interface *interface, UT_String &url)=0
 
virtual void getHelpCardURL (OP_GalleryEntry *entry, UT_String &url)=0
 
virtual void getHelpCardURL (const PRM_ScriptParm *prop, UT_String &url)=0
 
virtual void getHelpCardURL (const char *helpTopicId, UT_String &url)=0
 
virtual void getHelpCardURL (const PRM_Parm *parm, UT_String &url)=0
 
virtual void setBaseURI (const char *base_uri)=0
 
virtual const UT_StringgetBaseURI () const =0
 
virtual bool getUseExternalHelp () const =0
 
virtual void setUseExternalHelp (bool use_external)=0
 
virtual const UT_StringgetExternalHelpURL () const =0
 
virtual void setExternalHelpURL (const char *ext_help_url)=0
 
virtual const UT_StringgetHelpBaseURL ()=0
 
virtual const UT_StringgetStartupURL ()=0
 
void setDesiredHelpLocation (fpreal x, fpreal y)
 
void clearDesiredHelpLocation ()
 
void setFloatingHelpPaneId (int pane_id)
 
int getFloatingHelpPaneId () const
 
virtual void closeFloatingPane ()=0
 

Static Public Member Functions

static bool platformSupportsHtmlHelp ()
 
static void constructOpBasedURL (const char *protocol, const char *optable, const char *optype, const char *extra, UT_String &url)
 
static bool parseOpBasedURL (const char *url, const char *protocol, UT_String &optable, UT_String &optype, UT_String &extra)
 
static UT_HelpManagergetHelpManager ()
 
static void setHelpManager (UT_HelpManager *help_manager)
 

Protected Member Functions

bool getDesiredHelpLocation (float &x, float &y)
 

Detailed Description

Definition at line 40 of file UT_HelpManager.h.

Constructor & Destructor Documentation

UT_HelpManager::UT_HelpManager ( )
virtual UT_HelpManager::~UT_HelpManager ( )
virtual

Member Function Documentation

void UT_HelpManager::clearDesiredHelpLocation ( )
virtual void UT_HelpManager::closeFloatingPane ( )
pure virtual
static void UT_HelpManager::constructOpBasedURL ( const char *  protocol,
const char *  optable,
const char *  optype,
const char *  extra,
UT_String url 
)
static

Concatenates the operator table name, operator type name, some extra information into a help URL.

virtual void UT_HelpManager::displayData ( const char *  data,
bool  is_html 
)
pure virtual
virtual const UT_String& UT_HelpManager::getBaseURI ( ) const
pure virtual
bool UT_HelpManager::getDesiredHelpLocation ( float &  x,
float &  y 
)
protected
virtual const UT_String& UT_HelpManager::getExternalHelpURL ( ) const
pure virtual
int UT_HelpManager::getFloatingHelpPaneId ( ) const
inline

Definition at line 146 of file UT_HelpManager.h.

virtual const UT_String& UT_HelpManager::getHelpBaseURL ( )
pure virtual
virtual void UT_HelpManager::getHelpCardURL ( OP_Operator op,
UT_String str 
)
pure virtual
virtual void UT_HelpManager::getHelpCardURL ( BM_State state,
UT_String url 
)
pure virtual
virtual void UT_HelpManager::getHelpCardURL ( SHLF_Tool *  tool,
UT_String url 
)
pure virtual
virtual void UT_HelpManager::getHelpCardURL ( const PYP_Interface *  interface,
UT_String url 
)
pure virtual
virtual void UT_HelpManager::getHelpCardURL ( OP_GalleryEntry entry,
UT_String url 
)
pure virtual
virtual void UT_HelpManager::getHelpCardURL ( const PRM_ScriptParm prop,
UT_String url 
)
pure virtual
virtual void UT_HelpManager::getHelpCardURL ( const char *  helpTopicId,
UT_String url 
)
pure virtual
virtual void UT_HelpManager::getHelpCardURL ( const PRM_Parm parm,
UT_String url 
)
pure virtual
static UT_HelpManager* UT_HelpManager::getHelpManager ( )
inlinestatic

Definition at line 171 of file UT_HelpManager.h.

virtual bool UT_HelpManager::getParsedTooltip ( const char *  url_key,
const char *  full_help,
UT_String tooltip 
)
pure virtual

Obtains a tool tip conained by the full help text. The url serves as a caching key.

virtual const UT_String& UT_HelpManager::getStartupURL ( )
pure virtual
virtual bool UT_HelpManager::getTooltip ( const char *  url,
UT_String tooltip 
)
pure virtual

Obtains a tool tip from the help page pointed to by the URL.

virtual bool UT_HelpManager::getTooltip ( const PRM_Parm parm,
UT_String tooltip 
)
pure virtual

Obtains a tool tip for the specified parameter.

virtual bool UT_HelpManager::getUseExternalHelp ( ) const
pure virtual
virtual void UT_HelpManager::openContents ( )
pure virtual
virtual void UT_HelpManager::openFile ( const char *  path)
pure virtual
virtual void UT_HelpManager::openHelpCard ( OP_Node node)
pure virtual
virtual void UT_HelpManager::openHelpCard ( OP_Operator op,
const char *  node_path = nullptr 
)
pure virtual
virtual void UT_HelpManager::openHelpCard ( BM_State state)
pure virtual
virtual void UT_HelpManager::openHelpCard ( SHLF_Tool *  tool)
pure virtual
virtual void UT_HelpManager::openHelpCard ( const PYP_Interface *  interface)
pure virtual
virtual void UT_HelpManager::openHelpCard ( OP_GalleryEntry entry)
pure virtual
virtual void UT_HelpManager::openHelpCard ( const PRM_ScriptParm prop)
pure virtual
virtual void UT_HelpManager::openHelpPath ( const char *  help_path)
pure virtual
virtual void UT_HelpManager::openStartup ( )
pure virtual
virtual void UT_HelpManager::openURL ( const char *  url)
pure virtual
static bool UT_HelpManager::parseOpBasedURL ( const char *  url,
const char *  protocol,
UT_String optable,
UT_String optype,
UT_String extra 
)
static

Parses the help URL into the operator table name, operator type name, extra info string, given the url and the required protocol prefix. Returns true on success, and false otherwise.

static bool UT_HelpManager::platformSupportsHtmlHelp ( )
static
virtual void UT_HelpManager::setBaseURI ( const char *  base_uri)
pure virtual
void UT_HelpManager::setDesiredHelpLocation ( fpreal  x,
fpreal  y 
)
virtual void UT_HelpManager::setExternalHelpURL ( const char *  ext_help_url)
pure virtual
void UT_HelpManager::setFloatingHelpPaneId ( int  pane_id)
inline

Definition at line 144 of file UT_HelpManager.h.

static void UT_HelpManager::setHelpManager ( UT_HelpManager help_manager)
static
virtual void UT_HelpManager::setUseExternalHelp ( bool  use_external)
pure virtual

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