15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef PRINTING_PAGE_SETUP_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PRINTING_PAGE_SETUP_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "printing/printing_export.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/rect.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace printing { 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Margins for a page setup. 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PRINTING_EXPORT PageMargins { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PageMargins(); 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Clear(); 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Equality operator. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Equals(const PageMargins& rhs) const; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Vertical space for the overlay from the top of the sheet. 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int header; 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Vertical space for the overlay from the bottom of the sheet. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int footer; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Margin on each side of the sheet. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int left; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int right; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int top; 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int bottom; 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Settings that define the size and printable areas of a page. Unit is 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// unspecified. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PRINTING_EXPORT PageSetup { 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PageSetup(); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~PageSetup(); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Clear(); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Equality operator. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Equals(const PageSetup& rhs) const; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Init(const gfx::Size& physical_size, const gfx::Rect& printable_area, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int text_height); 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Use |requested_margins| as long as they fall inside the printable area. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetRequestedMargins(const PageMargins& requested_margins); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Ignore the printable area, and set the margins to |requested_margins|. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ForceRequestedMargins(const PageMargins& requested_margins); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Flips the orientation of the page and recalculates all page areas. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void FlipOrientation(); 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Size& physical_size() const { return physical_size_; } 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Rect& overlay_area() const { return overlay_area_; } 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Rect& content_area() const { return content_area_; } 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Rect& printable_area() const { return printable_area_; } 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const PageMargins& effective_margins() const { 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return effective_margins_; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Store |requested_margins_| and update page setup values. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetRequestedMarginsAndCalculateSizes( 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const PageMargins& requested_margins); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Calculate overlay_area_, effective_margins_, and content_area_, based on 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a constraint of |bounds| and |text_height|. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CalculateSizesWithinRect(const gfx::Rect& bounds, int text_height); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Physical size of the page, including non-printable margins. 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Size physical_size_; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The printable area as specified by the printer driver. We can't get 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // larger than this. 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Rect printable_area_; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The printable area for headers and footers. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Rect overlay_area_; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The printable area as selected by the user's margins. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Rect content_area_; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Effective margins. 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PageMargins effective_margins_; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Requested margins. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PageMargins requested_margins_; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True when |effective_margins_| respects |printable_area_| else false. 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool forced_margins_; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Space that must be kept free for the overlays. 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int text_height_; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace printing 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // PRINTING_PAGE_SETUP_H_ 104