HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
UT_HelpManager Class Referenceabstract

#include <UT_HelpManager.h>

+ Inheritance diagram for UT_HelpManager:

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 getTextHelp (const char *url, UT_String &text_help)=0
 
virtual UT_StringHolder getCommandHelp (const char *command)=0
 Return the text help for the given hscript command. More...
 
virtual UT_StringHolder getExprCommandHelp (const char *command)=0
 Return the text help for the given hscript expression command. More...
 
virtual UT_StringArray getCommandsForHelpKeyword (const char *keyword)=0
 
virtual UT_StringArray getExprCommandsForHelpKeyword (const char *keyword)=0
 
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_String & getBaseURI () const =0
 
virtual bool getUseExternalHelp () const =0
 
virtual void setUseExternalHelp (bool use_external)=0
 
virtual void setHelpAddress (const char *address)=0
 Sets the address the server should bind to. More...
 
virtual const UT_StringHolder & getHelpAddress () const =0
 
virtual void setUseIPv6 (bool use_ipv6)=0
 Whether the help server should use ipv6 or not. More...
 
virtual bool getUseIPv6 () const =0
 
virtual const UT_String & getExternalHelpURL () const =0
 
virtual void setExternalHelpURL (const char *ext_help_url)=0
 
virtual const UT_String & getHelpBaseURL ()=0
 
virtual const UT_String & getStartupURL ()=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_HelpManager * getHelpManager ()
 
static void setHelpManager (UT_HelpManager *help_manager)
 

Protected Member Functions

bool getDesiredHelpLocation (float &x, float &y)
 

Detailed Description

Definition at line 43 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

Implemented in MOT_HelpManager.

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

Implemented in MOT_HelpManager.

virtual const UT_String& UT_HelpManager::getBaseURI ( ) const
pure virtual

Implemented in MOT_HelpManager.

virtual UT_StringHolder UT_HelpManager::getCommandHelp ( const char *  command)
pure virtual

Return the text help for the given hscript command.

Implemented in MOT_HelpManager.

virtual UT_StringArray UT_HelpManager::getCommandsForHelpKeyword ( const char *  keyword)
pure virtual

Return an array of hscript commands whose text help contain a match for the given keyword.

Implemented in MOT_HelpManager.

bool UT_HelpManager::getDesiredHelpLocation ( float &  x,
float &  y 
)
protected
virtual UT_StringHolder UT_HelpManager::getExprCommandHelp ( const char *  command)
pure virtual

Return the text help for the given hscript expression command.

Implemented in MOT_HelpManager.

virtual UT_StringArray UT_HelpManager::getExprCommandsForHelpKeyword ( const char *  keyword)
pure virtual

Return an array of hscript expression commands whose text help conotain a match for the given keyword.

Implemented in MOT_HelpManager.

virtual const UT_String& UT_HelpManager::getExternalHelpURL ( ) const
pure virtual

Implemented in MOT_HelpManager.

int UT_HelpManager::getFloatingHelpPaneId ( ) const
inline

Definition at line 178 of file UT_HelpManager.h.

virtual const UT_StringHolder& UT_HelpManager::getHelpAddress ( ) const
pure virtual

Implemented in MOT_HelpManager.

virtual const UT_String& UT_HelpManager::getHelpBaseURL ( )
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::getHelpCardURL ( OP_Operator *  op,
UT_String &  str 
)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::getHelpCardURL ( BM_State *  state,
UT_String &  url 
)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::getHelpCardURL ( SHLF_Tool *  tool,
UT_String &  url 
)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::getHelpCardURL ( const PYP_Interface *  interface,
UT_String &  url 
)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::getHelpCardURL ( OP_GalleryEntry *  entry,
UT_String &  url 
)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::getHelpCardURL ( const PRM_ScriptParm *  prop,
UT_String &  url 
)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::getHelpCardURL ( const char *  helpTopicId,
UT_String &  url 
)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::getHelpCardURL ( const PRM_Parm *  parm,
UT_String &  url 
)
pure virtual

Implemented in MOT_HelpManager.

static UT_HelpManager* UT_HelpManager::getHelpManager ( )
inlinestatic

Definition at line 203 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.

Implemented in MOT_HelpManager.

virtual const UT_String& UT_HelpManager::getStartupURL ( )
pure virtual

Implemented in MOT_HelpManager.

virtual bool UT_HelpManager::getTextHelp ( const char *  url,
UT_String &  text_help 
)
pure virtual

Obtains a plain text version of the help page pointed to by the URL (e.g. 'vex:attrib').

Implemented in MOT_HelpManager.

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.

Implemented in MOT_HelpManager.

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

Obtains a tool tip for the specified parameter.

Implemented in MOT_HelpManager.

virtual bool UT_HelpManager::getUseExternalHelp ( ) const
pure virtual

Implemented in MOT_HelpManager.

virtual bool UT_HelpManager::getUseIPv6 ( ) const
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openContents ( )
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openFile ( const char *  path)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openHelpCard ( OP_Node *  node)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openHelpCard ( OP_Operator *  op,
const char *  node_path = nullptr 
)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openHelpCard ( BM_State *  state)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openHelpCard ( SHLF_Tool *  tool)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openHelpCard ( const PYP_Interface *  interface)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openHelpCard ( OP_GalleryEntry *  entry)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openHelpCard ( const PRM_ScriptParm *  prop)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openHelpPath ( const char *  help_path)
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openStartup ( )
pure virtual

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::openURL ( const char *  url)
pure virtual

Implemented in MOT_HelpManager.

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

Implemented in MOT_HelpManager.

void UT_HelpManager::setDesiredHelpLocation ( fpreal  x,
fpreal  y 
)
virtual void UT_HelpManager::setExternalHelpURL ( const char *  ext_help_url)
pure virtual

Implemented in MOT_HelpManager.

void UT_HelpManager::setFloatingHelpPaneId ( int  pane_id)
inline

Definition at line 176 of file UT_HelpManager.h.

virtual void UT_HelpManager::setHelpAddress ( const char *  address)
pure virtual

Sets the address the server should bind to.

Implemented in MOT_HelpManager.

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

Implemented in MOT_HelpManager.

virtual void UT_HelpManager::setUseIPv6 ( bool  use_ipv6)
pure virtual

Whether the help server should use ipv6 or not.

Implemented in MOT_HelpManager.

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