vtkSlicerModuleCollapsibleFrame.h

Go to the documentation of this file.

#ifndef __vtkSlicerModuleCollapsibleFrame_h
#define __vtkSlicerModuleCollapsibleFrame_h


#include "vtkSlicerBaseGUIWin32Header.h"
#include "vtkKWCompositeWidget.h"

class vtkKWFrame;
class vtkKWIcon;
class vtkKWLabel;
class vtkKWLabelWithLabel;

class VTK_SLICER_BASE_GUI_EXPORT vtkSlicerModuleCollapsibleFrame : public vtkKWCompositeWidget
{
 public:
  static vtkSlicerModuleCollapsibleFrame* New();
  vtkTypeRevisionMacro(vtkSlicerModuleCollapsibleFrame, vtkKWCompositeWidget);
  void PrintSelf(ostream& os, vtkIndent indent);

  void SetLabelText(const char *);
  
  vtkGetObjectMacro(Frame, vtkKWFrame);

  vtkGetObjectMacro(LabelFrame, vtkKWFrame);

  virtual vtkKWLabel *GetLabel();

  virtual void CollapseFrame();
  virtual void ExpandFrame();
  virtual int IsFrameCollapsed();

  vtkSetMacro(AllowFrameToCollapse, int);
  vtkBooleanMacro(AllowFrameToCollapse, int);
  vtkGetMacro(AllowFrameToCollapse, int);

  static int GetDefaultAllowFrameToCollapse();
  static void SetDefaultAllowFrameToCollapse(int);
  static void DefaultAllowFrameToCollapseOn()
    { vtkSlicerModuleCollapsibleFrame::SetDefaultAllowFrameToCollapse(1); };
  static void DefaultAllowFrameToCollapseOff()
    { vtkSlicerModuleCollapsibleFrame::SetDefaultAllowFrameToCollapse(0); };

  //BTX
  enum
  {
    LabelCaseUserSpecified = 0,
    LabelCaseUppercaseFirst,
    LabelCaseLowercaseFirst
  };
  //ETX
  static void SetDefaultLabelCase(int v);
  static int GetDefaultLabelCase();
  static void SetDefaultLabelCaseToUserSpecified() 
    { vtkSlicerModuleCollapsibleFrame::SetDefaultLabelCase(
      vtkSlicerModuleCollapsibleFrame::LabelCaseUserSpecified);};
  static void SetDefaultLabelCaseToUppercaseFirst() 
    {vtkSlicerModuleCollapsibleFrame::SetDefaultLabelCase(
      vtkSlicerModuleCollapsibleFrame::LabelCaseUppercaseFirst);};
  static void SetDefaultLabelCaseToLowercaseFirst() 
    {vtkSlicerModuleCollapsibleFrame::SetDefaultLabelCase(
      vtkSlicerModuleCollapsibleFrame::LabelCaseLowercaseFirst);};

  //BTX
  enum
  {
    LabelFontWeightNormal = 0,
    LabelFontWeightBold
  };
  //ETX
  static void SetDefaultLabelFontWeight(int v);
  static int GetDefaultLabelFontWeight();
  static void SetDefaultLabelFontWeightToNormal() 
    { vtkSlicerModuleCollapsibleFrame::SetDefaultLabelFontWeight(
      vtkSlicerModuleCollapsibleFrame::LabelFontWeightNormal);};
  static void SetDefaultLabelFontWeightToBold() 
    {vtkSlicerModuleCollapsibleFrame::SetDefaultLabelFontWeight(
      vtkSlicerModuleCollapsibleFrame::LabelFontWeightBold);};

  virtual void SetLimitedEditionModeIconVisibility(int);
  vtkBooleanMacro(LimitedEditionModeIconVisibility, int);
  vtkGetMacro(LimitedEditionModeIconVisibility, int);

  virtual void UpdateEnableState();

  virtual vtkKWDragAndDropTargetSet* GetDragAndDropTargetSet();

  virtual void SetWidth(int);
  virtual int GetWidth();
  virtual void SetHeight(int);
  virtual int GetHeight();

  vtkGetObjectMacro(CollapsibleFrame, vtkKWFrame);
  vtkGetObjectMacro (Icon, vtkKWLabel);
  
  virtual void AdjustMarginCallback();
  virtual void CollapseButtonCallback();
  virtual void LabelSingleClickCallback();

  //BTX
  enum
    {
      FrameCollapseEvent = 11000,
      FrameExpandEvent,
    };
  //ETX

 protected:
  vtkSlicerModuleCollapsibleFrame();
  ~vtkSlicerModuleCollapsibleFrame();

  virtual void CreateWidget();

  vtkKWFrame          *Frame;
  vtkKWFrame          *LabelFrame;
  vtkKWLabelWithLabel *Label;
  vtkKWFrame          *ExternalMarginFrame;
  vtkKWFrame          *InternalMarginFrame;
  vtkKWFrame          *CollapsibleFrame;
  vtkKWLabel          *Icon;
  vtkKWIcon           *IconData;

  int AllowFrameToCollapse;
  int LimitedEditionModeIconVisibility;

  static int DefaultAllowFrameToCollapse;
  static int DefaultLabelFontWeight;
  static int DefaultLabelCase;

  virtual vtkKWLabel *GetLabelIcon();

  
 private:
  vtkSlicerModuleCollapsibleFrame(const vtkSlicerModuleCollapsibleFrame&); 
  void operator=(const vtkSlicerModuleCollapsibleFrame&); 
};

#endif