AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added wxHelpControllerBase, wxHtmlHelpDialog, wxHtmlHelpWindow

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@36807 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn 2006-01-09 23:05:54 +00:00
parent 486afba9a4
commit 42781abb2f
2 changed files with 393 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
wxPython/src/_html_rename.i
View File

@ -70,16 +70,54 @@
%rename(HtmlBookRecord) wxHtmlBookRecord;
%rename(HtmlSearchStatus) wxHtmlSearchStatus;
%rename(HtmlHelpData) wxHtmlHelpData;
%rename(HtmlHelpFrame) wxHtmlHelpFrame;
%rename(HF_TOOLBAR) wxHF_TOOLBAR;
%rename(HF_FLATTOOLBAR) wxHF_FLATTOOLBAR;
%rename(HF_CONTENTS) wxHF_CONTENTS;
%rename(HF_INDEX) wxHF_INDEX;
%rename(HF_SEARCH) wxHF_SEARCH;
%rename(HF_BOOKMARKS) wxHF_BOOKMARKS;
%rename(HF_OPENFILES) wxHF_OPENFILES;
%rename(HF_OPEN_FILES) wxHF_OPEN_FILES;
%rename(HF_PRINT) wxHF_PRINT;
%rename(HF_DEFAULTSTYLE) wxHF_DEFAULTSTYLE;
%rename(HF_FLAT_TOOLBAR) wxHF_FLAT_TOOLBAR;
%rename(HF_MERGE_BOOKS) wxHF_MERGE_BOOKS;
%rename(HF_ICONS_BOOK) wxHF_ICONS_BOOK;
%rename(HF_ICONS_BOOK_CHAPTER) wxHF_ICONS_BOOK_CHAPTER;
%rename(HF_ICONS_FOLDER) wxHF_ICONS_FOLDER;
%rename(HF_DEFAULT_STYLE) wxHF_DEFAULT_STYLE;
%rename(HF_EMBEDDED) wxHF_EMBEDDED;
%rename(HF_DIALOG) wxHF_DIALOG;
%rename(HF_FRAME) wxHF_FRAME;
%rename(HF_MODAL) wxHF_MODAL;
%rename(ID_HTML_PANEL) wxID_HTML_PANEL;
%rename(ID_HTML_BACK) wxID_HTML_BACK;
%rename(ID_HTML_FORWARD) wxID_HTML_FORWARD;
%rename(ID_HTML_UPNODE) wxID_HTML_UPNODE;
%rename(ID_HTML_UP) wxID_HTML_UP;
%rename(ID_HTML_DOWN) wxID_HTML_DOWN;
%rename(ID_HTML_PRINT) wxID_HTML_PRINT;
%rename(ID_HTML_OPENFILE) wxID_HTML_OPENFILE;
%rename(ID_HTML_OPTIONS) wxID_HTML_OPTIONS;
%rename(ID_HTML_BOOKMARKSLIST) wxID_HTML_BOOKMARKSLIST;
%rename(ID_HTML_BOOKMARKSADD) wxID_HTML_BOOKMARKSADD;
%rename(ID_HTML_BOOKMARKSREMOVE) wxID_HTML_BOOKMARKSREMOVE;
%rename(ID_HTML_TREECTRL) wxID_HTML_TREECTRL;
%rename(ID_HTML_INDEXPAGE) wxID_HTML_INDEXPAGE;
%rename(ID_HTML_INDEXLIST) wxID_HTML_INDEXLIST;
%rename(ID_HTML_INDEXTEXT) wxID_HTML_INDEXTEXT;
%rename(ID_HTML_INDEXBUTTON) wxID_HTML_INDEXBUTTON;
%rename(ID_HTML_INDEXBUTTONALL) wxID_HTML_INDEXBUTTONALL;
%rename(ID_HTML_NOTEBOOK) wxID_HTML_NOTEBOOK;
%rename(ID_HTML_SEARCHPAGE) wxID_HTML_SEARCHPAGE;
%rename(ID_HTML_SEARCHTEXT) wxID_HTML_SEARCHTEXT;
%rename(ID_HTML_SEARCHLIST) wxID_HTML_SEARCHLIST;
%rename(ID_HTML_SEARCHBUTTON) wxID_HTML_SEARCHBUTTON;
%rename(ID_HTML_SEARCHCHOICE) wxID_HTML_SEARCHCHOICE;
%rename(ID_HTML_COUNTINFO) wxID_HTML_COUNTINFO;
%rename(HtmlHelpWindow) wxHtmlHelpWindow;
%rename(HtmlWindowEvent) wxHtmlWindowEvent;
%rename(HtmlHelpFrame) wxHtmlHelpFrame;
%rename(HtmlHelpDialog) wxHtmlHelpDialog;
%rename(HelpControllerBase) wxHelpControllerBase;
%rename(HtmlHelpController) wxHtmlHelpController;
%rename(HtmlModalHelp) wxHtmlModalHelp;
#endif

387
wxPython/src/html.i
View File

@ -25,6 +25,9 @@
#include <wx/html/htmlwin.h>
#include <wx/html/htmprint.h>
#include <wx/html/helpctrl.h>
#include <wx/html/helpwin.h>
#include <wx/html/helpfrm.h>
#include <wx/html/helpdlg.h>
%}
@ -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);
@ -265,7 +268,7 @@ IMP_PYCALLBACK_BOOL_TAG_pure(wxPyHtmlTagHandler, wxHtmlTagHandler, HandleTag);
%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);
@ -347,7 +350,7 @@ public:
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"))) {
@ -508,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);
@ -807,7 +810,7 @@ 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,
@ -827,7 +830,7 @@ 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
@ -885,7 +888,7 @@ public:
void SetStandardFonts(int size = -1,
const wxString& normal_face = wxPyEmptyString,
const wxString& fixed_face = wxPyEmptyString);
DocDeclStr(
void, SetLabel(const wxString& title),
"", "");
@ -935,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);
@ -983,7 +986,7 @@ 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 maxHeight = INT_MAX,
//int *known_pagebreaks = NULL, int number_of_pages = 0
int* choices=NULL, int LCOUNT = 0
@ -1014,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) {
@ -1031,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);
@ -1077,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;}
@ -1173,55 +1176,345 @@ public:
//---------------------------------------------------------------------------
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, <param name="ID" value=id>, 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);
%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);
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);
void SetTitleFormat(const wxString& format);
void SetTempDir(const wxString& path);
bool AddBook(const wxString& book, int show_wait_msg = false);
@ -1233,12 +1526,34 @@ public:
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);
};
//---------------------------------------------------------------------------