gtkmm: Gtk::PaperSize Class Reference
PaperSize handles paper sizes. More...
#include <gtkmm/papersize.h>
Public Member Functions | |
PaperSize () | |
PaperSize (GtkPaperSize* gobject, bool make_a_copy=true) | |
PaperSize (const PaperSize& other) | |
PaperSize& | operator= (const PaperSize& other) |
PaperSize (PaperSize&& other) noexcept | |
PaperSize& | operator= (PaperSize&& other) noexcept |
~PaperSize () noexcept | |
void | swap (PaperSize& other) noexcept |
GtkPaperSize* | gobj () |
Provides access to the underlying C instance. More... | |
const GtkPaperSize* | gobj () const |
Provides access to the underlying C instance. More... | |
GtkPaperSize* | gobj_copy () const |
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. More... | |
PaperSize (const Glib::ustring& name) | |
PaperSize (const Glib::ustring& ppd_name, const Glib::ustring& ppd_display_name, double width, double height) | |
PaperSize (const Glib::ustring& name, const Glib::ustring& display_name, double width, double height, Unit unit) | |
PaperSize (const Glib::RefPtr< const Glib::KeyFile >& key_file, const Glib::ustring& group_name={}) | |
Reads a paper size from the group group_name in the key file key_file. More... | |
bool | equal (const PaperSize& other) const |
operator bool () const | |
Returns true if the PaperSize is a valid object. More... | |
Glib::ustring | get_name () const |
Gets the name of the Gtk::PaperSize. More... | |
Glib::ustring | get_display_name () const |
Gets the human-readable name of the Gtk::PaperSize. More... | |
Glib::ustring | get_ppd_name () const |
Gets the PPD name of the Gtk::PaperSize, which may be nullptr . More... | |
double | get_width (Unit unit) const |
Gets the paper width of the Gtk::PaperSize, in units of unit. More... | |
double | get_height (Unit unit) const |
Gets the paper height of the Gtk::PaperSize, in units of unit. More... | |
bool | is_custom () const |
Returns true if size is not a standard paper size. More... | |
bool | is_ipp () const |
Returns true if size is an IPP standard paper size. More... | |
void | set_size (double width, double height, Unit unit) |
Changes the dimensions of a size to width x height. More... | |
double | get_default_top_margin (Unit unit) const |
Gets the default top margin for the Gtk::PaperSize. More... | |
double | get_default_bottom_margin (Unit unit) const |
Gets the default bottom margin for the Gtk::PaperSize. More... | |
double | get_default_left_margin (Unit unit) const |
Gets the default left margin for the Gtk::PaperSize. More... | |
double | get_default_right_margin (Unit unit) const |
Gets the default right margin for the Gtk::PaperSize. More... | |
void | save_to_key_file (const Glib::RefPtr< Glib::KeyFile >& key_file, const Glib::ustring& group_name) |
This function adds the paper size from size to key_file. More... | |
void | save_to_key_file (const Glib::RefPtr< Glib::KeyFile >& key_file) |
This function adds the paper size to key_file in the first group. More... | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static std::vector< PaperSize > | get_paper_sizes (bool include_custom=true) |
Creates a list of known paper sizes. More... | |
static Glib::ustring | get_default () |
Returns the name of the default paper size, which depends on the current locale. More... | |
Protected Attributes | |
GtkPaperSize* | gobject_ |
Related Functions | |
(Note that these are not member functions.) | |
bool | operator== (const PaperSize& lhs, const PaperSize& rhs) |
bool | operator!= (const PaperSize& lhs, const PaperSize& rhs) |
void | swap (PaperSize& lhs, PaperSize& rhs) noexcept |
Gtk::PaperSize | wrap (GtkPaperSize* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Detailed Description
PaperSize handles paper sizes.
It uses the standard called "PWG 5101.1-2002 PWG: Standard for Media Standardized Names" to name the paper sizes (and to get the data for the page sizes). In addition to standard paper sizes, PaperSize allows to construct custom paper sizes with arbitrary dimensions.
The PaperSize object stores not only the dimensions (width and height) of a paper size and its name, it also provides default print margins.
Constructor & Destructor Documentation
Gtk::PaperSize::PaperSize | ( | ) |
|
explicit |
Gtk::PaperSize::PaperSize | ( | const PaperSize& | other | ) |
|
noexcept |
|
noexcept |
|
explicit |
|
explicit |
|
explicit |
|
explicit |
Reads a paper size from the group group_name in the key file key_file.
- Parameters
-
key_file The Glib::KeyFile to retrieve the paper size from. group_name The name of the group in the key file to read, or an empty string to read the first group.
- Exceptions
-
Gtk::PrintError,Glib::KeyFileError
Member Function Documentation
bool Gtk::PaperSize::equal | ( | const PaperSize& | other | ) | const |
|
static |
Returns the name of the default paper size, which depends on the current locale.
- Returns
- The name of the default paper size. The string is owned by GTK and should not be modified.
double Gtk::PaperSize::get_default_bottom_margin | ( | Unit | unit | ) | const |
Gets the default bottom margin for the Gtk::PaperSize.
- Parameters
-
unit The unit for the return value, not Gtk::Unit::NONE.
- Returns
- The default bottom margin.
double Gtk::PaperSize::get_default_left_margin | ( | Unit | unit | ) | const |
Gets the default left margin for the Gtk::PaperSize.
- Parameters
-
unit The unit for the return value, not Gtk::Unit::NONE.
- Returns
- The default left margin.
double Gtk::PaperSize::get_default_right_margin | ( | Unit | unit | ) | const |
Gets the default right margin for the Gtk::PaperSize.
- Parameters
-
unit The unit for the return value, not Gtk::Unit::NONE.
- Returns
- The default right margin.
double Gtk::PaperSize::get_default_top_margin | ( | Unit | unit | ) | const |
Gets the default top margin for the Gtk::PaperSize.
- Parameters
-
unit The unit for the return value, not Gtk::Unit::NONE.
- Returns
- The default top margin.
Glib::ustring Gtk::PaperSize::get_display_name | ( | ) | const |
Gets the human-readable name of the Gtk::PaperSize.
- Returns
- The human-readable name of size.
double Gtk::PaperSize::get_height | ( | Unit | unit | ) | const |
Gets the paper height of the Gtk::PaperSize, in units of unit.
- Parameters
-
unit The unit for the return value, not Gtk::Unit::NONE.
- Returns
- The paper height.
Glib::ustring Gtk::PaperSize::get_name | ( | ) | const |
Gets the name of the Gtk::PaperSize.
- Returns
- The name of size.
|
static |
Creates a list of known paper sizes.
- Parameters
-
include_custom Whether to include custom paper sizes as defined in the page setup dialog.
- Returns
- A newly allocated list of newly allocated Gtk::PaperSize objects.
Glib::ustring Gtk::PaperSize::get_ppd_name | ( | ) | const |
Gets the PPD name of the Gtk::PaperSize, which may be nullptr
.
- Returns
- The PPD name of size.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
double Gtk::PaperSize::get_width | ( | Unit | unit | ) | const |
Gets the paper width of the Gtk::PaperSize, in units of unit.
- Parameters
-
unit The unit for the return value, not Gtk::Unit::NONE.
- Returns
- The paper width.
|
inline |
Provides access to the underlying C instance.
|
inline |
Provides access to the underlying C instance.
GtkPaperSize* Gtk::PaperSize::gobj_copy | ( | ) | const |
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
bool Gtk::PaperSize::is_custom | ( | ) | const |
Returns true
if size is not a standard paper size.
- Returns
- Whether size is a custom paper size.
bool Gtk::PaperSize::is_ipp | ( | ) | const |
Returns true
if size is an IPP standard paper size.
- Returns
- Whether size is not an IPP custom paper size.
|
explicit |
void Gtk::PaperSize::save_to_key_file | ( | const Glib::RefPtr< Glib::KeyFile > & | key_file, |
const Glib::ustring & | group_name | ||
) |
This function adds the paper size from size to key_file.
- Parameters
-
key_file The Glib::KeyFile to save the paper size to. group_name The group to add the settings to in key_file.
void Gtk::PaperSize::save_to_key_file | ( | const Glib::RefPtr< Glib::KeyFile > & | key_file | ) |
This function adds the paper size to key_file in the first group.
- Parameters
-
key_file The Glib::KeyFile to save the paper size to.
void Gtk::PaperSize::set_size | ( | double | width, |
double | height, | ||
Unit | unit | ||
) |
Changes the dimensions of a size to width x height.
- Parameters
-
width The new width in units of unit. height The new height in units of unit. unit The unit for width and height.
|
noexcept |
Friends And Related Function Documentation
- Parameters
-
lhs The left-hand side rhs The right-hand side
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns
- A C++ instance that wraps this C instance.
Member Data Documentation
|
protected |