libs-gui/Documentation/gsdoc/NSPageLayout.gsdoc
Adam Fedor 05bdcda840 Updated docs
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@12233 72102866-910b-0410-8b05-ffd578937521
2002-01-28 04:50:14 +00:00

210 lines
6.8 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.7//EN" "http://www.gnustep.org/gsdoc-0_6_7.xml">
<gsdoc base="NSPageLayout" up="Gui">
<head>
<title>NSPageLayout</title>
<author name="Adam Fedor">
<email address="fedor@gnu.org">
fedor@gnu.org
</email>
</author>
<abstract>
Standard panel for querying user about page layout.
</abstract>
<copy>2001 Free Software Foundation, Inc.</copy>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>NSPageLayout</heading>
<p>
NSPageLayout provides a panel that allows the user
to specify certain information about the printer and how
data is formatted for printing. This includes information
about the paper size and orientation. Typically you would
create a page layout panel with the
<ref type="method" id="+pageLayout">
+pageLayout
</ref>
class method. However, the best way to use the panel is
to have the application call the runPageLayout: method in
the NSApplication object which would both create a standard
NSPageLayout panel and display it in a modal loop.
This method would be sent up the responder chain if the
user clicked on a Page Layout menu item.
</p>
<class name="NSPageLayout" super="NSPanel">
<declared>AppKit/NSPageLayout.h</declared>
<desc>
</desc>
<method type="NSPageLayout*" factory="yes">
<sel>pageLayout</sel>
<desc>
Creates and returns a shared instance of the
NSPageLayout panel.
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="NSView*">
<sel>accessoryView</sel>
<desc>
Returns the accessory view for the page layout
panel
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>beginSheetWithPrintInfo:</sel>
<arg type="NSPrintInfo*">printInfo</arg>
<sel>modalForWindow:</sel>
<arg type="NSWindow*">docWindow</arg>
<sel>delegate:</sel>
<arg type="id">delegate</arg>
<sel>didEndSelector:</sel>
<arg type="SEL">didEndSelector</arg>
<sel>contextInfo:</sel>
<arg type="void*">contextInfo</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<NotOpenStep /> <GNUstep /> <MacOS-X />
</standards>
</method>
<method type="void">
<sel>convertOldFactor:</sel>
<arg type="float*">old</arg>
<sel>newFactor:</sel>
<arg type="float*">new</arg>
<desc>
Convert the <var>old</var> value to a
<var>new</var> one based on the current units. This
method has been depreciated. It doesn't do anything
useful
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>pickedButton:</sel>
<arg type="id">sender</arg>
<desc>
This method has been depreciated. It doesn't do
anything useful.
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>pickedOrientation:</sel>
<arg type="id">sender</arg>
<desc>
This method has been depreciated. It doesn't do
anything useful.
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>pickedPaperSize:</sel>
<arg type="id">sender</arg>
<desc>
This method has been depreciated. It doesn't do
anything useful.
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>pickedUnits:</sel>
<arg type="id">sender</arg>
<desc>
This method has been depreciated. It doesn't do
anything useful.
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="NSPrintInfo*">
<sel>printInfo</sel>
<desc>
Return the NSPrintInfo object that the receiver
stores layout information into.
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>readPrintInfo</sel>
<desc>
Updates the receiver panel with information from
its NSPrintInfo object
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="int">
<sel>runModal</sel>
<desc>
Display the Page Layout panel in a modal loop.
Saves any aquired information in the shared
NSPrintInfo object. Returns NSCancelButton if
the user clicks the Cancel button or NSOKButton
otherwise.
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="int">
<sel>runModalWithPrintInfo:</sel>
<arg type="NSPrintInfo*">pInfo</arg>
<desc>
Display the Page Layout panel in a modal loop.
Saves any aquired information in the indicated
NSPrintInfo object. Returns NSCancelButton if
the user clicks the Cancel button or NSOKButton
otherwise.
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setAccessoryView:</sel>
<arg type="NSView*">aView</arg>
<desc>
Set the accessory view for the page layout panel
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>writePrintInfo</sel>
<desc>
Writes any layout information set by the user to the
receiver's NSPrintInfo object
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</class>
</chapter>
</body>
</gsdoc>