.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxPageSetupDialogData 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxPageSetupDialogData \- 
  Represents information about the page setup dialog
 
.SH DESCRIPTION

  


   This class holds a variety of information related to
   wxPageSetupDialog
   .
  
  


   It contains a
   wxPrintData
   member which is used to hold basic printer configuration data (as opposed to
   the user-interface configuration settings stored by wxPageSetupDialogData).
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/cmndata.h
.SH MEMBERS

  
.SS  wxPageSetupDialogData ()

     


      Default constructor.
     
    
.SS  wxPageSetupDialogData (wxPageSetupDialogData& data)

     


      Copy constructor.
     
    
.SS  wxPageSetupDialogData (wxPrintData& printData)

     


      Construct an object from a print data object.
     
    
   
  
.SS  ~wxPageSetupDialogData ()

     


      Destructor.
     
    
   
  
.SS void EnableHelp (bool flag)

     


      Enables or disables the `Help' button (Windows only).
     
    
   
  
.SS void EnableMargins (bool flag)

     


      Enables or disables the margin controls (Windows only).
     
    
   
  
.SS void EnableOrientation (bool flag)

     


      Enables or disables the orientation control (Windows only).
     
    
   
  
.SS void EnablePaper (bool flag)

     


      Enables or disables the paper size control (Windows only).
     
    
   
  
.SS void EnablePrinter (bool flag)

     


      Enables or disables the
      
       Printer
      
      button, which invokes a printer setup dialog.
     
    
   
  
.SS bool GetDefaultMinMargins ()

     


      Returns true if the page setup dialog will take its minimum margin values
      from the currently selected printer properties. Windows only.
     
    
   
  
.SS bool GetEnableMargins ()

     


      Returns true if the margin controls are enabled (Windows only).
     
    
   
  
.SS bool GetEnableOrientation ()

     


      Returns true if the orientation control is enabled (Windows only).
     
    
   
  
.SS bool GetEnablePaper ()

     


      Returns true if the paper size control is enabled (Windows only).
     
    
   
  
.SS bool GetEnablePrinter ()

     


      Returns true if the printer setup button is enabled.
     
    
   
  
.SS bool GetEnableHelp ()

     


      Returns true if the printer setup button is enabled.
     
    
   
  
.SS bool GetDefaultInfo ()

     


      Returns true if the dialog will simply return default printer information
      (such as orientation) instead of showing a dialog. Windows only.
     
    
   
  
.SS wxPoint GetMarginTopLeft ()

     


      Returns the left (x) and top (y) margins in millimetres.
     
    
   
  
.SS wxPoint GetMarginBottomRight ()

     


      Returns the right (x) and bottom (y) margins in millimetres.
     
    
   
  
.SS wxPoint GetMinMarginTopLeft ()

     


      Returns the left (x) and top (y) minimum margins the user can enter
      (Windows only). Units are in millimetres
     
    
   
  
.SS wxPoint GetMinMarginBottomRight ()

     


      Returns the right (x) and bottom (y) minimum margins the user can enter
      (Windows only). Units are in millimetres
     
    
   
  
.SS wxPaperSize GetPaperId ()

     


      Returns the paper id (stored in the internal wxPrintData object).
     
     


      For further information, see
      wxPrintData::SetPaperId
      .
     
    
   
  
.SS wxSize GetPaperSize ()

     


      Returns the paper size in millimetres.
     
    
   
  
.SS wxPrintData& GetPrintData ()

     


      Returns a reference to the
      print data
      associated with this object.
     
    
   
  
.SS bool Ok ()

     


      Returns true if the print data associated with the dialog data is valid.
      This can return false on Windows if the current printer is not set, for
      example. On all other platforms, it returns true.
     
    
   
  
.SS void SetDefaultInfo (bool flag)

     


      Pass true if the dialog will simply return default printer information
      (such as orientation) instead of showing a dialog. Windows only.
     
    
   
  
.SS void SetDefaultMinMargins (bool flag)

     


      Pass true if the page setup dialog will take its minimum margin values
      from the currently selected printer properties. Windows only. Units are in
      millimetres
     
    
   
  
.SS void SetMarginTopLeft (const wxPoint& pt)

     


      Sets the left (x) and top (y) margins in millimetres.
     
    
   
  
.SS void SetMarginBottomRight (const wxPoint& pt)

     


      Sets the right (x) and bottom (y) margins in millimetres.
     
    
   
  
.SS void SetMinMarginTopLeft (const wxPoint& pt)

     


      Sets the left (x) and top (y) minimum margins the user can enter (Windows
      only). Units are in millimetres.
     
    
   
  
.SS void SetMinMarginBottomRight (const wxPoint& pt)

     


      Sets the right (x) and bottom (y) minimum margins the user can enter
      (Windows only). Units are in millimetres.
     
    
   
  
.SS void SetPaperId (wxPaperSize& id)

     


      Sets the paper size id. For further information, see
      wxPrintData::SetPaperId
      .
     
     


      Calling this function overrides the explicit paper dimensions passed in
      wxPageSetupDialogData::SetPaperSize
      .
     
    
   
  
.SS void SetPaperSize (const wxSize& size)

     


      Sets the paper size in millimetres. If a corresponding paper id is found,
      it will be set in the internal wxPrintData object, otherwise the paper
      size overrides the paper id.
     
    
   
  
.SS void SetPrintData (const wxPrintData& printData)

     


      Sets the
      print data
      associated with this object.
     
    
   
  
.SS void operator = (const wxPrintData& data)

     


      Assigns print data to this object.
     
    
.SS void operator = (const wxPageSetupDialogData& data)

     


      Assigns page setup data to this object.
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxPageSetupDialog
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.