X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3b03eb99e93df17890dcd06f3638d9c3c1d769d6..9c605285c8e427236193c0e368e6f0700659e262:/wxPython/src/html.i diff --git a/wxPython/src/html.i b/wxPython/src/html.i index a2e91e9bd1..651cfe2767 100644 --- a/wxPython/src/html.i +++ b/wxPython/src/html.i @@ -25,6 +25,9 @@ #include #include #include +#include +#include +#include %} @@ -204,8 +207,8 @@ public: void SetStandardFonts(int size = -1, const wxString& normal_face = wxPyEmptyString, const wxString& fixed_face = wxPyEmptyString); - - + + wxHtmlContainerCell* GetContainer(); wxHtmlContainerCell* OpenContainer(); wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c); @@ -227,6 +230,10 @@ public: void SetLinkColor(const wxColour& clr); wxColour GetActualColor(); void SetActualColor(const wxColour& clr); + %pythoncode { + GetActualColour = GetActualColor + SetActualColour = SetActualColor + } void SetLink(const wxString& link); wxFont* CreateCurrentFont(); wxHtmlLinkInfo GetLink(); @@ -238,7 +245,7 @@ public: %{ class wxPyHtmlTagHandler : public wxHtmlTagHandler { - DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler); + DECLARE_DYNAMIC_CLASS(wxPyHtmlTagHandler) public: wxPyHtmlTagHandler() : wxHtmlTagHandler() {}; @@ -258,9 +265,10 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag); %} -%name(HtmlTagHandler) class wxPyHtmlTagHandler : public wxObject { +%rename(HtmlTagHandler) wxPyHtmlTagHandler; +class wxPyHtmlTagHandler : public wxObject { public: - %pythonAppend wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)" + %pythonAppend wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)" wxPyHtmlTagHandler(); void _setCallbackInfo(PyObject* self, PyObject* _class); @@ -275,7 +283,7 @@ public: %{ class wxPyHtmlWinTagHandler : public wxHtmlWinTagHandler { - DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler); + DECLARE_DYNAMIC_CLASS(wxPyHtmlWinTagHandler) public: wxPyHtmlWinTagHandler() : wxHtmlWinTagHandler() {}; @@ -296,7 +304,8 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlWinTagHandler, wxHtmlWinTagHandler, HandleT %} -%name(HtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler { +%rename(HtmlWinTagHandler) wxPyHtmlWinTagHandler; +class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler { public: %pythonAppend wxPyHtmlWinTagHandler "self._setCallbackInfo(self, HtmlWinTagHandler)" wxPyHtmlWinTagHandler(); @@ -323,7 +332,7 @@ public: } void OnExit() { - bool blocked = wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); Py_DECREF(m_tagHandlerClass); m_tagHandlerClass = NULL; for (size_t x=0; x < m_objArray.GetCount(); x++) { @@ -337,11 +346,11 @@ public: // Wave our magic wand... (if it works it's a miracle! ;-) // First, make a new instance of the tag handler - bool blocked = wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); PyObject* arg = PyTuple_New(0); PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg); Py_DECREF(arg); - + // now figure out where it's C++ object is... wxPyHtmlWinTagHandler* thPtr; if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler"))) { @@ -391,7 +400,7 @@ public: void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell, const wxPoint& toPos, const wxHtmlCell *toCell); - %name(SetCells)void Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell); + %Rename(SetCells, void, Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell)); const wxHtmlCell *GetFromCell() const; const wxHtmlCell *GetToCell() const; @@ -502,7 +511,7 @@ public: // Returns the maximum possible length of the cell. // Call Layout at least once before using GetMaxTotalWidth() int GetMaxTotalWidth() const; - + const wxString& GetId() const; void SetId(const wxString& id); wxHtmlLinkInfo* GetLink(int x = 0, int y = 0); @@ -591,7 +600,7 @@ public: int GetIndentUnits(int ind); void SetAlign(const wxHtmlTag& tag); void SetWidthFloat(int w, int units); - %name(SetWidthFloatFromTag)void SetWidthFloat(const wxHtmlTag& tag); + %Rename(SetWidthFloatFromTag, void, SetWidthFloat(const wxHtmlTag& tag)); void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP); void SetBackgroundColour(const wxColour& clr); wxColour GetBackgroundColour(); @@ -604,7 +613,7 @@ public: class wxHtmlColourCell : public wxHtmlCell { public: - wxHtmlColourCell(wxColour clr, int flags = wxHTML_CLR_FOREGROUND); + wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND); }; @@ -633,7 +642,7 @@ public: %{ // here's the C++ version class wxPyHtmlFilter : public wxHtmlFilter { - DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter); + DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter) public: wxPyHtmlFilter() : wxHtmlFilter() {} @@ -641,7 +650,7 @@ public: virtual bool CanRead(const wxFSFile& file) const { bool rval = false; bool found; - bool blocked = wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) { PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false); // cast away const rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj)); @@ -657,7 +666,7 @@ public: virtual wxString ReadFile(const wxFSFile& file) const { wxString rval; bool found; - bool blocked = wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) { PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false); // cast away const PyObject* ro; @@ -681,7 +690,8 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter); // And now the version seen by SWIG -%name(HtmlFilter) class wxPyHtmlFilter : public wxObject { +%rename(HtmlFilter) wxPyHtmlFilter; +class wxPyHtmlFilter : public wxObject { public: %pythonAppend wxPyHtmlFilter "self._setCallbackInfo(self, HtmlFilter)" wxPyHtmlFilter(); @@ -700,7 +710,7 @@ public: %{ class wxPyHtmlWindow : public wxHtmlWindow { - DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow); + DECLARE_ABSTRACT_CLASS(wxPyHtmlWindow) public: wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, @@ -740,7 +750,7 @@ IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked); void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) { bool found; - bool blocked = wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) { PyObject* obj = wxPyConstructObject((void*)&link, wxT("wxHtmlLinkInfo"), 0); wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj)); @@ -760,7 +770,7 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, wxString *redirect) const { bool found; wxHtmlOpeningStatus rval; - bool blocked = wxPyBeginBlockThreads(); + wxPyBlock_t blocked = wxPyBeginBlockThreads(); if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) { PyObject* ro; PyObject* s = wx2PyString(url); @@ -794,18 +804,19 @@ wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type, MustHaveApp(wxPyHtmlWindow); -%name(HtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow { +%rename(HtmlWindow) wxPyHtmlWindow; +class wxPyHtmlWindow : public wxScrolledWindow { public: %pythonAppend wxPyHtmlWindow "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)" %pythonAppend wxPyHtmlWindow() "" %typemap(out) wxPyHtmlWindow*; // turn off this typemap - + wxPyHtmlWindow(wxWindow *parent, int id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, int style=wxHW_DEFAULT_STYLE, const wxString& name = wxPyHtmlWindowNameStr); - %name(PreHtmlWindow)wxPyHtmlWindow(); + %RenameCtor(PreHtmlWindow, wxPyHtmlWindow()); // Turn it back on again %typemap(out) wxPyHtmlWindow* { $result = wxPyMake_wxObject($1, $owner); } @@ -819,11 +830,11 @@ public: void _setCallbackInfo(PyObject* self, PyObject* _class); - + // Set HTML page and display it. !! source is HTML document itself, // it is NOT address/filename of HTML document. If you want to // specify document location, use LoadPage() istead - // Return value : False if an error occured, True otherwise + // Return value : False if an error occurred, True otherwise bool SetPage(const wxString& source); // Load HTML page from given location. Location can be either @@ -877,14 +888,18 @@ public: void SetStandardFonts(int size = -1, const wxString& normal_face = wxPyEmptyString, const wxString& fixed_face = wxPyEmptyString); - + DocDeclStr( - void, SetTitle(const wxString& title), + void, SetLabel(const wxString& title), "", ""); // Sets space between text and window borders. void SetBorders(int b); + // Sets the bitmap to use for background (currnetly it will be tiled, + // when/if we have CSS support we could add other possibilities...) + void SetBackgroundImage(const wxBitmap& bmpBg); + // Saves custom settings into cfg config. it will use the path 'path' // if given, otherwise it will save info into currently selected path. // saved values : things set by SetFonts, SetBorders. @@ -923,7 +938,7 @@ public: // Converts current page to text: wxString ToText(); - + void base_OnLinkClicked(const wxHtmlLinkInfo& link); void base_OnSetTitle(const wxString& title); void base_OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y); @@ -971,8 +986,8 @@ public: void SetStandardFonts(int size = -1, const wxString& normal_face = wxPyEmptyString, const wxString& fixed_face = wxPyEmptyString); - - int Render(int x, int y, int from = 0, int dont_render = false, int to = INT_MAX, + + int Render(int x, int y, int from = 0, int dont_render = false, int maxHeight = INT_MAX, //int *known_pagebreaks = NULL, int number_of_pages = 0 int* choices=NULL, int LCOUNT = 0 ); @@ -1002,7 +1017,7 @@ public: void SetHtmlFile(const wxString &htmlfile); void SetHeader(const wxString& header, int pg = wxPAGE_ALL); void SetFooter(const wxString& footer, int pg = wxPAGE_ALL); - + // Sets fonts to be used when displaying HTML page. (if size null then default sizes used). %extend { void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) { @@ -1019,7 +1034,7 @@ public: void SetStandardFonts(int size = -1, const wxString& normal_face = wxPyEmptyString, const wxString& fixed_face = wxPyEmptyString); - + void SetMargins(float top = 25.2, float bottom = 25.2, float left = 25.2, float right = 25.2, float spaces = 5); @@ -1065,7 +1080,7 @@ public: void SetStandardFonts(int size = -1, const wxString& normal_face = wxPyEmptyString, const wxString& fixed_face = wxPyEmptyString); - + wxPrintData *GetPrintData() {return m_PrintData;} wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;} @@ -1099,7 +1114,8 @@ public: }; //--------------------------------------------------------------------------- - +// WXWIN_COMPATIBILITY_2_4 +#if 0 struct wxHtmlContentsItem { %extend { @@ -1110,7 +1126,7 @@ struct wxHtmlContentsItem wxHtmlBookRecord* GetBook() { return self->m_Book; } } }; - +#endif //--------------------------------------------------------------------------- class wxHtmlSearchStatus @@ -1123,7 +1139,10 @@ public: int GetCurIndex(); int GetMaxIndex(); const wxString& GetName(); + // WXWIN_COMPATIBILITY_2_4 +#if 0 wxHtmlContentsItem* GetContentsItem(); +#endif }; //--------------------------------------------------------------------------- @@ -1146,78 +1165,399 @@ public: // TODO: this one needs fixed... const wxHtmlBookRecArray& GetBookRecArray(); + // WXWIN_COMPATIBILITY_2_4 +#if 0 wxHtmlContentsItem* GetContents(); int GetContentsCnt(); wxHtmlContentsItem* GetIndex(); int GetIndexCnt(); +#endif }; //--------------------------------------------------------------------------- +enum { + wxHF_TOOLBAR, + wxHF_CONTENTS, + wxHF_INDEX, + wxHF_SEARCH, + wxHF_BOOKMARKS, + wxHF_OPEN_FILES, + wxHF_PRINT, + wxHF_FLAT_TOOLBAR, + wxHF_MERGE_BOOKS, + wxHF_ICONS_BOOK, + wxHF_ICONS_BOOK_CHAPTER, + wxHF_ICONS_FOLDER, + wxHF_DEFAULT_STYLE, + + wxHF_EMBEDDED, + wxHF_DIALOG, + wxHF_FRAME, + wxHF_MODAL, +}; + +enum { + wxID_HTML_PANEL, + wxID_HTML_BACK, + wxID_HTML_FORWARD, + wxID_HTML_UPNODE, + wxID_HTML_UP, + wxID_HTML_DOWN, + wxID_HTML_PRINT, + wxID_HTML_OPENFILE, + wxID_HTML_OPTIONS, + wxID_HTML_BOOKMARKSLIST, + wxID_HTML_BOOKMARKSADD, + wxID_HTML_BOOKMARKSREMOVE, + wxID_HTML_TREECTRL, + wxID_HTML_INDEXPAGE, + wxID_HTML_INDEXLIST, + wxID_HTML_INDEXTEXT, + wxID_HTML_INDEXBUTTON, + wxID_HTML_INDEXBUTTONALL, + wxID_HTML_NOTEBOOK, + wxID_HTML_SEARCHPAGE, + wxID_HTML_SEARCHTEXT, + wxID_HTML_SEARCHLIST, + wxID_HTML_SEARCHBUTTON, + wxID_HTML_SEARCHCHOICE, + wxID_HTML_COUNTINFO +}; + + + +MustHaveApp(wxHtmlHelpWindow); + +class wxHtmlHelpWindow : public wxWindow +{ +public: + %pythonAppend wxHtmlHelpWindow "self._setOORInfo(self)" + %pythonAppend wxHtmlHelpWindow() "" + %typemap(out) wxHtmlHelpWindow*; // turn off this typemap + + wxHtmlHelpWindow(wxWindow* parent, wxWindowID wxWindowID, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int style = wxTAB_TRAVERSAL|wxNO_BORDER, + int helpStyle = wxHF_DEFAULT_STYLE, + wxHtmlHelpData* data = NULL); + %RenameCtor(PreHtmlHelpWindow, wxHtmlHelpWindow(wxHtmlHelpData* data = NULL)); + + // Turn it back on again + %typemap(out) wxHtmlHelpWindow* { $result = wxPyMake_wxObject($1, $owner); } + + bool Create(wxWindow* parent, wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int style = wxTAB_TRAVERSAL|wxNO_BORDER, + int helpStyle = wxHF_DEFAULT_STYLE); + + wxHtmlHelpData* GetData(); + wxHtmlHelpController* GetController() const; + void SetController(wxHtmlHelpController* controller); + + // Displays page x. If not found it will offect the user a choice of + // searching books. + // Looking for the page runs in these steps: + // 1. try to locate file named x (if x is for example "doc/howto.htm") + // 2. try to open starting page of book x + // 3. try to find x in contents (if x is for example "How To ...") + // 4. try to find x in index (if x is for example "How To ...") + bool Display(const wxString& x); + + // Alternative version that works with numeric ID. + // (uses extension to MS format, , see docs) + %Rename(DisplayID, bool, Display(int id)); + + // Displays help window and focuses contents. + bool DisplayContents(); + + // Displays help window and focuses index. + bool DisplayIndex(); + + // Searches for keyword. Returns true and display page if found, return + // false otherwise + // Syntax of keyword is Altavista-like: + // * words are separated by spaces + // (but "\"hello world\"" is only one world "hello world") + // * word may be pretended by + or - + // (+ : page must contain the word ; - : page can't contain the word) + // * if there is no + or - before the word, + is default + bool KeywordSearch(const wxString& keyword, + wxHelpSearchMode mode = wxHELP_SEARCH_ALL); + + void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString); + + // Saves custom settings into cfg config. it will use the path 'path' + // if given, otherwise it will save info into currently selected path. + // saved values : things set by SetFonts, SetBorders. + void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); + void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); + + // call this to let wxHtmlHelpWindow know page changed + void NotifyPageChanged(); + + // Refreshes Contents and Index tabs + void RefreshLists(); + + // Gets the HTML window + wxHtmlWindow* GetHtmlWindow() const; + + // Gets the splitter window + wxSplitterWindow* GetSplitterWindow(); + + // Gets the toolbar + wxToolBar* GetToolBar() const; + + // Gets the configuration data + wxHtmlHelpFrameCfg& GetCfgData(); + + // Gets the tree control + wxTreeCtrl *GetTreeCtrl() const; + +}; + + +class wxHtmlWindowEvent: public wxNotifyEvent +{ +public: + wxHtmlWindowEvent(wxEventType commandType = wxEVT_NULL, int id = 0): + wxNotifyEvent(commandType, id); + + void SetURL(const wxString& url); + const wxString& GetURL() const; +}; + + + MustHaveApp(wxHtmlHelpFrame); class wxHtmlHelpFrame : public wxFrame { public: %pythonAppend wxHtmlHelpFrame "self._setOORInfo(self)" - + %pythonAppend wxHtmlHelpFrame() "" + %typemap(out) wxHtmlHelpFrame*; // turn off this typemap + wxHtmlHelpFrame(wxWindow* parent, int wxWindowID, const wxString& title = wxPyEmptyString, int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL); + %RenameCtor(PreHtmlHelpFrame, wxHtmlHelpFrame(wxHtmlHelpData* data = NULL)); + + // Turn it back on again + %typemap(out) wxHtmlHelpFrame* { $result = wxPyMake_wxObject($1, $owner); } + + bool Create(wxWindow* parent, wxWindowID id, + const wxString& title = wxPyEmptyString, + int style = wxHF_DEFAULT_STYLE); wxHtmlHelpData* GetData(); void SetTitleFormat(const wxString& format); - void Display(const wxString& x); - %name(DisplayID) void Display(int id); - void DisplayContents(); - void DisplayIndex(); - bool KeywordSearch(const wxString& keyword); - void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString); - void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); - void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); + + void AddGrabIfNeeded(); + + /// Returns the help controller associated with the window. + wxHtmlHelpController* GetController() const; + + /// Sets the help controller associated with the window. + void SetController(wxHtmlHelpController* controller); + + /// Returns the help window. + wxHtmlHelpWindow* GetHelpWindow() const; + + %pythoncode { + %# For compatibility from before the refactor + def Display(self, x): + return self.GetHelpWindow().Display(x) + def DisplayID(self, x): + return self.GetHelpWindow().DisplayID(id) + def DisplayContents(self): + return self.GetHelpWindow().DisplayContents() + def DisplayIndex(self): + return self.GetHelpWindow().DisplayIndex() + + def KeywordSearch(self, keyword): + return self.GetHelpWindow().KeywordSearch(keyword) + + def UseConfig(self, config, rootpath=""): + return self.GetHelpWindow().UseConfig(config, rootpath) + def ReadCustomization(self, config, rootpath=""): + return self.GetHelpWindow().ReadCustomization(config, rootpath) + def WriteCustomization(self, config, rootpath=""): + return self.GetHelpWindow().WriteCustomization(config, rootpath) + %} +}; + + + +MustHaveApp(wxHtmlHelpDialog); + +class wxHtmlHelpDialog : public wxDialog +{ +public: + %pythonAppend wxHtmlHelpDialog "self._setOORInfo(self)" + %pythonAppend wxHtmlHelpDialog() "" + %typemap(out) wxHtmlHelpDialog*; // turn off this typemap + + wxHtmlHelpDialog(wxWindow* parent, wxWindowID wxWindowID, + const wxString& title = wxPyEmptyString, + int style = wxHF_DEFAULT_STYLE, wxHtmlHelpData* data = NULL); + %RenameCtor(PreHtmlHelpDialog, wxHtmlHelpDialog(wxHtmlHelpData* data = NULL)); + + // Turn it back on again + %typemap(out) wxHtmlHelpDialog* { $result = wxPyMake_wxObject($1, $owner); } + + bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxPyEmptyString, + int style = wxHF_DEFAULT_STYLE); + + /// Returns the data associated with this dialog. + wxHtmlHelpData* GetData(); + + /// Returns the controller that created this dialog. + wxHtmlHelpController* GetController() const; + + /// Sets the controller associated with this dialog. + void SetController(wxHtmlHelpController* controller); + + /// Returns the help window. + wxHtmlHelpWindow* GetHelpWindow() const; + + // Sets format of title of the frame. Must contain exactly one "%s" + // (for title of displayed HTML page) + void SetTitleFormat(const wxString& format); + + // Override to add custom buttons to the toolbar +// virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {}; + }; //--------------------------------------------------------------------------- -enum { - wxHF_TOOLBAR, - wxHF_FLATTOOLBAR, - wxHF_CONTENTS, - wxHF_INDEX, - wxHF_SEARCH, - wxHF_BOOKMARKS, - wxHF_OPENFILES, - wxHF_PRINT, - wxHF_DEFAULTSTYLE, +// TODO: Make virtual methods of this class overridable in Python. + +MustHaveApp(wxHelpControllerBase); + +class wxHelpControllerBase: public wxObject +{ +public: +// wxHelpControllerBase(wxWindow* parentWindow = NULL); +// ~wxHelpControllerBase(); + + %nokwargs Initialize; + virtual bool Initialize(const wxString& file, int server ); + virtual bool Initialize(const wxString& file); + + virtual void SetViewer(const wxString& viewer, long flags = 0); + + // If file is "", reloads file given in Initialize + virtual bool LoadFile(const wxString& file = wxEmptyString) /* = 0 */; + + // Displays the contents + virtual bool DisplayContents(void) /* = 0 */; + + %nokwargs DisplaySection; + + // Display the given section + virtual bool DisplaySection(int sectionNo) /* = 0 */; + + // Display the section using a context id + virtual bool DisplayContextPopup(int contextId); + + // Display the text in a popup, if possible + virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos); + + // By default, uses KeywordSection to display a topic. Implementations + // may override this for more specific behaviour. + virtual bool DisplaySection(const wxString& section); + + virtual bool DisplayBlock(long blockNo) /* = 0 */; + virtual bool KeywordSearch(const wxString& k, + wxHelpSearchMode mode = wxHELP_SEARCH_ALL) /* = 0 */; + + /// Allows one to override the default settings for the help frame. + virtual void SetFrameParameters(const wxString& title, + const wxSize& size, + const wxPoint& pos = wxDefaultPosition, + bool newFrameEachTime = false); + + /// Obtains the latest settings used by the help frame and the help + /// frame. + virtual wxFrame *GetFrameParameters(wxSize *size = NULL, + wxPoint *pos = NULL, + bool *newFrameEachTime = NULL); + + virtual bool Quit() /* = 0 */; + + virtual void OnQuit(); + + /// Set the window that can optionally be used for the help window's parent. + virtual void SetParentWindow(wxWindow* win); + + /// Get the window that can optionally be used for the help window's parent. + virtual wxWindow* GetParentWindow() const; + }; + + MustHaveApp(wxHtmlHelpController); -class wxHtmlHelpController : public wxObject // wxHelpControllerBase +class wxHtmlHelpController : public wxHelpControllerBase { public: // %pythonAppend wxHtmlHelpController "self._setOORInfo(self)" - - wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE); + + wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE, wxWindow* parentWindow = NULL); ~wxHtmlHelpController(); + wxHtmlHelpWindow* GetHelpWindow(); + void SetHelpWindow(wxHtmlHelpWindow* helpWindow); + + wxHtmlHelpFrame* GetFrame(); + wxHtmlHelpDialog* GetDialog(); + void SetTitleFormat(const wxString& format); void SetTempDir(const wxString& path); bool AddBook(const wxString& book, int show_wait_msg = false); void Display(const wxString& x); - %name(DisplayID) void Display(int id); + %Rename(DisplayID, void, Display(int id)); void DisplayContents(); void DisplayIndex(); bool KeywordSearch(const wxString& keyword); void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString); void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString); - wxHtmlHelpFrame* GetFrame(); + + void MakeModalIfNeeded(); + wxWindow* FindTopLevelWindow(); + + %pythoncode { def Destroy(self): pass } }; +/* + * wxHtmlModalHelp + * A convenience class particularly for use on wxMac, + * where you can only show modal dialogs from a modal + * dialog. + * + * Use like this: + * + * wxHtmlModalHelp help(parent, filename, topic); + * + * If topic is empty, the help contents is displayed. + */ + +class wxHtmlModalHelp +{ +public: + wxHtmlModalHelp(wxWindow* parent, const wxString& helpFile, + const wxString& topic = wxEmptyString, + int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL); +}; //---------------------------------------------------------------------------