Print Preview: Go from event driven print preview back to print preview with sync messages. The s...

chrome/renderer/print_web_view_helper.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_
 #define CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_
 #pragma once
 
 #include <utility>
 #include <vector>
@@ skipping 123 matching lines @@
   void OnPrintForSystemDialog();
 
   // Initiate print preview.
   void OnInitiatePrintPreview();
 
   // Start the process of generating a print preview using |settings|.
   void OnPrintPreview(const base::DictionaryValue& settings);
   // Initialize the print preview document.
   bool CreatePreviewDocument();
 
-  // Continue generating the print preview. |requested_preview_page_index|
-  // specifies the browser requested preview page index. It is 1-based or
-  // |printing::INVALID_PAGE_INDEX| to continue with next page.
-  void OnContinuePreview(int requested_preview_page_index);
   // Renders a print preview page. |page_number| is 0-based.
-  void RenderPreviewPage(int page_number);
+  // Returns true if print preview should continue, false on

[kmadhusu, 2011/08/20 00:07:11]

Fix the comment.

[Lei Zhang, 2011/08/20 03:25:52]

Done.

+  // cancellation / failure.
+  bool RenderPreviewPage(int page_number);

[kmadhusu, 2011/08/20 00:07:11]

This function can now return void.

[Lei Zhang, 2011/08/20 03:25:52]

No, it still need to handle the possible failures in the mac implementation.

+
   // Finalize the print preview document.
   bool FinalizePreviewDocument();
 
-  // Abort the preview to put |print_preview_context_| into the 'UNINITIALIZED'
-  // state.
-  void OnAbortPreview();
-
   // Print / preview the node under the context menu.
   void OnPrintNodeUnderContextMenu();
 
   // Print the pages for print preview. Do not display the native print dialog
   // for user settings. |job_settings| has new print job settings values.
   void OnPrintForPrintPreview(const base::DictionaryValue& job_settings);
 
   void OnPrintingDone(bool success);
 
   // Main printing code -------------------------------------------------------
 
   void Print(WebKit::WebFrame* frame, WebKit::WebNode* node);
 
   enum PrintingResult {
     OK,
     FAIL_PRINT,
     FAIL_PREVIEW,
-    ABORT_PREVIEW,
   };
 
   // Notification when printing is done - signal tear-down/free resources.
   void DidFinishPrinting(PrintingResult result);
 
   // Print Settings -----------------------------------------------------------
 
   // Initialize print page settings with default settings.
   bool InitPrintSettings(WebKit::WebFrame* frame, WebKit::WebNode* node);
 
   // Initialize print page settings with default settings and prepare the frame
   // for print. A new PrepareFrameAndViewForPrint is created to fulfill the
   // request and is filled into the |prepare| argument.
   bool InitPrintSettingsAndPrepareFrame(
       WebKit::WebFrame* frame,
       WebKit::WebNode* node,
       scoped_ptr<PrepareFrameAndViewForPrint>* prepare);
 
-  // Parse the request id out of |job_settings| and store it in |params|.
-  // Returns false on failure.
-  bool UpdatePrintSettingsRequestId(const base::DictionaryValue& job_settings,
-                                    PrintMsg_Print_Params* params);
-
   // Update the current print settings with new |job_settings|. |job_settings|
   // dictionary contains print job details such as printer name, number of
   // copies, page range, etc.
   bool UpdatePrintSettings(const base::DictionaryValue& job_settings);
 
   // Get final print settings from the user.
   // Return false if the user cancels or on error.
   bool GetPrintSettingsFromUser(WebKit::WebFrame* frame,
                                 int expected_pages_count,
                                 bool use_browser_overlays);
@@ skipping 92 matching lines @@
 
   // Increment the counter for script initiated printing.
   // Scripted printing will be blocked for a limited amount of time.
   void IncrementScriptedPrintCount();
 
   // Displays the print job error message to the user.
   void DisplayPrintJobError();
 
   void RequestPrintPreview();
 
-  // Notify the browser a print preview page has been rendered.
-  // |page_number| is 0-based or |printing::INVALID_PAGE_INDEX| to check
-  // for pending preview requests.
-  void PreviewPageRendered(int page_number, printing::Metafile* metafile);
+  // Checks whether print preview should continue or not.
+  // Returns true if continuing, false if cancelling.

[kmadhusu, 2011/08/20 00:07:11]

nit: This function should return true if cancelling and false to continue. 

[Lei Zhang, 2011/08/20 03:25:52]

Done.

+  bool CheckForCancel();
+
+  // Notifies the browser a print preview page has been rendered.
+  // |page_number| is 0-based.
+  // For a valid |page_number| with modifiable content,
+  // |metafile| is the rendered page. Otherwise |metafile| is NULL.
+  // Returns true if print preview should continue, false on failure.
+  bool PreviewPageRendered(int page_number, printing::Metafile* metafile);

[kmadhusu, 2011/08/20 00:07:11]

This function can return void. 

[Lei Zhang, 2011/08/20 03:25:52]

No, if we encounter a failure, we have to let our caller know.

 
   WebKit::WebView* print_web_view_;
 
   scoped_ptr<PrintMsg_PrintPages_Params> print_pages_params_;
   bool is_preview_;
 
   // Used for scripted initiated printing blocking.
   base::Time last_cancelled_script_print_;
   int user_cancelled_scripted_print_count_;
 
@@ skipping 31 matching lines @@
 
     // Finalizes the print preview document.
     void FinalizePreviewDocument();
 
     // Cleanup after print preview finishes.
     void Finished();
 
     // Cleanup after print preview fails.
     void Failed();
 
-    // Abort the print preview.
-    void Abort();
-
     // Helper functions
     int GetNextPageNumber();
     bool IsReadyToRender() const;
-    bool IsBusy() const;
     bool IsModifiable() const;
 
     // Getters
     WebKit::WebFrame* frame() const;
     WebKit::WebNode* node() const;
     int total_page_count() const;
     printing::PreviewMetafile* metafile() const;
     const PrintMsg_Print_Params& print_params() const;
     const gfx::Size& GetPrintCanvasSize() const;
 
@@ skipping 16 matching lines @@
     scoped_ptr<printing::PreviewMetafile> metafile_;
     scoped_ptr<PrintMsg_Print_Params> print_params_;
 
     // Total page count in the renderer.
     int total_page_count_;
 
     // Number of pages to render.
     int actual_page_count_;
 
     // The current page to render.
-    int current_page_number_;
+    int current_page_index_;
 
-    // |rendered_pages_| tracks which pages need to be printed as well as
-    // the page slot it should be printed in. See GetPageSlotForPage.
-    typedef std::pair<bool, int> PreviewPageInfo;
-    std::vector<PreviewPageInfo> rendered_pages_;
+    std::vector<int> pages_to_render_;
 
     base::TimeDelta document_render_time_;
     base::TimeTicks begin_time_;
 
     State state_;
   };
 
   PrintPreviewContext print_preview_context_;
 
   DISALLOW_COPY_AND_ASSIGN(PrintWebViewHelper);
 };
 
 #endif  // CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_