HelpBrowser.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file HelpBrowser.cc
 *
 * Implementation of the HelpBrowser class.
 *
 * @author Veli-Pekka Jääskeläinen 2004 (vjaaskel-no.spam-cs.tut.fi)
 */
 
#include <wx/string.h>
#include <wx/menu.h>
#include <wx/html/htmlwin.h>
#include <wx/toolbar.h>
#include <wx/image.h>
 
#include "HelpBrowser.hh"
#include "WxConversion.hh"
#include "Environment.hh"
#include "FileSystem.hh"
 
BEGIN_EVENT_TABLE(HelpBrowser, wxFrame)
    EVT_CLOSE(HelpBrowser::onClose)
    EVT_MENU(ID_BACK, HelpBrowser::onBack)
    EVT_MENU(ID_FORWARD, HelpBrowser::onForward)
    EVT_MENU(wxID_CLOSE, HelpBrowser::onMenuClose)
END_EVENT_TABLE()
 
/**
 * The Constructor.
 *
 * Creates a browser window and opens the given file in the
 * html-widget.
 *
 * @param parent Parent window of the window.
 * @param title Title of the help browser frame.
 * @param file Html file  to open in the frame.
 * @param position Help frame position on the screen.
 * @param size Help frame size.
 */
HelpBrowser::HelpBrowser(wxString title, wxString file,
                        wxPoint position, wxSize size):
    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);
}
 
 
/**
 * The Destructor.
 */
HelpBrowser::~HelpBrowser() {
}
 
 
/**
 * Destroys the window when a close event is received.
 */
void
HelpBrowser::onClose(wxCloseEvent&) {
    Destroy();
}
 
/**
 * Destroys the window when a close event is received.
 */
void
HelpBrowser::onMenuClose(wxCommandEvent&) {
    Destroy();
}
 
 
/**
 * Loads the previous page in the html-widget.
 */
void
HelpBrowser::onBack(wxCommandEvent&) {
    html_->HistoryBack();
}
 
 
/**
 * Loads the next page in html-widget history.
 */
void
HelpBrowser::onForward(wxCommandEvent&) {
    html_->HistoryForward();
}