Aegisub/aegisub/src/help_button.cpp
2012-09-03 17:28:45 -07:00

118 lines
4.2 KiB
C++

// Copyright (c) 2007, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$
/// @file help_button.cpp
/// @brief Push-button opening the help file at a specified section
/// @ingroup custom_control
///
#include "config.h"
#include "help_button.h"
#ifndef AGI_PRE
#include <algorithm>
#include <map>
#include <tr1/functional>
#include <wx/filename.h>
#include <wx/msgdlg.h>
#endif
#include <libaegisub/exception.h>
#include "standard_paths.h"
#include "utils.h"
static std::map<wxString,wxString> *pages = 0;
static void init_static() {
if (!pages) {
pages = new std::map<wxString, wxString>;
std::map<wxString, wxString> &page = *pages;
page["Attachment Manager"] = "Attachment_Manager";
page["Automation Manager"] = "Automation/Manager";
page["Colour Picker"] = "Colour_Picker";
page["Dummy Video"] = "Video#dummyvideo";
page["Export"] = "Exporting";
page["Fonts Collector"] = "Fonts_Collector";
page["Kanji Timer"] = "Kanji_Timer";
page["Main"] = "Main_Page";
page["Options"] = "Options";
page["Paste Over"] = "Paste_Over";
page["Properties"] = "Properties";
page["Resample resolution"] = "Resolution_Resampler";
page["Shift Times"] = "Shift_Times";
page["Select Lines"] = "Select_Lines";
page["Spell Checker"] = "Spell_Checker";
page["Style Editor"] = "Styles";
page["Styles Manager"] = "Styles";
page["Styling Assistant"] = "Styling_Assistant";
page["Timing Processor"] = "Timing_Post-Processor";
page["Translation Assistant"] = "Translation_Assistant";
page["Visual Typesetting"] = "Visual_Typesetting";
}
}
HelpButton::HelpButton(wxWindow *parent, wxString const& page, wxPoint position, wxSize size)
: wxButton(parent, wxID_HELP, "", position, size)
{
Bind(wxEVT_COMMAND_BUTTON_CLICKED, std::tr1::bind(&HelpButton::OpenPage, page));
init_static();
if (pages->find(page) == pages->end())
throw agi::InternalError("Invalid help page", 0);
}
void HelpButton::OpenPage(wxString const& pageID) {
init_static();
wxString page = (*pages)[pageID];
wxString section;
page = page.BeforeFirst('#', &section);
wxFileName docFile(StandardPaths::DecodePath("?data/docs/"), page, "html", wxPATH_NATIVE);
wxString url;
// If we can read a file by the constructed name, assume we have a local copy of the manual
if (docFile.IsFileReadable())
// Tested IE8, Firefox 3.5, Safari 4, Chrome 4 and Opera 10 on Windows, they all handle
// various variations of slashes, missing one at the start and using backslashes throughout
// is safe with everything everyone uses. Blame Microsoft.
url = wxString("file://") + docFile.GetFullPath(wxPATH_NATIVE);
else
url = wxString::Format("http://docs.aegisub.org/3.0/%s/#%s", page, section);
wxLaunchDefaultBrowser(url);
}
void HelpButton::ClearPages() {
delete pages;
}