Bug 1432124 - Clean up and document nsPrintingProxy.h. r=bobowen draft
authorJonathan Watt <jwatt@jwatt.org>
Mon, 22 Jan 2018 11:18:41 +0000
changeset 723044 a1b7577030c6103c253e7de62b44aade5cfcb105
parent 723043 28a267774e17dec9606813cac2610d5e52d0fb69
child 746751 d914774334575c689997d6fe256d9d5f7ab46a51
push id96306
push userjwatt@jwatt.org
push dateMon, 22 Jan 2018 11:19:12 +0000
reviewersbobowen
bugs1432124
milestone59.0a1
Bug 1432124 - Clean up and document nsPrintingProxy.h. r=bobowen MozReview-Commit-ID: 1WZ5i1AvzGE
toolkit/components/printingui/ipc/nsPrintingProxy.h
--- a/toolkit/components/printingui/ipc/nsPrintingProxy.h
+++ b/toolkit/components/printingui/ipc/nsPrintingProxy.h
@@ -10,35 +10,35 @@
 #include "mozilla/embedding/PPrintingChild.h"
 
 namespace mozilla {
 namespace layout {
 class PRemotePrintJobChild;
 }
 }
 
-class nsPrintingProxy: public nsIPrintingPromptService,
-                       public mozilla::embedding::PPrintingChild
+class nsPrintingProxy final: public nsIPrintingPromptService,
+                             public mozilla::embedding::PPrintingChild
 {
-    virtual ~nsPrintingProxy();
-
 public:
-    nsPrintingProxy();
-
     static already_AddRefed<nsPrintingProxy> GetInstance();
 
-    nsresult Init();
-
     NS_DECL_ISUPPORTS
     NS_DECL_NSIPRINTINGPROMPTSERVICE
 
+    /**
+     * Used to proxy nsIPrintSettings.savePrintSettingsToPrefs calls to the
+     * parent process.  aFlags are nsIPrintSettings's kInitSave* flags
+     * specifying which settings to save.
+     */
     nsresult SavePrintSettings(nsIPrintSettings* aPS,
                                bool aUsePrinterNamePrefix,
                                uint32_t aFlags);
 
+protected:
     virtual PPrintProgressDialogChild*
     AllocPPrintProgressDialogChild() override;
 
     virtual bool
     DeallocPPrintProgressDialogChild(PPrintProgressDialogChild* aActor) override;
 
     virtual PPrintSettingsDialogChild*
     AllocPPrintSettingsDialogChild() override;
@@ -46,12 +46,19 @@ public:
     virtual bool
     DeallocPPrintSettingsDialogChild(PPrintSettingsDialogChild* aActor) override;
 
     virtual PRemotePrintJobChild*
     AllocPRemotePrintJobChild() override;
 
     virtual bool
     DeallocPRemotePrintJobChild(PRemotePrintJobChild* aActor) override;
+
+private:
+    nsPrintingProxy();
+
+    virtual ~nsPrintingProxy();
+
+    nsresult Init();
 };
 
 #endif