/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbwxSlider.h,v $
  Language:  C++
  Date:      $Date: 2008/01/22 15:02:00 $
  Version:   $Revision: 1.1.1.1 $
                                                                                
  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  l'Image). All rights reserved. See Doc/License.txt or
  http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
                                                                                
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
                                                                                
=========================================================================*//**
/**
 * \file 
 * \brief Short description in one line
 * 
 * Long description which 
 * can span multiple lines
*/

/**
 * \class bbwx::Slider
 * \brief 

 * \class bbwx::SliderWidget
 * \brief 
 */


#ifdef _USE_WXWIDGETS_


// Prevents multiple inclusions : use symbols of the form
// __FILENAME_INCLUDED__ 
// where FILENAME must be replaced by the actual file name
#ifndef __bbwxSlider_h_INCLUDED__
#define __bbwxSlider_h_INCLUDED__

// Include wxBlackBox definition
#include "bbtkWxBlackBox.h"



// Namespace of the package "wx" is "bbwx" 
// Namespace associated to packages should be of the form :
// bbPACKAGENAME
namespace bbwx
{
  
  
  



  //--------------------------------------------------------------------------
  // Forward declaration of the box
  class Slider;
  //--------------------------------------------------------------------------



  
  //--------------------------------------------------------------------------
  // The widget created by the box 
  // Its name should be : BOXNAMEWidget
  // It should inherit WxBlackBoxWidget or a descendant such as WxBlackBoxWidgetPanel
  class SliderWidget : public wxPanel //public bbtk::WxBlackBoxWidgetPanel
  {
  public:
    /// Ctor with the two first params the parent window and the creator box
    /// which must be passed to the WxBlackBoxWidget constructor.
    /// The other params initialize the widget 
    SliderWidget(Slider* box, wxWindow *parent,
		 int orientation,
		 bool changeresolution,
		 bool label, 
		 wxString title,
		 int vmin,
		 int vmax,
		 int value,
       int track);
    /// Dtor
    ~SliderWidget();
    /// Events callbacks
    /// Called when the slider is moved
    void OnSliderTrack(wxScrollEvent& event);
    /// Called when the slider is released
    void OnSliderRelease(wxScrollEvent& event);
    /// Called when the little slider which controls the resolution
    /// of the main slider is moved (if activated)
    void OnResolutionOfSlider(wxScrollEvent& event);

    // Accessors
    int  GetValue() { return mwxSlider->GetValue(); }
    void SetRange(int min, int max);
    // Update the texts which display the min/max/current values of the slider
    void RefreshLabels();
	
  private:
    Slider*    mBox;
    wxSlider   *mwxSlider;
    wxSlider   *mResolutionOfSlider;
    int        min;
    int        max;
    int        reactiveOnTrack;
    wxStaticText	*label_vertical;
    wxStaticText	*label_min;
    wxStaticText	*label_max;
  };
  //------------------------------------------------------------------------
  //------------------------------------------------------------------------
  //------------------------------------------------------------------------

  
  
  
  //------------------------------------------------------------------------
  // The black box
  class /*BBTK_EXPORT*/ Slider : public bbtk::WxBlackBox
  {
    
    BBTK_USER_BLACK_BOX_INTERFACE(Slider,bbtk::WxBlackBox);
    BBTK_DECLARE_INPUT(In,int);
    BBTK_DECLARE_INPUT(Min,int);
    BBTK_DECLARE_INPUT(Max,int);
    BBTK_DECLARE_INPUT(Label,bool);
    BBTK_DECLARE_INPUT(Title,std::string);
    BBTK_DECLARE_INPUT(Orientation,int);
    BBTK_DECLARE_INPUT(ChangeResolution,bool);
    BBTK_DECLARE_INPUT(ReactiveOnTrack,int);    
    BBTK_DECLARE_OUTPUT(Out,int);
    BBTK_PROCESS(Process);
    void Process();

  protected:
    virtual void bbUserConstructor();
    
    //  private:
    //  virtual bbtk::WxBlackBoxWidget* bbUserCreateWidget(wxWindow *parent);
  };
  //=================================================================
 
  //=================================================================
  // the black box description
  BBTK_BEGIN_DESCRIBE_BLACK_BOX(Slider,bbtk::WxBlackBox);
  BBTK_NAME("Slider");
  BBTK_AUTHOR("eduardo.davila@creatis.insa-lyon.fr");
  BBTK_DESCRIPTION("Slider widget (wxSlider)");
  BBTK_INPUT(Slider,In,"Initial position of the slider (default 0)",int);
  BBTK_INPUT(Slider,Min,"Minimum value of the slider (default 0)",int);
  BBTK_INPUT(Slider,Max,"Maximum value of the slider (default 500)",int);
  BBTK_INPUT(Slider,Label,"Show slider labels ? (default FALSE) ",bool);
  BBTK_INPUT(Slider,Title,"Title shown above the slider (default '') ",
	     std::string);
  BBTK_INPUT(Slider,Orientation,
	     "Orientation : 0=Horizontal / 1=Vertical (default 0)",int);
  BBTK_INPUT(Slider,ChangeResolution,
	     "Can the user change the resolution of the slider ? (default FALSE) ",bool);
  BBTK_INPUT(Slider,ReactiveOnTrack,
	     "Slider sends info when track moves (default 0 = no)",int);  
  BBTK_OUTPUT(Slider,Out,"Current position of the slider",int);
  BBTK_END_DESCRIBE_BLACK_BOX(Slider);
  //=================================================================
  


} //namespace bbwx

#endif  //__bbtkwxSlider_h_INCLUDED__

#endif //_USE_WXWIDGETS_