GUI/Widgets/vtkKWMenu.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWMenu.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 __vtkKWMenu_h
#define __vtkKWMenu_h

#include "vtkKWCoreWidget.h"

class KWWIDGETS_EXPORT vtkKWMenu : public vtkKWCoreWidget
{
public:
  static vtkKWMenu* New();
  vtkTypeRevisionMacro(vtkKWMenu,vtkKWCoreWidget);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  virtual void Create(vtkKWApplication* app);
  

  void AddSeparator();
  void InsertSeparator(int position);
  

  void AddCascade(const char* label, vtkKWMenu*, 
                  int underline, const char* help = 0);
  void InsertCascade(int position, const char* label,  vtkKWMenu*, 
                     int underline, const char* help = 0  );
  int GetCascadeIndex(vtkKWMenu *);


  void SetCascade(int index, vtkKWMenu*);
  void SetCascade(const char *label, vtkKWMenu*);
  void SetCascade(int index, const char *menu_name);
  void SetCascade(const char *label, const char *menu_name);

  char* CreateCheckButtonVariable(vtkKWObject* Object, const char* name);
  int   GetCheckButtonValue(vtkKWObject* Object, const char* name);
  void  CheckCheckButton(vtkKWObject *Object, const char *name, int val);
  void AddCheckButton(const char* label, const char* ButtonVar, 
                      vtkObject* Object, 
                      const char* MethodAndArgString , const char* help = 0);
  void AddCheckButton(const char* label, const char* ButtonVar, 
                      vtkObject* Object, 
                      const char* MethodAndArgString , int underline,
                      const char* help = 0);
  void InsertCheckButton(int position, 
                         const char* label, const char* ButtonVar, 
                         vtkObject* Object, 
                         const char* MethodAndArgString , const char* help = 0);
  void InsertCheckButton(int position, 
                         const char* label, const char* ButtonVar, 
                         vtkObject* Object, 
                         const char* MethodAndArgString , 
                         int underline, const char* help = 0);


  void AddCommand(const char* label, vtkObject* Object,
                  const char* MethodAndArgString , const char* help = 0);
  void AddCommand(const char* label, vtkObject* Object,
                  const char* MethodAndArgString , int underline, 
                  const char* help = 0);
  void InsertCommand(int position, const char* label, vtkObject* Object,
                     const char* MethodAndArgString , const char* help = 0);
  void InsertCommand(int position, const char* label, vtkObject* Object,
                     const char* MethodAndArgString , 
                     int underline, const char* help = 0);


  void SetEntryCommand(int index, vtkObject* object, 
                       const char* MethodAndArgString);
  void SetEntryCommand(const char* item, vtkObject* object, 
                       const char* method);
  void SetEntryCommand(int item, const char* method);
  void SetEntryCommand(const char* item, const char* method);


  char* CreateRadioButtonVariable(vtkKWObject* Object, const char* varname);
  int   GetRadioButtonValue(vtkKWObject* Object, const char* varname);
  void  CheckRadioButton(vtkKWObject *Object, const char *varname, int id);
  int   GetCheckedRadioButtonItem(vtkKWObject *Object, const char *varname);
  void AddRadioButton(int value, const char* label, const char* buttonVar, 
                      vtkObject* Called, 
                      const char* MethodAndArgString, const char* help = 0);
  void AddRadioButton(int value, const char* label, const char* buttonVar, 
                      vtkObject* Called, 
                      const char* MethodAndArgString, int underline,  
                      const char* help = 0);
  void AddRadioButtonImage(int value, const char* imgname, 
                           const char* buttonVar, vtkObject* Called, 
                          const char* MethodAndArgString, const char* help = 0);
  void  InsertRadioButton(int position, int value, const char* label, 
                          const char* buttonVar, vtkObject* Called, 
                          const char* MethodAndArgString, const char* help = 0);
  void  InsertRadioButton(int position, int value, const char* label, 
                          const char* buttonVar, vtkObject* Called, 
                          const char* MethodAndArgString, 
                          int underline, const char* help = 0);


  void AddGeneric(const char* addtype, const char* label, vtkObject* Object,
                  const char* MethodAndArgString, const char* extra, 
                  const char* help);
  void InsertGeneric(int position, const char* addtype, const char* label, 
                     vtkObject* Object,
                     const char* MethodAndArgString, const char* extra, 
                     const char* help);


  void Invoke(int position);
  void Invoke(const char *label);


  void DeleteMenuItem(int position);
  void DeleteMenuItem(const char *label);
  void DeleteAllMenuItems();
  

  int GetIndexOfItem(const char *label);
  int GetIndexOfCommand(vtkObject* Object, const char* MethodAndArgString);

  const char* GetItemCommand(int idx);


  int GetItemLabel(int position, char* label, int maxlen);
  const char* GetItemLabel(int position);


  int HasItemOption(int position, const char *option);
  const char* GetItemOption(int position, const char *option);
  const char* GetItemOption(const char *label, const char *option);


  void SetItemImage(int position, const char *imagename);
  void SetItemImage(const char *label, const char *imagename);
  void SetItemImageToPredefinedIcon(int position, int icon_index);
  void SetItemImageToPredefinedIcon(const char *label, int icon_index);


  void SetItemSelectImage(int position, const char *imagename);
  void SetItemSelectImage(const char *label, const char *imagename);
  void SetItemSelectImageToPredefinedIcon(int position, int icon_index);
  void SetItemSelectImageToPredefinedIcon(const char *label, int icon_index);


  void SetItemCompoundMode(int position, int flag);
  void SetItemCompoundMode(const char *label, int flag);


  void SetItemMarginVisibility(int position, int flag);
  void SetItemMarginVisibility(const char *label, int flag);


  void SetItemIndicatorVisibility(int position, int flag);
  void SetItemIndicatorVisibility(const char *label, int flag);


  void SetItemAccelerator(int position, const char *accelerator);
  void SetItemAccelerator(const char *label, const char *accelerator);

  int HasItem(const char* label);

  int GetNumberOfItems();
  
  void DisplayHelp(const char*);
  

  void SetTearOff(int val);
  vtkGetMacro(TearOff, int);
  vtkBooleanMacro(TearOff, int);


  virtual void SetItemState(int index, int state);
  virtual void SetItemState(const char *label, int state);
  virtual int  GetItemState(int index);
  virtual int  GetItemState(const char *label);

  virtual void SetState(int state);

  void ConfigureItem(int index, const char*);

  virtual void SetEnabled(int);

  virtual void UpdateEnableState();

protected:
  
  vtkKWMenu();
  ~vtkKWMenu();

  int TearOff;
  
private:
  vtkKWMenu(const vtkKWMenu&); // Not implemented
  void operator=(const vtkKWMenu&); // Not implemented
};


#endif

---