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

   Program: ParaView
   Module:    pqSaveSnapshotDialog.h

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2. 

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#ifndef pqSaveSnapshotDialog_h
#define pqSaveSnapshotDialog_h

#include <QDialog>
#include "pqComponentsModule.h"

/// Dialog used to ask the user for the resolution of the snapshot to save.
class PQCOMPONENTS_EXPORT pqSaveSnapshotDialog : public QDialog
{
  Q_OBJECT
  typedef QDialog Superclass;
public:
  pqSaveSnapshotDialog(QWidget* parent, Qt::WindowFlags f=0);
  ~pqSaveSnapshotDialog();

  /// Set the default size for the snapshot.
  void setViewSize(const QSize& size);

  /// Returns the user selected size.
  QSize viewSize() const;

  /// Returns the quality [0, 100] choosen by the user.
  int quality() const;

  /// Specifiy if the save all views option should be visible or not.
  /// Default behaviour is to show it. It can be useful to disable the option
  /// for some custom applications where there is just a single view.
  void setEnableSaveAllViews(bool enable);

  /// Set the default all views size. viewSize is used when used when
  /// saveAllViews is false, while all views size is used when saveAllViews is
  /// true.
  void setAllViewsSize(const QSize& size);

  /// Returns if the user requested to save all views.
  bool saveAllViews() const;

  /// Returns the color palette chosen. If none is chosen 
  /// (i.e. "Current Palette" is selected, then an empty string is returned.
  QString palette() const;

  /// Returns one of the stereo mode constants defined in vtkRenderWindow.h if
  /// user selected a stereo mode. 0 is no-stereo.
  int getStereoMode() const;

protected slots:
  /// Called when the user has edited width. If aspect ratio is locked,
  /// we will scale the height to maintain the aspect ration.
  void onWidthEdited();

  void onHeightEdited();

  void onLockAspectRatio(bool);

  void updateSize();

private:
  Q_DISABLE_COPY(pqSaveSnapshotDialog)

  class pqInternal;
  pqInternal* Internal;
};

#endif


