HelpBrowser Class Reference

#include <HelpBrowser.hh>

Inheritance diagram for HelpBrowser:

Collaboration diagram for HelpBrowser:

Public Member Functions
	HelpBrowser (wxString title, wxString file, wxPoint position, wxSize size)
	~HelpBrowser ()

Private Types
enum	{ ID_BACK = 10000, ID_FORWARD }
	IDs form menu items. More...

Private Member Functions
void	onClose (wxCloseEvent &event)
void	onMenuClose (wxCommandEvent &event)
void	onBack (wxCommandEvent &event)
void	onForward (wxCommandEvent &event)

Private Attributes
wxHtmlWindow *	html_

Detailed Description

Simple window for displaying html-pages.

Definition at line 42 of file HelpBrowser.hh.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

IDs form menu items.

Enumerator
ID_BACK
ID_FORWARD

Definition at line 58 of file HelpBrowser.hh.

         {
        ID_BACK = 10000,
        ID_FORWARD
    };

Constructor & Destructor Documentation

HelpBrowser()

HelpBrowser::HelpBrowser	(	wxString	title,
		wxString	file,
		wxPoint	position,
		wxSize	size
	)

The Constructor.

Creates a browser window and opens the given file in the html-widget.

Parameters

parent	Parent window of the window.
title	Title of the help browser frame.
file	Html file to open in the frame.
position	Help frame position on the screen.
size	Help frame size.

Definition at line 62 of file HelpBrowser.cc.

                                                      :
    wxFrame(NULL, -1, title, position, size), html_(NULL) {
 
    wxToolBar* toolbar =
        new wxToolBar(this, -1, wxDefaultPosition, wxDefaultSize,
                      wxTB_HORIZONTAL | wxNO_BORDER | wxTB_TEXT);
 
    wxBitmap icon;
 
    if (wxImage::FindHandler(wxBITMAP_TYPE_PNG) == NULL) {
        // load image handler for pngs
        wxImage::AddHandler(new wxPNGHandler);
    }
 
    // toolbar icon locations
    wxString backIconFile = WxConversion::toWxString(
        Environment::bitmapsDirPath("ProDe") +
        FileSystem::DIRECTORY_SEPARATOR +
        "back.png");
    wxString forwardIconFile = WxConversion::toWxString(
        Environment::bitmapsDirPath("ProDe") +
        FileSystem::DIRECTORY_SEPARATOR +
        "forward.png");
    wxString closeIconFile = WxConversion::toWxString(
        Environment::bitmapsDirPath("ProDe") +
        FileSystem::DIRECTORY_SEPARATOR +
        "close_document.png");
 
    // add toolbar buttons
    icon.LoadFile(closeIconFile, wxBITMAP_TYPE_PNG);
 
    toolbar->AddTool(wxID_CLOSE, _T("Close"), icon,
                     wxNullBitmap, wxITEM_NORMAL, _T("Close window"),
                     _T("CloseWindow"));
 
    toolbar->AddSeparator();
 
    icon.LoadFile(backIconFile, wxBITMAP_TYPE_PNG);
    toolbar->AddTool(ID_BACK, _T("Back"), icon,
                     wxNullBitmap, wxITEM_NORMAL, _T("Back"));
 
    icon.LoadFile(forwardIconFile, wxBITMAP_TYPE_PNG);
    toolbar->AddTool(ID_FORWARD, _T("Forward"), icon,
                     wxNullBitmap, wxITEM_NORMAL, _T("Forward"));
 
    toolbar->Realize();
    SetToolBar(toolbar);
 
    // create html-widget and open the given file in it
    html_ = new wxHtmlWindow(this);
    html_->LoadPage(file);
}

References Environment::bitmapsDirPath(), FileSystem::DIRECTORY_SEPARATOR, and WxConversion::toWxString().

Here is the call graph for this function:

~HelpBrowser()

HelpBrowser::~HelpBrowser

(

)

The Destructor.

Definition at line 120 of file HelpBrowser.cc.

                          {
}

Member Function Documentation

onBack()

void HelpBrowser::onBack ( wxCommandEvent &  event )

private

Loads the previous page in the html-widget.

Definition at line 145 of file HelpBrowser.cc.

                                   {
    html_->HistoryBack();
}

References html_.

onClose()

void HelpBrowser::onClose ( wxCloseEvent &  event )

private

Destroys the window when a close event is received.

Definition at line 128 of file HelpBrowser.cc.

                                  {
    Destroy();
}

onForward()

void HelpBrowser::onForward ( wxCommandEvent &  event )

private

Loads the next page in html-widget history.

Definition at line 154 of file HelpBrowser.cc.

                                      {
    html_->HistoryForward();
}

References html_.

onMenuClose()

void HelpBrowser::onMenuClose ( wxCommandEvent &  event )

private

Destroys the window when a close event is received.

Definition at line 136 of file HelpBrowser.cc.

                                        {
    Destroy();
}

Member Data Documentation

html_

wxHtmlWindow* HelpBrowser::html_

private

Definition at line 55 of file HelpBrowser.hh.

Referenced by onBack(), and onForward().

---

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

• HelpBrowser.hh
• HelpBrowser.cc