/usr/include/gtkmm-3.0/gtkmm/printsettings.h is in libgtkmm-3.0-dev 3.10.1-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 | // -*- c++ -*-
// Generated by gmmproc 2.38.0 -- DO NOT MODIFY!
#ifndef _GTKMM_PRINTSETTINGS_H
#define _GTKMM_PRINTSETTINGS_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.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 Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <vector>
#include <glibmm/object.h>
#include <gtkmm/enums.h>
#include <gtkmm/papersize.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkPrintSettings GtkPrintSettings;
typedef struct _GtkPrintSettingsClass GtkPrintSettingsClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class PrintSettings_Class; } // namespace Gtk
namespace Gtk
{
/** @addtogroup gtkmmEnums gtkmm Enums and Flags */
/**
*
* @ingroup gtkmmEnums
*/
enum PrintDuplex
{
PRINT_DUPLEX_SIMPLEX,
PRINT_DUPLEX_HORIZONTAL,
PRINT_DUPLEX_VERTICAL
};
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::PrintDuplex> : public Glib::Value_Enum<Gtk::PrintDuplex>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
/**
*
* @ingroup gtkmmEnums
*/
enum PrintQuality
{
PRINT_QUALITY_LOW,
PRINT_QUALITY_NORMAL,
PRINT_QUALITY_HIGH,
PRINT_QUALITY_DRAFT
};
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::PrintQuality> : public Glib::Value_Enum<Gtk::PrintQuality>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
/**
*
* @ingroup gtkmmEnums
*/
enum PrintPages
{
PRINT_PAGES_ALL,
PRINT_PAGES_CURRENT,
PRINT_PAGES_RANGES,
PRINT_PAGES_SELECTION
};
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::PrintPages> : public Glib::Value_Enum<Gtk::PrintPages>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
/**
*
* @ingroup gtkmmEnums
*/
enum PageSet
{
PAGE_SET_ALL,
PAGE_SET_EVEN,
PAGE_SET_ODD
};
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::PageSet> : public Glib::Value_Enum<Gtk::PageSet>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
/**
* @var NumberUpLayout NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM
* <inlinegraphic valign="middle" fileref="layout-lrtb.png" format="PNG"></inlinegraphic>.
*
* @var NumberUpLayout NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP
* <inlinegraphic valign="middle" fileref="layout-lrbt.png" format="PNG"></inlinegraphic>.
*
* @var NumberUpLayout NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM
* <inlinegraphic valign="middle" fileref="layout-rltb.png" format="PNG"></inlinegraphic>.
*
* @var NumberUpLayout NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP
* <inlinegraphic valign="middle" fileref="layout-rlbt.png" format="PNG"></inlinegraphic>.
*
* @var NumberUpLayout NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT
* <inlinegraphic valign="middle" fileref="layout-tblr.png" format="PNG"></inlinegraphic>.
*
* @var NumberUpLayout NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT
* <inlinegraphic valign="middle" fileref="layout-tbrl.png" format="PNG"></inlinegraphic>.
*
* @var NumberUpLayout NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT
* <inlinegraphic valign="middle" fileref="layout-btlr.png" format="PNG"></inlinegraphic>.
*
* @var NumberUpLayout NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT
* <inlinegraphic valign="middle" fileref="layout-btrl.png" format="PNG"></inlinegraphic>.
*
* @enum NumberUpLayout
*
* Used to determine the layout of pages on a sheet when printing
* multiple pages per sheet.
* @ingroup gtkmmEnums
*/
enum NumberUpLayout
{
NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM,
NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP,
NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM,
NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP,
NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT,
NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT,
NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT,
NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT
};
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::NumberUpLayout> : public Glib::Value_Enum<Gtk::NumberUpLayout>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
/** A PrintSettings object represents the settings of a print dialog in a system-independent way.
* The main use for this object is that once you've printed you can get a settings object that
* represents the settings the user chose, and the next time you print you can pass that object
* in so that the user doesn't have to re-set all his settings.
*
* It's also possible to enumerate the settings so that you can easily save the settings for the
* next time your app runs, or even store them in a document. The predefined keys try to use shared
* values as much as possible so that moving such a document between systems still works.
*
* @newin{2,10}
*
* @ingroup Printing
*/
class PrintSettings : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef PrintSettings CppObjectType;
typedef PrintSettings_Class CppClassType;
typedef GtkPrintSettings BaseObjectType;
typedef GtkPrintSettingsClass BaseClassType;
private: friend class PrintSettings_Class;
static CppClassType printsettings_class_;
private:
// noncopyable
PrintSettings(const PrintSettings&);
PrintSettings& operator=(const PrintSettings&);
protected:
explicit PrintSettings(const Glib::ConstructParams& construct_params);
explicit PrintSettings(GtkPrintSettings* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~PrintSettings();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GtkPrintSettings* gobj() { return reinterpret_cast<GtkPrintSettings*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkPrintSettings* gobj() const { return reinterpret_cast<GtkPrintSettings*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GtkPrintSettings* gobj_copy();
private:
protected:
PrintSettings();
/** Reads the print settings from the @a key_file.
* Returns a new PrintSettings object with the restored settings,
* or an empty RefPtr if an error occurred.
* See save_to_key_file().
*
* @param key_file The KeyFile to retrieve the settings from.
* @result the restored PrintSettings
*
* @throws KeyFileError, FileError
*
* @newin{2,14}
*/
static Glib::RefPtr<PrintSettings> create_from_key_file(const Glib::KeyFile& key_file);
/** Reads the print settings from the group @a group_name in @a key_file.
* Returns a new PrintSettings object with the restored settings,
* or an empty RefPtr if an error occurred.
* See save_to_key_file().
*
* @param key_file The KeyFile to retrieve the settings from.
* @param group_name The name of the group to use.
* @result the restored PrintSettings
*
* @throws KeyFileError, FileError
*
* @newin{2,14}
*/
static Glib::RefPtr<PrintSettings> create_from_key_file(const Glib::KeyFile& key_file, const Glib::ustring& group_name);
/** Reads the print settings from @a file_name. Returns a new PrintSettings
* object with the restored settings, or an empty RefPtr if an error occurred.
* See save_to_file().
*
* @param file_name The filename to read the settings from.
* @result the restored PrintSettings
*
* @throws KeyFileError, FileError
*
* @newin{2,14}
*/
static Glib::RefPtr<PrintSettings> create_from_file(const std::string& file_name);
public:
static Glib::RefPtr<PrintSettings> create();
/** Print settings keys.
*/
class Keys
{
public:
static const Glib::ustring PRINTER;
static const Glib::ustring ORIENTATION;
static const Glib::ustring PAPER_FORMAT;
static const Glib::ustring PAPER_WIDTH;
static const Glib::ustring PAPER_HEIGHT;
static const Glib::ustring NUM_COPIES;
static const Glib::ustring DEFAULT_SOURCE;
static const Glib::ustring QUALITY;
static const Glib::ustring RESOLUTION;
static const Glib::ustring USE_COLOR;
static const Glib::ustring DUPLEX;
static const Glib::ustring COLLATE;
static const Glib::ustring REVERSE;
static const Glib::ustring MEDIA_TYPE;
static const Glib::ustring DITHER;
static const Glib::ustring SCALE;
static const Glib::ustring PRINT_PAGES;
static const Glib::ustring PAGE_RANGES;
static const Glib::ustring PAGE_SET;
static const Glib::ustring FINISHINGS;
static const Glib::ustring NUMBER_UP;
static const Glib::ustring NUMBER_UP_LAYOUT;
static const Glib::ustring OUTPUT_BIN;
static const Glib::ustring OUTPUT_FILE_FORMAT;
static const Glib::ustring OUTPUT_URI;
static const Glib::ustring WIN32_DRIVER_VERSION;
static const Glib::ustring WIN32_DRIVER_EXTRA;
};
/** Copies a Gtk::PrintSettings object.
*
* @newin{2,10}
* @return A newly allocated copy of @a other.
*/
Glib::RefPtr<PrintSettings> copy() const;
//The from_ infix was added to these functions to make them clearer. GTK+ didn't want to change them.
/** Reads the print settings from @a file_name. If the file could not be loaded
* then error is set to either a FileError or KeyFileError.
* See to_file().
*
* @newin{2,14}
* @param file_name The filename to read the settings from.
* @return <tt>true</tt> on success.
*/
bool load_from_file(const std::string& file_name);
/** Reads the print settings from the group @a group_name in @a key_file. If the
* file could not be loaded then error is set to either a FileError or
* KeyFileError.
*
* @newin{2,14}
* @param key_file The KeyFile to retrieve the settings from.
* @param group_name The name of the group to use, or <tt>0</tt> to use the default
* "Print Settings".
* @return <tt>true</tt> on success.
*/
bool load_from_key_file(const Glib::KeyFile& key_file, const Glib::ustring& group_name);
/** Reads the print settings from the @a key_file.
* See save_to_key_file().
*
* @param key_file The KeyFile to retrieve the settings from.
* @result true on success.
*
* @throws KeyFileError, FileError
*
* @newin{2,14}
*/
bool load_from_key_file(const Glib::KeyFile& key_file);
//The save_ prefix was added to these functions to make them clearer. GTK+ didn't want to change them.
/** This function saves the print settings from @a settings to @a file_name.
* @throws FileError
*
* @newin{2,12}
* @param file_name The file to save to.
* @return <tt>true</tt> on success.
*/
bool save_to_file(const std::string& file_name) const;
/** This function adds the print settings from @a settings to @a key_file.
*
* @newin{2,12}
* @param key_file The Glib::KeyFile to save the print settings to.
* @param group_name The group to add the settings to in @a key_file.
*/
void save_to_key_file(Glib::KeyFile& key_file, const Glib::ustring& group_name) const;
/** This function adds the print settings from @a settings to @a key_file,
* in the "Print Settings" group.
*
* @newin{2,12}
* @param key_file The Glib::KeyFile to save the print settings to.
*/
void save_to_key_file(Glib::KeyFile& key_file) const;
//TODO: add a @see link?
/** Returns <tt>true</tt>, if a value is associated with @a key.
*
* @newin{2,10}
* @param key A key.
* @return <tt>true</tt>, if @a key has a value.
*/
bool has_key(const Glib::ustring& key) const;
/** Looks up the string value associated with @a key.
*
* @newin{2,10}
* @param key A key.
* @return The string value for @a key.
*/
Glib::ustring get(const Glib::ustring& key) const;
/** Associates @a value with @a key.
*
* @newin{2,10}
* @param key A key.
* @param value A string value, or <tt>0</tt>.
*/
void set(const Glib::ustring& key, const Glib::ustring& value);
/** Removes any value associated with @a key.
* This has the same effect as setting the value to <tt>0</tt>.
*
* @newin{2,10}
* @param key A key.
*/
void unset(const Glib::ustring& key);
/** For example,
* void on_foreach_setting(const Glib::ustring& key, const Glib::ustring& value);
*/
typedef sigc::slot<void, const Glib::ustring&, const Glib::ustring&> SlotForeach;
/** Calls a function for each print setting.
* @param slot The callback to call for each print setting.
*/
void setting_foreach(const SlotForeach& slot);
/** Returns the boolean represented by the value
* that is associated with @a key.
*
* The string "true" represents <tt>true</tt>, any other
* string <tt>false</tt>.
*
* @newin{2,10}
* @param key A key.
* @return <tt>true</tt>, if @a key maps to a true value.
*/
bool get_bool(const Glib::ustring& key) const;
/** Sets @a key to a boolean value.
*
* @newin{2,10}
* @param key A key.
* @param value A boolean.
*/
void set_bool(const Glib::ustring& key, bool value = true);
/** Returns the double value associated with @a key, or 0.
*
* @newin{2,10}
* @param key A key.
* @return The double value of @a key.
*/
double get_double(const Glib::ustring& key) const;
/** Returns the floating point number represented by
* the value that is associated with @a key, or @a default_val
* if the value does not represent a floating point number.
*
* Floating point numbers are parsed with Glib::ascii_strtod().
*
* @newin{2,10}
* @param key A key.
* @param def The default value.
* @return The floating point number associated with @a key.
*/
double get_double_with_default(const Glib::ustring& key, double def) const;
/** Sets @a key to a double value.
*
* @newin{2,10}
* @param key A key.
* @param value A double value.
*/
void set_double(const Glib::ustring& key, double value);
/** Returns the value associated with @a key, interpreted
* as a length. The returned value is converted to @a units.
*
* @newin{2,10}
* @param key A key.
* @param unit The unit of the return value.
* @return The length value of @a key, converted to @a unit.
*/
double get_length(const Glib::ustring& key, Unit unit) const;
/** Associates a length in units of @a unit with @a key.
*
* @newin{2,10}
* @param key A key.
* @param value A length.
* @param unit The unit of @a length.
*/
void set_length(const Glib::ustring& key, double value, Unit unit);
/** Returns the integer value of @a key, or 0.
*
* @newin{2,10}
* @param key A key.
* @return The integer value of @a key.
*/
int get_int(const Glib::ustring& key) const;
/** Returns the value of @a key, interpreted as
* an integer, or the default value.
*
* @newin{2,10}
* @param key A key.
* @param def The default value.
* @return The integer value of @a key.
*/
int get_int_with_default(const Glib::ustring& key, int def) const;
/** Sets @a key to an integer value.
*
* @newin{2,10}
* @param key A key.
* @param value An integer.
*/
void set_int(const Glib::ustring& key, int value);
// helpers:
/** Convenience function to obtain the value of
* Gtk::PRINT_SETTINGS_PRINTER.
*
* @newin{2,10}
* @return The printer name.
*/
Glib::ustring get_printer() const;
/** Convenience function to set Gtk::PRINT_SETTINGS_PRINTER
* to @a printer.
*
* @newin{2,10}
* @param printer The printer name.
*/
void set_printer(const Glib::ustring& printer);
/** Get the value of Gtk::PRINT_SETTINGS_ORIENTATION,
* converted to a Gtk::PageOrientation.
*
* @newin{2,10}
* @return The orientation.
*/
PageOrientation get_orientation() const;
/** Sets the value of Gtk::PRINT_SETTINGS_ORIENTATION.
*
* @newin{2,10}
* @param orientation A page orientation.
*/
void set_orientation(PageOrientation orientation);
/** Gets the value of Gtk::PRINT_SETTINGS_PAPER_FORMAT,
* converted to a Gtk::PaperSize.
*
* @newin{2,10}
* @return The paper size.
*/
PaperSize get_paper_size();
/** Gets the value of Gtk::PRINT_SETTINGS_PAPER_FORMAT,
* converted to a Gtk::PaperSize.
*
* @newin{2,10}
* @return The paper size.
*/
const PaperSize get_paper_size() const;
/** Sets the value of Gtk::PRINT_SETTINGS_PAPER_FORMAT,
* Gtk::PRINT_SETTINGS_PAPER_WIDTH and
* Gtk::PRINT_SETTINGS_PAPER_HEIGHT.
*
* @newin{2,10}
* @param paper_size A paper size.
*/
void set_paper_size(const PaperSize& paper_size);
/** Gets the value of Gtk::PRINT_SETTINGS_PAPER_WIDTH,
* converted to @a unit.
*
* @newin{2,10}
* @param unit The unit for the return value.
* @return The paper width, in units of @a unit.
*/
double get_paper_width(Unit unit) const;
/** Sets the value of Gtk::PRINT_SETTINGS_PAPER_WIDTH.
*
* @newin{2,10}
* @param width The paper width.
* @param unit The units of @a width.
*/
void set_paper_width(double width, Unit unit);
/** Gets the value of Gtk::PRINT_SETTINGS_PAPER_HEIGHT,
* converted to @a unit.
*
* @newin{2,10}
* @param unit The unit for the return value.
* @return The paper height, in units of @a unit.
*/
double get_paper_height(Unit unit) const;
/** Sets the value of Gtk::PRINT_SETTINGS_PAPER_HEIGHT.
*
* @newin{2,10}
* @param height The paper height.
* @param unit The units of @a height.
*/
void set_paper_height(double height, Unit unit);
/** Gets the value of Gtk::PRINT_SETTINGS_USE_COLOR.
*
* @newin{2,10}
* @return Whether to use color.
*/
bool get_use_color() const;
/** Sets the value of Gtk::PRINT_SETTINGS_USE_COLOR.
*
* @newin{2,10}
* @param use_color Whether to use color.
*/
void set_use_color(bool use_color = true);
/** Gets the value of Gtk::PRINT_SETTINGS_COLLATE.
*
* @newin{2,10}
* @return Whether to collate the printed pages.
*/
bool get_collate() const;
/** Sets the value of Gtk::PRINT_SETTINGS_COLLATE.
*
* @newin{2,10}
* @param collate Whether to collate the output.
*/
void set_collate(bool collate = true);
/** Gets the value of Gtk::PRINT_SETTINGS_REVERSE.
*
* @newin{2,10}
* @return Whether to reverse the order of the printed pages.
*/
bool get_reverse() const;
/** Sets the value of Gtk::PRINT_SETTINGS_REVERSE.
*
* @newin{2,10}
* @param reverse Whether to reverse the output.
*/
void set_reverse(bool reverse = true);
/** Gets the value of Gtk::PRINT_SETTINGS_DUPLEX.
*
* @newin{2,10}
* @return Whether to print the output in duplex.
*/
PrintDuplex get_duplex() const;
/** Sets the value of Gtk::PRINT_SETTINGS_DUPLEX.
*
* @newin{2,10}
* @param duplex A Gtk::PrintDuplex value.
*/
void set_duplex(PrintDuplex duplex);
/** Gets the value of Gtk::PRINT_SETTINGS_QUALITY.
*
* @newin{2,10}
* @return The print quality.
*/
PrintQuality get_quality() const;
/** Sets the value of Gtk::PRINT_SETTINGS_QUALITY.
*
* @newin{2,10}
* @param quality A Gtk::PrintQuality value.
*/
void set_quality(PrintQuality quality);
/** Gets the value of Gtk::PRINT_SETTINGS_N_COPIES.
*
* @newin{2,10}
* @return The number of copies to print.
*/
int get_n_copies() const;
/** Sets the value of Gtk::PRINT_SETTINGS_N_COPIES.
*
* @newin{2,10}
* @param num_copies The number of copies.
*/
void set_n_copies(int num_copies);
/** Gets the value of Gtk::PRINT_SETTINGS_NUMBER_UP.
*
* @newin{2,10}
* @return The number of pages per sheet.
*/
int get_number_up() const;
/** Sets the value of Gtk::PRINT_SETTINGS_NUMBER_UP.
*
* @newin{2,10}
* @param number_up The number of pages per sheet.
*/
void set_number_up(int number_up);
/** Gets the value of Gtk::PRINT_SETTINGS_NUMBER_UP_LAYOUT.
*
* @newin{2,14}
* @return Layout of page in number-up mode.
*/
NumberUpLayout get_number_up_layout() const;
/** Sets the value of Gtk::PRINT_SETTINGS_NUMBER_UP_LAYOUT.
*
* @newin{2,14}
* @param number_up_layout A Gtk::NumberUpLayout value.
*/
void set_number_up(NumberUpLayout number_up_layout);
/** Gets the value of Gtk::PRINT_SETTINGS_RESOLUTION.
*
* @newin{2,10}
* @return The resolution in dpi.
*/
int get_resolution() const;
/** Sets the values of Gtk::PRINT_SETTINGS_RESOLUTION,
* Gtk::PRINT_SETTINGS_RESOLUTION_X and
* Gtk::PRINT_SETTINGS_RESOLUTION_Y.
*
* @newin{2,10}
* @param resolution The resolution in dpi.
*/
void set_resolution(int resolution);
/** Gets the value of Gtk::PRINT_SETTINGS_RESOLUTION_X.
*
* @newin{2,16}
* @return The horizontal resolution in dpi.
*/
int get_resolution_x() const;
/** Gets the value of Gtk::PRINT_SETTINGS_RESOLUTION_Y.
*
* @newin{2,16}
* @return The vertical resolution in dpi.
*/
int get_resolution_y() const;
/** Sets the values of Gtk::PRINT_SETTINGS_RESOLUTION,
* Gtk::PRINT_SETTINGS_RESOLUTION_X and
* Gtk::PRINT_SETTINGS_RESOLUTION_Y.
*
* @newin{2,16}
* @param resolution_x The horizontal resolution in dpi.
* @param resolution_y The vertical resolution in dpi.
*/
void set_resolution_xy(int resolution_x, int resolution_y);
/** Gets the value of Gtk::PRINT_SETTINGS_PRINTER_LPI.
*
* @newin{2,16}
* @return The resolution in lpi (lines per inch).
*/
double get_printer_lpi() const;
/** Sets the value of Gtk::PRINT_SETTINGS_PRINTER_LPI.
*
* @newin{2,16}
* @param lpi The resolution in lpi (lines per inch).
*/
void set_printer_lpi(double lpi);
/** Gets the value of Gtk::PRINT_SETTINGS_SCALE.
*
* @newin{2,10}
* @return The scale in percent.
*/
double get_scale() const;
/** Sets the value of Gtk::PRINT_SETTINGS_SCALE.
*
* @newin{2,10}
* @param scale The scale in percent.
*/
void set_scale(double scale);
/** Gets the value of Gtk::PRINT_SETTINGS_PRINT_PAGES.
*
* @newin{2,10}
* @return Which pages to print.
*/
PrintPages get_print_pages() const;
/** Sets the value of Gtk::PRINT_SETTINGS_PRINT_PAGES.
*
* @newin{2,10}
* @param pages A Gtk::PrintPages value.
*/
void set_print_pages(PrintPages pages);
//TODO: Move this out of the class when we can break ABI,
//because this is also used in PringJob.
//This corresponds to GtkPageRange.
class PageRange
{
public:
PageRange();
PageRange(int start, int end);
int start;
int end;
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS
struct PageRangeTraits
{
typedef PageRange CppType;
typedef GtkPageRange CType;
typedef GtkPageRange CTypeNonConst;
static CType to_c_type (CType c_obj) { return c_obj; }
static void release_c_type (CType) {}
static CType to_c_type (const CppType& cpp_obj) { CTypeNonConst c_obj = {cpp_obj.start, cpp_obj.end}; return c_obj; }
static CppType to_cpp_type (CType c_obj) { return CppType (c_obj.start, c_obj.end); }
};
#endif // DOXYGEN_SHOULD_SKIP_THIS
std::vector<PageRange> get_page_ranges() const;
void set_page_ranges(const std::vector<PageRange>& page_ranges);
/** Gets the value of Gtk::PRINT_SETTINGS_PAGE_SET.
*
* @newin{2,10}
* @return The set of pages to print.
*/
PageSet get_page_set() const;
/** Sets the value of Gtk::PRINT_SETTINGS_PAGE_SET.
*
* @newin{2,10}
* @param page_set A Gtk::PageSet value.
*/
void set_page_set(PageSet page_set);
/** Gets the value of Gtk::PRINT_SETTINGS_DEFAULT_SOURCE.
*
* @newin{2,10}
* @return The default source.
*/
Glib::ustring get_default_source() const;
/** Sets the value of Gtk::PRINT_SETTINGS_DEFAULT_SOURCE.
*
* @newin{2,10}
* @param default_source The default source.
*/
void set_default_source(const Glib::ustring& default_source);
/** Gets the value of Gtk::PRINT_SETTINGS_MEDIA_TYPE.
*
* The set of media types is defined in PWG 5101.1-2002 PWG.
* <!-- FIXME link here -->
*
* @newin{2,10}
* @return The media type.
*/
Glib::ustring get_media_type() const;
/** Sets the value of Gtk::PRINT_SETTINGS_MEDIA_TYPE.
*
* The set of media types is defined in PWG 5101.1-2002 PWG.
* <!-- FIXME link here -->
*
* @newin{2,10}
* @param media_type The media type.
*/
void set_media_type(const Glib::ustring& media_type);
/** Gets the value of Gtk::PRINT_SETTINGS_DITHER.
*
* @newin{2,10}
* @return The dithering that is used.
*/
Glib::ustring get_dither() const;
/** Sets the value of Gtk::PRINT_SETTINGS_DITHER.
*
* @newin{2,10}
* @param dither The dithering that is used.
*/
void set_dither(const Glib::ustring& dither);
/** Gets the value of Gtk::PRINT_SETTINGS_FINISHINGS.
*
* @newin{2,10}
* @return The finishings.
*/
Glib::ustring get_finishings() const;
/** Sets the value of Gtk::PRINT_SETTINGS_FINISHINGS.
*
* @newin{2,10}
* @param finishings The finishings.
*/
void set_finishings(const Glib::ustring& finishings);
/** Gets the value of Gtk::PRINT_SETTINGS_OUTPUT_BIN.
*
* @newin{2,10}
* @return The output bin.
*/
Glib::ustring get_output_bin() const;
/** Sets the value of Gtk::PRINT_SETTINGS_OUTPUT_BIN.
*
* @newin{2,10}
* @param output_bin The output bin.
*/
void set_output_bin(const Glib::ustring& output_bin);
//There are no properties.
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // 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::PrintSettings
*/
Glib::RefPtr<Gtk::PrintSettings> wrap(GtkPrintSettings* object, bool take_copy = false);
}
#endif /* _GTKMM_PRINTSETTINGS_H */
|