16 #ifndef __UT_HelpManager_h__
17 #define __UT_HelpManager_h__
37 #define UT_OP_PROTOCOL_PREFIX "operator:"
38 #define UT_PROP_PROTOCOL_PREFIX "prop:"
39 #define UT_GALLERY_PROTOCOL_PREFIX "gallery:"
40 #define UT_PARM_PROTOCOL_PREFIX "parm:"
41 #define UT_DOC_PROTOCOL_PREFIX "doc:"
53 virtual void openContents() = 0;
57 virtual void openStartup() = 0;
65 virtual void openFile(
const char *
path) = 0;
66 virtual void openURL(
const char *url) = 0;
67 virtual void openHelpPath(
const char *help_path) = 0;
68 virtual void displayData(
const char *
data,
bool is_html) = 0;
71 virtual bool getTooltip(
const char * url,
UT_String & tooltip ) =0;
74 virtual bool getTooltip(
83 virtual void openTooltipWindow(
85 int x,
int y,
int w,
int h)
const = 0;
86 virtual void openTooltipURLWindow(
88 int x,
int y,
int w,
int h)
const = 0;
93 virtual void closeAllTooltipWindows()
const = 0;
97 virtual bool getTextHelp(
const char *url,
UT_String &text_help) = 0;
107 virtual UT_StringArray getCommandsForHelpKeyword(
const char *keyword) = 0;
112 const char *keyword) = 0;
116 virtual bool getParsedTooltip(
const char * url_key,
117 const char * full_help,
126 virtual void openHelpCard(
OP_Node * node ) = 0;
127 virtual void openHelpCard(
130 virtual void openHelpCard( SHLF_Tool * tool ) = 0;
131 virtual void openHelpCard(
const PYP_Interface * interface ) = 0;
139 virtual void getHelpCardURL( SHLF_Tool * tool,
UT_String & url ) =0;
140 virtual void getHelpCardURL(
const PYP_Interface * interface,
146 virtual void getHelpCardURL(
const char *helpTopicId,
148 virtual void getHelpCardURL(
const PRM_Parm * parm,
151 virtual void setBaseURI(
const char *base_uri) = 0;
152 virtual const UT_String &getBaseURI()
const = 0;
156 virtual bool getUseExternalHelp()
const = 0;
159 virtual void setUseExternalHelp(
bool use_external) = 0;
162 virtual void setHelpAddress(
const char* address) = 0;
166 virtual void setUseIPv6(
bool use_ipv6) = 0;
167 virtual bool getUseIPv6()
const = 0;
171 virtual const UT_String &getExternalHelpURL()
const = 0;
174 virtual void setExternalHelpURL(
const char *ext_help_url) = 0;
177 virtual const UT_String &getHelpBaseURL() = 0;
180 virtual const UT_String &getStartupURL() = 0;
188 void clearDesiredHelpLocation();
195 { myFloatingHelpPaneId = pane_id; }
197 {
return myFloatingHelpPaneId; }
198 virtual void closeFloatingPane() = 0;
203 static bool platformSupportsHtmlHelp();
207 static void constructOpBasedURL(
const char *protocol,
208 const char *optable,
const char *optype,
214 static bool parseOpBasedURL(
const char * url,
215 const char *protocol,
227 bool getDesiredHelpLocation(
float &x,
float &y);
232 float myDesiredHelpLocationX;
233 float myDesiredHelpLocationY;
234 int myFloatingHelpPaneId;
GLsizei const GLchar *const * path
void setFloatingHelpPaneId(int pane_id)
static UT_HelpManager * getHelpManager()
#define UT_NON_COPYABLE(CLASS)
Define deleted copy constructor and assignment operator inside a class.
GLfloat GLfloat GLfloat GLfloat h
GLubyte GLubyte GLubyte GLubyte w
int getFloatingHelpPaneId() const
static void setHelpManager(UT_HelpManager *help_manager)