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:"
52 virtual void openContents() = 0;
56 virtual void openStartup() = 0;
64 virtual void openFile(
const char *
path) = 0;
65 virtual void openURL(
const char *url) = 0;
66 virtual void openHelpPath(
const char *help_path) = 0;
67 virtual void displayData(
const char *
data,
bool is_html) = 0;
70 virtual bool getTooltip(
const char * url,
UT_String & tooltip ) =0;
73 virtual bool getTooltip(
79 virtual bool getTextHelp(
const char *url,
UT_String &text_help) = 0;
89 virtual UT_StringArray getCommandsForHelpKeyword(
const char *keyword) = 0;
94 const char *keyword) = 0;
98 virtual bool getParsedTooltip(
const char * url_key,
99 const char * full_help,
108 virtual void openHelpCard(
OP_Node * node ) = 0;
109 virtual void openHelpCard(
110 OP_Operator * op,
const char *node_path=
nullptr ) = 0;
111 virtual void openHelpCard(
BM_State * state ) = 0;
112 virtual void openHelpCard( SHLF_Tool * tool ) = 0;
113 virtual void openHelpCard(
const PYP_Interface * interface ) = 0;
121 virtual void getHelpCardURL( SHLF_Tool * tool,
UT_String & url ) =0;
122 virtual void getHelpCardURL(
const PYP_Interface * interface,
128 virtual void getHelpCardURL(
const char *helpTopicId,
130 virtual void getHelpCardURL(
const PRM_Parm * parm,
133 virtual void setBaseURI(
const char *base_uri) = 0;
134 virtual const UT_String &getBaseURI()
const = 0;
138 virtual bool getUseExternalHelp()
const = 0;
141 virtual void setUseExternalHelp(
bool use_external) = 0;
144 virtual void setHelpAddress(
const char* address) = 0;
148 virtual void setUseIPv6(
bool use_ipv6) = 0;
149 virtual bool getUseIPv6()
const = 0;
153 virtual const UT_String &getExternalHelpURL()
const = 0;
156 virtual void setExternalHelpURL(
const char *ext_help_url) = 0;
159 virtual const UT_String &getHelpBaseURL() = 0;
162 virtual const UT_String &getStartupURL() = 0;
170 void clearDesiredHelpLocation();
177 { myFloatingHelpPaneId = pane_id; }
179 {
return myFloatingHelpPaneId; }
180 virtual void closeFloatingPane() = 0;
185 static bool platformSupportsHtmlHelp();
189 static void constructOpBasedURL(
const char *protocol,
190 const char *optable,
const char *optype,
196 static bool parseOpBasedURL(
const char * url,
197 const char *protocol,
209 bool getDesiredHelpLocation(
float &x,
float &y);
214 float myDesiredHelpLocationX;
215 float myDesiredHelpLocationY;
216 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.
int getFloatingHelpPaneId() const
static void setHelpManager(UT_HelpManager *help_manager)