Aegisub/aegisub/src/help_button.cpp

102 lines
3.6 KiB
C++
Raw Normal View History

2007-08-18 04:00:20 +02:00
// 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/
/// @file help_button.cpp
/// @brief Push-button opening the help file at a specified section
/// @ingroup custom_control
///
2007-08-18 04:00:20 +02:00
#include "config.h"
#include "help_button.h"
#include "options.h"
#include <libaegisub/exception.h>
#include <libaegisub/path.h>
#include <boost/filesystem/path.hpp>
2012-09-25 01:35:27 +02:00
#include <functional>
#include <map>
#include <wx/filename.h>
2013-11-21 18:13:36 +01:00
static std::map<wxString,wxString> *pages = nullptr;
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)
{
2013-12-12 03:25:13 +01:00
Bind(wxEVT_BUTTON, std::bind(&HelpButton::OpenPage, page));
init_static();
if (pages->find(page) == pages->end())
2013-11-21 18:13:36 +01:00
throw agi::InternalError("Invalid help page", nullptr);
}
void HelpButton::OpenPage(wxString const& pageID) {
init_static();
wxString page = (*pages)[pageID];
wxString section;
page = page.BeforeFirst('#', &section);
wxLaunchDefaultBrowser(wxString::Format("http://docs.aegisub.org/3.1/%s/#%s", page, section));
}
void HelpButton::ClearPages() {
delete pages;
}