vtkXlibHardwareWindow.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause

#ifndef vtkXlibHardwareWindow_h
#define vtkXlibHardwareWindow_h

#include "vtkHardwareWindow.h"
#include "vtkRenderingUIModule.h" // For export macro

#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
#include "vtkX11Functions.h"  // Needed for X types used in the public interface

VTK_ABI_NAMESPACE_BEGIN
// Forward declarations
class vtkImageData;

class VTKRENDERINGUI_EXPORT VTK_MARSHALAUTO vtkXlibHardwareWindow : public vtkHardwareWindow
{
public:
  static vtkXlibHardwareWindow* New();
  vtkTypeMacro(vtkXlibHardwareWindow, vtkHardwareWindow);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  Display* GetDisplayId();
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetDisplayId(Display* display);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetParentId(Window);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  Window GetWindowId();


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetWindowId(Window);
  void SetWindowId(void*) override;

  void Create() override;
  void Destroy() override;


  void SetDisplayId(void*) override;
  void SetParentId(void*) override;
  void* GetGenericDisplayId() override;
  void* GetGenericWindowId() override;
  void* GetGenericParentId() override;


  void SetSize(int, int) override;
  using vtkHardwareWindow::SetSize;


  void SetPosition(int, int) override;
  using vtkHardwareWindow::SetPosition;


  void HideCursor() override;
  void ShowCursor() override;

  void SetCurrentCursor(int) override;

  void SetWindowName(const char*) override;

  void SetIcon(vtkImageData* img) override;

  void SetWindowInfo(const char* info) override;

  void SetCoverable(vtkTypeBool coverable) override;

  bool EnsureDisplay() override;


  vtkTypeBool GetOwnDisplay();
  void SetOwnDisplay(vtkTypeBool ownDisplay);

  void CloseDisplay();

protected:
  vtkXlibHardwareWindow();
  ~vtkXlibHardwareWindow() override;

  // Helper members
  vtkXVisualInfo* GetDesiredVisualInfo();

  Display* DisplayId;
  Window ParentId;
  Window WindowId;
  Colormap ColorMap;
  vtkTypeBool OwnDisplay;
  vtkTypeBool OwnWindow;
  vtkTypeBool CursorHidden;

  // we must keep track of the cursors we are using
  Cursor XCCrosshair;
  Cursor XCArrow;
  Cursor XCSizeAll;
  Cursor XCSizeNS;
  Cursor XCSizeWE;
  Cursor XCSizeNE;
  Cursor XCSizeNW;
  Cursor XCSizeSE;
  Cursor XCSizeSW;
  Cursor XCHand;
  Cursor XCCustom;

private:
  vtkXlibHardwareWindow(const vtkXlibHardwareWindow&) = delete;
  void operator=(const vtkXlibHardwareWindow&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif // vtkXlibHardwareWindow_h