vtkKWMenuButton.h

Go to the documentation of this file.

/*=========================================================================

  Module:    $RCSfile: vtkKWMenuButton.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 notice for more information.

=========================================================================*/
#ifndef __vtkKWMenuButton_h
#define __vtkKWMenuButton_h

#include "vtkKWCoreWidget.h"

class vtkKWMenu;
class vtkKWIcon;
class vtkKWMenuButtonInternals;

class KWWidgets_EXPORT vtkKWMenuButton : public vtkKWCoreWidget
{
// @cond section_public
public:
  static vtkKWMenuButton* New();
  vtkTypeRevisionMacro(vtkKWMenuButton,vtkKWCoreWidget);
  void PrintSelf(ostream& os, vtkIndent indent);


  virtual const char *GetValue();
  virtual void SetValue(const char *name);


  virtual void NextValue();
  virtual void PreviousValue();


  vtkGetObjectMacro(Menu, vtkKWMenu);


  virtual void SetIndicatorVisibility(int ind);
  virtual int GetIndicatorVisibility();
  vtkBooleanMacro(IndicatorVisibility, int);


  virtual void SetWidth(int width);
  virtual int GetWidth();
  

  virtual void SetMaximumLabelWidth(int);
  vtkGetMacro(MaximumLabelWidth, int);


  virtual void SetAdjustLabelWidthToWidgetSize(int);
  vtkGetMacro(AdjustLabelWidthToWidgetSize, int);
  vtkBooleanMacro(AdjustLabelWidthToWidgetSize, int);


  virtual void GetBackgroundColor(double *r, double *g, double *b);
  virtual double* GetBackgroundColor();
  virtual void SetBackgroundColor(double r, double g, double b);
  virtual void SetBackgroundColor(double rgb[3])
    { this->SetBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  

  virtual void GetForegroundColor(double *r, double *g, double *b);
  virtual double* GetForegroundColor();
  virtual void SetForegroundColor(double r, double g, double b);
  virtual void SetForegroundColor(double rgb[3])
    { this->SetForegroundColor(rgb[0], rgb[1], rgb[2]); };


  virtual void SetHighlightThickness(int);
  virtual int GetHighlightThickness();
  

  virtual void GetActiveBackgroundColor(double *r, double *g, double *b);
  virtual double* GetActiveBackgroundColor();
  virtual void SetActiveBackgroundColor(double r, double g, double b);
  virtual void SetActiveBackgroundColor(double rgb[3])
    { this->SetActiveBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  

  virtual void GetActiveForegroundColor(double *r, double *g, double *b);
  virtual double* GetActiveForegroundColor();
  virtual void SetActiveForegroundColor(double r, double g, double b);
  virtual void SetActiveForegroundColor(double rgb[3])
    { this->SetActiveForegroundColor(rgb[0], rgb[1], rgb[2]); };
  

  virtual void GetDisabledForegroundColor(double *r, double *g, double *b);
  virtual double* GetDisabledForegroundColor();
  virtual void SetDisabledForegroundColor(double r, double g, double b);
  virtual void SetDisabledForegroundColor(double rgb[3])
    { this->SetDisabledForegroundColor(rgb[0], rgb[1], rgb[2]); };


  virtual void SetBorderWidth(int);
  virtual int GetBorderWidth();
  

  virtual void SetRelief(int);
  virtual int GetRelief();
  virtual void SetReliefToRaised();
  virtual void SetReliefToSunken();
  virtual void SetReliefToFlat();
  virtual void SetReliefToRidge();
  virtual void SetReliefToSolid();
  virtual void SetReliefToGroove();


  virtual void SetFont(const char *font);
  virtual const char* GetFont();


  virtual void SetPadX(int);
  virtual int GetPadX();
  virtual void SetPadY(int);
  virtual int GetPadY();


  virtual void SetAnchor(int);
  virtual int GetAnchor();
  virtual void SetAnchorToNorth();
  virtual void SetAnchorToNorthEast();
  virtual void SetAnchorToEast();
  virtual void SetAnchorToSouthEast();
  virtual void SetAnchorToSouth();
  virtual void SetAnchorToSouthWest();
  virtual void SetAnchorToWest();
  virtual void SetAnchorToNorthWest();
  virtual void SetAnchorToCenter();


  virtual void SetImageToIcon(vtkKWIcon *icon);
  virtual void SetImageToPredefinedIcon(int icon_index);
  virtual void SetImageToPixels(
    const unsigned char *pixels, int width, int height, int pixel_size,
    unsigned long buffer_length = 0);
  

  virtual void SetCompoundMode(int);
  virtual int GetCompoundMode();
  virtual void SetCompoundModeToNone();
  virtual void SetCompoundModeToLeft();
  virtual void SetCompoundModeToCenter();
  virtual void SetCompoundModeToRight();
  virtual void SetCompoundModeToTop();
  virtual void SetCompoundModeToBottom();

  virtual void UpdateEnableState();


  virtual void TracedVariableChangedCallback(
    const char *, const char *, const char *);
  virtual void ConfigureCallback();
  virtual void UpdateMenuButtonLabelCallback();


  virtual void AddCallbackCommandObservers();
  virtual void RemoveCallbackCommandObservers();

// @endcond
// @cond section_protected
protected:
  vtkKWMenuButton();
  ~vtkKWMenuButton();

  virtual void CreateWidget();

  vtkGetStringMacro(CurrentValue);
  vtkSetStringMacro(CurrentValue);

  char      *CurrentValue;  
  vtkKWMenu *Menu;
  int       MaximumLabelWidth;
  int       AdjustLabelWidthToWidgetSize;

  virtual void UpdateMenuButtonLabel();
  virtual const char* UpdateMenuButtonLabelFromMenu(
    const char *varname, const char *value, vtkKWMenu *menu);
  virtual void ScheduleUpdateMenuButtonLabel();


  virtual void ProcessCallbackCommandEvents(
    vtkObject *caller, unsigned long event, void *calldata);

  virtual void UpdateBindings();
  
  // PIMPL Encapsulation for STL containers
  //BTX
  vtkKWMenuButtonInternals *Internals;
  //ETX

// @endcond
// @cond section_private
private:
  vtkKWMenuButton(const vtkKWMenuButton&); // Not implemented
  void operator=(const vtkKWMenuButton&); // Not implemented
};

#endif


// @endcond

---