/* WARNING: This file was generated by dkct. Changes you make here will be lost if dkct is run again! You should modify the original source and run dkct on it. Original source: Dk4WxHelpController.cpt */ /* Copyright (C) 2015-2017, Dirk Krause 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 opyright 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 author nor the names of 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. */ /** @file Dk4WxHelpController.cpp The Dk4WxHelpController module. */ #line 158 "Dk4WxHelpController.cpt" #include "dk4strd.h" #include "dk4strx.h" #include "dk4fs.h" #include "dk4mem.h" #include "dk4mpl.h" #include "Dk4WxHelpController.h" #line 169 "Dk4WxHelpController.cpt" static const wxChar * const dk4wxhc_kw_def[] = { /* 0 */ wxT("Help file not found"), /* 1 */ wxT("The file containing online help text was not found on your computer!"), NULL #line 177 "Dk4WxHelpController.cpt" }; Dk4WxHelpController::Dk4WxHelpController() #ifdef __WXMSW__ #else : oHelpController(wxHF_DEFAULT_STYLE | wxHF_MERGE_BOOKS) #endif { pAppHelp = NULL; pdksShortFileName = NULL; bLoaded = false; bFileFound = false; } Dk4WxHelpController::~Dk4WxHelpController() { dk4mem_release(pdksShortFileName); pAppHelp = NULL; bLoaded = false; bFileFound = false; } bool Dk4WxHelpController::Initialize( Dk4WxApplicationHelper *ahptr, const dkChar *chmName, const dkChar *htbName ) { const dkChar *fn = NULL; bool back = false; #ifdef __WXMSW__ fn = chmName; #else fn = htbName; #endif if ((NULL != ahptr) && (NULL != fn)) { pAppHelp = ahptr; bLoaded = false; bFileFound = false; pdksShortFileName = dk4str_dup(fn, NULL); if (NULL != pdksShortFileName) { back = true; } else { /* ERROR: Memory */ ShowErrorMessage(6, 7); } } else { /* ERROR: Illegal arguments to function */ ShowErrorMessage(6, 8); } return back; } void Dk4WxHelpController::Cleanup(void) { { wxCriticalSectionLocker lock(csProtect); dk4mem_release(pdksShortFileName); pAppHelp = NULL; bLoaded = false; bFileFound = false; } } void Dk4WxHelpController::AttemptToLoadFile(void) { wxChar fnb[DK4_MAX_PATH]; size_t szfnb = DK4_SIZEOF(fnb,wxChar); if (!bLoaded) { bLoaded = true; if ((NULL != pAppHelp) && (NULL != pdksShortFileName)) { if (pAppHelp->FindDataFile(fnb, szfnb, pdksShortFileName)) { bFileFound = true; #ifdef __WXMSW__ oHelpController.Initialize(fnb); #else oHelpController.AddBook(fnb); #endif } } } } void Dk4WxHelpController::ShowErrorMessage(size_t i_title, size_t i_text) { const wxChar *strTitle = NULL; const wxChar *strText = NULL; { wxCriticalSectionLocker lock(csProtect); if (NULL != pAppHelp) { strTitle = pAppHelp->GetBasicString(i_title); strText = pAppHelp->GetBasicString(i_text); } } if (NULL == strTitle) { strTitle = dk4wxhc_kw_def[i_title]; } if (NULL == strText) { strText = dk4wxhc_kw_def[i_text]; } wxMessageBox(strText, strTitle, (wxOK | wxCENTRE | wxICON_ERROR)); } void Dk4WxHelpController::DisplayContents() { bool canOpenHelp = false; { wxCriticalSectionLocker lock(csProtect); AttemptToLoadFile(); if (bLoaded) { if (bFileFound) { canOpenHelp = true; } } } if (canOpenHelp) { oHelpController.DisplayContents(); } else { ShowErrorMessage(); } } void Dk4WxHelpController::DisplaySection(wxString const & name) { bool canOpenHelp = false; { wxCriticalSectionLocker lock(csProtect); AttemptToLoadFile(); if (bLoaded) { if (bFileFound) { canOpenHelp = true; } } } if (canOpenHelp) { oHelpController.DisplaySection(name); } else { ShowErrorMessage(); } } void Dk4WxHelpController::DisplaySection(int number) { bool canOpenHelp = false; { wxCriticalSectionLocker lock(csProtect); AttemptToLoadFile(); if (bLoaded) { if (bFileFound) { canOpenHelp = true; } } } if (canOpenHelp) { oHelpController.DisplaySection(number); } else { ShowErrorMessage(); } }