vtkSMEnumerationDomain.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkSMEnumerationDomain.h

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

=========================================================================*/
#ifndef vtkSMEnumerationDomain_h
#define vtkSMEnumerationDomain_h

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMDomain.h"

#include <utility> // for std::pair
#include <vector>  //  for std::vector

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMEnumerationDomain : public vtkSMDomain
{
public:
  static vtkSMEnumerationDomain* New();
  vtkTypeMacro(vtkSMEnumerationDomain, vtkSMDomain);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  int IsInDomain(vtkSMProperty* property) override;

  int IsInDomain(int val, unsigned int& idx);

  unsigned int GetNumberOfEntries();

  int GetEntryValue(unsigned int idx);

  const char* GetEntryText(unsigned int idx);

  const char* GetEntryTextForValue(int value);

  int HasEntryText(const char* text);

  int GetEntryValueForText(const char* text);

  int GetEntryValue(const char* text, int& valid);

  const char* GetInfoText(unsigned int idx);

  void AddEntry(const char* text, int value, const char* info = nullptr);

  void RemoveAllEntries();

  void Update(vtkSMProperty* property) override;


  int SetDefaultValues(vtkSMProperty*, bool use_unchecked_values) override;

protected:
  vtkSMEnumerationDomain();
  ~vtkSMEnumerationDomain() override;

  int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element) override;

  void ChildSaveState(vtkPVXMLElement* domainElement) override;

private:
  vtkSMEnumerationDomain(const vtkSMEnumerationDomain&) = delete;
  void operator=(const vtkSMEnumerationDomain&) = delete;

  struct vtkEDInternals;
  vtkEDInternals* EInternals;
};

#endif