/*
# ---------------------------------------------------------------------
#
# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
#                        pour la Sant�)
# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
# Previous Authors : Laurent Guigues, Jean-Pierre Roux
# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
#
#  This software is governed by the CeCILL-B license under French law and 
#  abiding by the rules of distribution of free software. You can  use, 
#  modify and/ or redistribute the software under the terms of the CeCILL-B 
#  license as circulated by CEA, CNRS and INRIA at the following URL 
#  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
#  or in the file LICENSE.txt.
#
#  As a counterpart to the access to the source code and  rights to copy,
#  modify and redistribute granted by the license, users are provided only
#  with a limited warranty  and the software's author,  the holder of the
#  economic rights,  and the successive licensors  have only  limited
#  liability. 
#
#  The fact that you are presently reading this means that you have had
#  knowledge of the CeCILL-B license and that you accept its terms.
# ------------------------------------------------------------------------ 
*/ 


/*
 * wxCDMBlackBoxHelpDialog.h
 *
 *  Created on: 11/1/2013
 *      Author: Daniel Felipe Gonzalez Obando
 */

#ifndef WXCDMBLACKBOXHELPDIALOG_H_
#define WXCDMBLACKBOXHELPDIALOG_H_

#include <creaWx.h>
#include <wx/dialog.h>

#include "modelCDMBlackBox.h"

#include <vector>

/**
 * Black Box Panel Help Dialog
 */
class wxCDMBlackBoxHelpDialog : public wxDialog
{
  DECLARE_EVENT_TABLE()
public:
  /**
   * Black Box Panel Help Dialog Constructor.
   * @param parent Parent window.
   * @param blackBox Black Box class reference.
   * @param id Dialog ID. By default wxID_ANY.
   * @param caption Dialog label. By default "Working with Black Boxes".
   * @param position Dialog position. By default wxDefaultPosition.
   * @param size Dialog size. By default 410, 700.
   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
   */
  wxCDMBlackBoxHelpDialog(
      wxWindow* parent,
      modelCDMBlackBox* blackBox,
      wxWindowID id = wxID_ANY,
      const wxString& caption = wxT("Working With Black Boxes"),
      const wxPoint& position = wxDefaultPosition,
      const wxSize& size = wxSize(410,700),
      long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
  );
  /**
   * Destructor.
   */
  ~wxCDMBlackBoxHelpDialog();
  /**
   * Black Box Panel Help Dialog Creator.
   * @param parent Parent window.
   * @param id Dialog ID. By default wxID_ANY.
   * @param caption Dialog label. By default "Working with Black Boxes".
   * @param position Dialog position. By default wxDefaultPosition.
   * @param size Dialog size. By default 410, 700.
   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
   * @return if the creation was successful.
   */
  bool Create(
      wxWindow* parent,
      wxWindowID id = wxID_ANY,
      const wxString& caption = wxT("Working With Black Boxes"),
      const wxPoint& position = wxDefaultPosition,
      const wxSize& size = wxSize(410,700),
      long style = wxDEFAULT_DIALOG_STYLE
  );

protected:
  /**
   * Creates the help controls (text and buttons).
   */
  void CreateControls();

private:
  /**
   * Black Box class reference.
   */
  modelCDMBlackBox* blackBox;

//handlers
protected:
  /**
   * Handler to close help dialog.
   * @param event Unused.
   */
  void OnFinish(wxCommandEvent& event);

  /**
   * Handler when a cmakelists button is pressed.
   * @param event cmakelists event.
   */
  void OnCMakeLists(wxCommandEvent& event);

  /**
   * Handler when a cmakelists button is hovered.
   * @param event cmakelists event.
   */
  void OnCMakeListsEnter(wxMouseEvent& event);
  /**
   * Handler when a cmakelists button hover finishes.
   * @param event cmakelists event.
   */
  void OnCMakeListsExit(wxMouseEvent& event);

  /**
   * Handler when the disable help checkbox is changed.
   * @param event check box event.
   */
  void OnDisableHelp(wxCommandEvent& event);
};

#endif /* WXCDMBLACKBOXHELPDIALOG_H_ */