Paul Davis
449aab3c46
git-svn-id: svn://localhost/ardour2/branches/3.0@3435 d708f5d6-7413-0410-9779-e7cbd77b26cf
327 lines
11 KiB
C++
327 lines
11 KiB
C++
// -*- c++ -*-
|
|
// Generated by gtkmmproc -- DO NOT MODIFY!
|
|
#ifndef _GTKMM_PRINTUNIXDIALOG_H
|
|
#define _GTKMM_PRINTUNIXDIALOG_H
|
|
|
|
|
|
#include <glibmm.h>
|
|
|
|
/* Copyright (C) 2006 The gtkmm Development Team
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the Free
|
|
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
|
|
#include <gtkmm/dialog.h>
|
|
#include <gtkmm/pagesetup.h>
|
|
#include <gtkmm/printer.h>
|
|
#include <gtkmm/printjob.h>
|
|
#include <gtkmm/printsettings.h>
|
|
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
typedef struct _GtkPrintUnixDialog GtkPrintUnixDialog;
|
|
typedef struct _GtkPrintUnixDialogClass GtkPrintUnixDialogClass;
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
|
|
namespace Gtk
|
|
{ class PrintUnixDialog_Class; } // namespace Gtk
|
|
namespace Gtk
|
|
{
|
|
|
|
/** PrintUnixDialog implements a print dialog for platforms
|
|
* which don't provide a native print dialog, like Unix. It can
|
|
* be used very much like any other GTK+ dialog, at the cost of
|
|
* the portability offered by the high-level printing API exposed
|
|
* through PrintOperation.
|
|
*
|
|
* In order to print something with PrintUnixDialog, you need
|
|
* to use get_selected_printer() to obtain a Printer object and
|
|
* use it to construct a PrintJob using PrintJob::create().
|
|
*
|
|
* PrintUnixDialog uses the following response values:
|
|
* - RESPONSE_OK for the "Print" button
|
|
* - RESPONSE_APPLY for the "Preview" button
|
|
* - RESPONSE_CANCEL for the "Cancel" button
|
|
*
|
|
* @newin2p10
|
|
*
|
|
* @ingroup Printing
|
|
*/
|
|
|
|
class PrintUnixDialog : public Dialog
|
|
{
|
|
public:
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
typedef PrintUnixDialog CppObjectType;
|
|
typedef PrintUnixDialog_Class CppClassType;
|
|
typedef GtkPrintUnixDialog BaseObjectType;
|
|
typedef GtkPrintUnixDialogClass BaseClassType;
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
virtual ~PrintUnixDialog();
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
private:
|
|
friend class PrintUnixDialog_Class;
|
|
static CppClassType printunixdialog_class_;
|
|
|
|
// noncopyable
|
|
PrintUnixDialog(const PrintUnixDialog&);
|
|
PrintUnixDialog& operator=(const PrintUnixDialog&);
|
|
|
|
protected:
|
|
explicit PrintUnixDialog(const Glib::ConstructParams& construct_params);
|
|
explicit PrintUnixDialog(GtkPrintUnixDialog* castitem);
|
|
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
public:
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
static GType get_type() G_GNUC_CONST;
|
|
static GType get_base_type() G_GNUC_CONST;
|
|
#endif
|
|
|
|
///Provides access to the underlying C GtkObject.
|
|
GtkPrintUnixDialog* gobj() { return reinterpret_cast<GtkPrintUnixDialog*>(gobject_); }
|
|
|
|
///Provides access to the underlying C GtkObject.
|
|
const GtkPrintUnixDialog* gobj() const { return reinterpret_cast<GtkPrintUnixDialog*>(gobject_); }
|
|
|
|
|
|
public:
|
|
//C++ methods used to invoke GTK+ virtual functions:
|
|
#ifdef GLIBMM_VFUNCS_ENABLED
|
|
#endif //GLIBMM_VFUNCS_ENABLED
|
|
|
|
protected:
|
|
//GTK+ Virtual Functions (override these to change behaviour):
|
|
#ifdef GLIBMM_VFUNCS_ENABLED
|
|
#endif //GLIBMM_VFUNCS_ENABLED
|
|
|
|
//Default Signal Handlers::
|
|
#ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
|
|
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
|
|
|
|
|
|
private:
|
|
|
|
//This is not available in on Win32.
|
|
//This source file will not be compiled,
|
|
//and the class will not be registered in wrap_init.h or wrap_init.cc
|
|
|
|
|
|
public:
|
|
explicit PrintUnixDialog(Gtk::Window& parent, const Glib::ustring& title);
|
|
explicit PrintUnixDialog(const Glib::ustring& title);
|
|
|
|
|
|
/** Sets the page setup of the Gtk::PrintUnixDialog.
|
|
*
|
|
* @newin2p10
|
|
* @param page_setup A Gtk::PageSetup.
|
|
*/
|
|
void set_page_setup(const Glib::RefPtr<PageSetup>& page_setup);
|
|
|
|
/** Gets the page setup that is used by the Gtk::PrintUnixDialog.
|
|
* @return The page setup of @a dialog .
|
|
*
|
|
* @newin2p10.
|
|
*/
|
|
Glib::RefPtr<PageSetup> get_page_setup();
|
|
|
|
/** Gets the page setup that is used by the Gtk::PrintUnixDialog.
|
|
* @return The page setup of @a dialog .
|
|
*
|
|
* @newin2p10.
|
|
*/
|
|
Glib::RefPtr<const PageSetup> get_page_setup() const;
|
|
|
|
|
|
/** Sets the current page number. If @a current_page is not -1, this enables
|
|
* the current page choice for the range of pages to print.
|
|
*
|
|
* @newin2p10
|
|
* @param current_page The current page number.
|
|
*/
|
|
void set_current_page(int current_page);
|
|
|
|
/** Gets the current page of the Gtk::PrintDialog.
|
|
* @return The current page of @a dialog
|
|
*
|
|
* @newin2p10.
|
|
*/
|
|
int get_current_page() const;
|
|
|
|
|
|
/** Sets the Gtk::PrintSettings for the Gtk::PrintUnixDialog. Typically,
|
|
* this is used to restore saved print settings from a previous print
|
|
* operation before the print dialog is shown.
|
|
*
|
|
* @newin2p10
|
|
* @param settings A Gtk::PrintSettings, or <tt>0</tt>.
|
|
*/
|
|
void set_settings(const Glib::RefPtr<PrintSettings>& print_settings);
|
|
|
|
/** Gets a new Gtk::PrintSettings object that represents the
|
|
* current values in the print dialog. Note that this creates a
|
|
* <em>new object</em>, and you need to unref it
|
|
* if don't want to keep it.
|
|
* @return A new Gtk::PrintSettings object with the values from @a dialog
|
|
*
|
|
* @newin2p10.
|
|
*/
|
|
Glib::RefPtr<PrintSettings> get_settings();
|
|
|
|
/** Gets a new Gtk::PrintSettings object that represents the
|
|
* current values in the print dialog. Note that this creates a
|
|
* <em>new object</em>, and you need to unref it
|
|
* if don't want to keep it.
|
|
* @return A new Gtk::PrintSettings object with the values from @a dialog
|
|
*
|
|
* @newin2p10.
|
|
*/
|
|
Glib::RefPtr<const PrintSettings> get_settings() const;
|
|
|
|
|
|
/** Gets the currently selected printer.
|
|
* @return The currently selected printer
|
|
*
|
|
* @newin2p10.
|
|
*/
|
|
Glib::RefPtr<Printer> get_selected_printer();
|
|
|
|
/** Gets the currently selected printer.
|
|
* @return The currently selected printer
|
|
*
|
|
* @newin2p10.
|
|
*/
|
|
Glib::RefPtr<const Printer> get_selected_printer() const;
|
|
|
|
void add_custom_tab(const Widget& child, const Glib::ustring& tab_label);
|
|
|
|
/** Adds a custom tab to the print dialog.
|
|
*
|
|
* @newin2p10
|
|
* @param child The widget to put in the custom tab.
|
|
* @param tab_label The widget to use as tab label.
|
|
*/
|
|
void add_custom_tab(const Widget& child, const Widget& tab_label);
|
|
|
|
/** This lets you specify the printing capabilities your application
|
|
* supports. For instance, if you can handle scaling the output then
|
|
* you pass Gtk::PRINT_CAPABILITY_SCALE. If you don't pass that, then
|
|
* the dialog will only let you select the scale if the printing
|
|
* system automatically handles scaling.
|
|
*
|
|
* @newin2p10
|
|
* @param capabilities The printing capabilities of your application.
|
|
*/
|
|
void set_manual_capabilities(PrintCapabilities capabilities);
|
|
|
|
#ifdef GLIBMM_PROPERTIES_ENABLED
|
|
/** The GtkPageSetup to use.
|
|
*
|
|
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
|
|
* the value of the property changes.
|
|
*/
|
|
Glib::PropertyProxy< Glib::RefPtr<PageSetup> > property_page_setup() ;
|
|
#endif //#GLIBMM_PROPERTIES_ENABLED
|
|
|
|
#ifdef GLIBMM_PROPERTIES_ENABLED
|
|
/** The GtkPageSetup to use.
|
|
*
|
|
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
|
|
* the value of the property changes.
|
|
*/
|
|
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<PageSetup> > property_page_setup() const;
|
|
#endif //#GLIBMM_PROPERTIES_ENABLED
|
|
|
|
#ifdef GLIBMM_PROPERTIES_ENABLED
|
|
/** The current page in the document.
|
|
*
|
|
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
|
|
* the value of the property changes.
|
|
*/
|
|
Glib::PropertyProxy<int> property_current_page() ;
|
|
#endif //#GLIBMM_PROPERTIES_ENABLED
|
|
|
|
#ifdef GLIBMM_PROPERTIES_ENABLED
|
|
/** The current page in the document.
|
|
*
|
|
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
|
|
* the value of the property changes.
|
|
*/
|
|
Glib::PropertyProxy_ReadOnly<int> property_current_page() const;
|
|
#endif //#GLIBMM_PROPERTIES_ENABLED
|
|
|
|
#ifdef GLIBMM_PROPERTIES_ENABLED
|
|
/** The GtkPrintSettings used for initializing the dialog.
|
|
*
|
|
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
|
|
* the value of the property changes.
|
|
*/
|
|
Glib::PropertyProxy< Glib::RefPtr<PrintSettings> > property_print_settings() ;
|
|
#endif //#GLIBMM_PROPERTIES_ENABLED
|
|
|
|
#ifdef GLIBMM_PROPERTIES_ENABLED
|
|
/** The GtkPrintSettings used for initializing the dialog.
|
|
*
|
|
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
|
|
* the value of the property changes.
|
|
*/
|
|
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<PrintSettings> > property_print_settings() const;
|
|
#endif //#GLIBMM_PROPERTIES_ENABLED
|
|
|
|
#ifdef GLIBMM_PROPERTIES_ENABLED
|
|
/** The GtkPrinter which is selected.
|
|
*
|
|
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
|
|
* the value of the property changes.
|
|
*/
|
|
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Printer> > property_selected_printer() const;
|
|
#endif //#GLIBMM_PROPERTIES_ENABLED
|
|
|
|
|
|
};
|
|
|
|
} // namespace Gtk
|
|
|
|
|
|
namespace Glib
|
|
{
|
|
/** A Glib::wrap() method for this object.
|
|
*
|
|
* @param object The C instance.
|
|
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
|
|
* @result A C++ instance that wraps this C instance.
|
|
*
|
|
* @relates Gtk::PrintUnixDialog
|
|
*/
|
|
Gtk::PrintUnixDialog* wrap(GtkPrintUnixDialog* object, bool take_copy = false);
|
|
} //namespace Glib
|
|
|
|
|
|
#endif /* _GTKMM_PRINTUNIXDIALOG_H */
|
|
|