diff options
Diffstat (limited to 'lib/wx/src/gen/wxPrintPreview.erl')
| -rw-r--r-- | lib/wx/src/gen/wxPrintPreview.erl | 67 |
1 files changed, 45 insertions, 22 deletions
diff --git a/lib/wx/src/gen/wxPrintPreview.erl b/lib/wx/src/gen/wxPrintPreview.erl index 6f9a0f653f..717589c871 100644 --- a/lib/wx/src/gen/wxPrintPreview.erl +++ b/lib/wx/src/gen/wxPrintPreview.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2010. All Rights Reserved. +%% Copyright Ericsson AB 2008-2012. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -32,18 +32,24 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPrintPreview/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Printout::wxPrintout:wxPrintout()) -> wxPrintPreview() +-type wxPrintPreview() :: wx:wx_object(). %% @equiv new(Printout, []) +-spec new(Printout) -> wxPrintPreview() when + Printout::wxPrintout:wxPrintout(). + new(Printout) when is_record(Printout, wx_ref) -> new(Printout, []). -%% @spec (Printout::wxPrintout:wxPrintout(), [Option]) -> wxPrintPreview() -%% Option = {printoutForPrinting, wxPrintout:wxPrintout()} | {data, wxPrintDialogData:wxPrintDialogData()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewwxprintpreview">external documentation</a>. +-spec new(Printout, [Option]) -> wxPrintPreview() when + Printout::wxPrintout:wxPrintout(), + Option :: {printoutForPrinting, wxPrintout:wxPrintout()} + | {data, wxPrintDialogData:wxPrintDialogData()}. new(#wx_ref{type=PrintoutT,ref=PrintoutRef}, Options) when is_list(Options) -> ?CLASS(PrintoutT,wxPrintout), @@ -54,8 +60,9 @@ new(#wx_ref{type=PrintoutT,ref=PrintoutRef}, Options) wxe_util:construct(?wxPrintPreview_new_2, <<PrintoutRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (Printout::wxPrintout:wxPrintout(), PrintoutForPrinting::wxPrintout:wxPrintout(), Data::wxPrintData:wxPrintData()) -> wxPrintPreview() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewwxprintpreview">external documentation</a>. +-spec new(Printout, PrintoutForPrinting, Data) -> wxPrintPreview() when + Printout::wxPrintout:wxPrintout(), PrintoutForPrinting::wxPrintout:wxPrintout(), Data::wxPrintData:wxPrintData(). new(#wx_ref{type=PrintoutT,ref=PrintoutRef},#wx_ref{type=PrintoutForPrintingT,ref=PrintoutForPrintingRef},#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(PrintoutT,wxPrintout), ?CLASS(PrintoutForPrintingT,wxPrintout), @@ -63,64 +70,73 @@ new(#wx_ref{type=PrintoutT,ref=PrintoutRef},#wx_ref{type=PrintoutForPrintingT,re wxe_util:construct(?wxPrintPreview_new_3, <<PrintoutRef:32/?UI,PrintoutForPrintingRef:32/?UI,DataRef:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> wxPreviewCanvas:wxPreviewCanvas() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewgetcanvas">external documentation</a>. +-spec getCanvas(This) -> wxPreviewCanvas:wxPreviewCanvas() when + This::wxPrintPreview(). getCanvas(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetCanvas, <<ThisRef:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewgetcurrentpage">external documentation</a>. +-spec getCurrentPage(This) -> integer() when + This::wxPrintPreview(). getCurrentPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetCurrentPage, <<ThisRef:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> wxFrame:wxFrame() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewgetframe">external documentation</a>. +-spec getFrame(This) -> wxFrame:wxFrame() when + This::wxPrintPreview(). getFrame(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetFrame, <<ThisRef:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewgetmaxpage">external documentation</a>. +-spec getMaxPage(This) -> integer() when + This::wxPrintPreview(). getMaxPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetMaxPage, <<ThisRef:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewgetminpage">external documentation</a>. +-spec getMinPage(This) -> integer() when + This::wxPrintPreview(). getMinPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetMinPage, <<ThisRef:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> wxPrintout:wxPrintout() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewgetprintout">external documentation</a>. +-spec getPrintout(This) -> wxPrintout:wxPrintout() when + This::wxPrintPreview(). getPrintout(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetPrintout, <<ThisRef:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> wxPrintout:wxPrintout() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewgetprintoutforprinting">external documentation</a>. +-spec getPrintoutForPrinting(This) -> wxPrintout:wxPrintout() when + This::wxPrintPreview(). getPrintoutForPrinting(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetPrintoutForPrinting, <<ThisRef:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewisok">external documentation</a>. +-spec isOk(This) -> boolean() when + This::wxPrintPreview(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_IsOk, <<ThisRef:32/?UI>>). -%% @spec (This::wxPrintPreview(), Canvas::wxPreviewCanvas:wxPreviewCanvas(), Dc::wxDC:wxDC()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewpaintpage">external documentation</a>. +-spec paintPage(This, Canvas, Dc) -> boolean() when + This::wxPrintPreview(), Canvas::wxPreviewCanvas:wxPreviewCanvas(), Dc::wxDC:wxDC(). paintPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CanvasT,ref=CanvasRef},#wx_ref{type=DcT,ref=DcRef}) -> ?CLASS(ThisT,wxPrintPreview), ?CLASS(CanvasT,wxPreviewCanvas), @@ -128,64 +144,71 @@ paintPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CanvasT,ref=CanvasRef},#w wxe_util:call(?wxPrintPreview_PaintPage, <<ThisRef:32/?UI,CanvasRef:32/?UI,DcRef:32/?UI>>). -%% @spec (This::wxPrintPreview(), Interactive::bool()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewprint">external documentation</a>. +-spec print(This, Interactive) -> boolean() when + This::wxPrintPreview(), Interactive::boolean(). print(#wx_ref{type=ThisT,ref=ThisRef},Interactive) when is_boolean(Interactive) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_Print, <<ThisRef:32/?UI,(wxe_util:from_bool(Interactive)):32/?UI>>). -%% @spec (This::wxPrintPreview(), PageNum::integer()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewrenderpage">external documentation</a>. +-spec renderPage(This, PageNum) -> boolean() when + This::wxPrintPreview(), PageNum::integer(). renderPage(#wx_ref{type=ThisT,ref=ThisRef},PageNum) when is_integer(PageNum) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_RenderPage, <<ThisRef:32/?UI,PageNum:32/?UI>>). -%% @spec (This::wxPrintPreview(), Canvas::wxPreviewCanvas:wxPreviewCanvas()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewsetcanvas">external documentation</a>. +-spec setCanvas(This, Canvas) -> ok when + This::wxPrintPreview(), Canvas::wxPreviewCanvas:wxPreviewCanvas(). setCanvas(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CanvasT,ref=CanvasRef}) -> ?CLASS(ThisT,wxPrintPreview), ?CLASS(CanvasT,wxPreviewCanvas), wxe_util:cast(?wxPrintPreview_SetCanvas, <<ThisRef:32/?UI,CanvasRef:32/?UI>>). -%% @spec (This::wxPrintPreview(), PageNum::integer()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewsetcurrentpage">external documentation</a>. +-spec setCurrentPage(This, PageNum) -> boolean() when + This::wxPrintPreview(), PageNum::integer(). setCurrentPage(#wx_ref{type=ThisT,ref=ThisRef},PageNum) when is_integer(PageNum) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_SetCurrentPage, <<ThisRef:32/?UI,PageNum:32/?UI>>). -%% @spec (This::wxPrintPreview(), Frame::wxFrame:wxFrame()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewsetframe">external documentation</a>. +-spec setFrame(This, Frame) -> ok when + This::wxPrintPreview(), Frame::wxFrame:wxFrame(). setFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef}) -> ?CLASS(ThisT,wxPrintPreview), ?CLASS(FrameT,wxFrame), wxe_util:cast(?wxPrintPreview_SetFrame, <<ThisRef:32/?UI,FrameRef:32/?UI>>). -%% @spec (This::wxPrintPreview(), Printout::wxPrintout:wxPrintout()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewsetprintout">external documentation</a>. +-spec setPrintout(This, Printout) -> ok when + This::wxPrintPreview(), Printout::wxPrintout:wxPrintout(). setPrintout(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PrintoutT,ref=PrintoutRef}) -> ?CLASS(ThisT,wxPrintPreview), ?CLASS(PrintoutT,wxPrintout), wxe_util:cast(?wxPrintPreview_SetPrintout, <<ThisRef:32/?UI,PrintoutRef:32/?UI>>). -%% @spec (This::wxPrintPreview(), Percent::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxprintpreview.html#wxprintpreviewsetzoom">external documentation</a>. +-spec setZoom(This, Percent) -> ok when + This::wxPrintPreview(), Percent::integer(). setZoom(#wx_ref{type=ThisT,ref=ThisRef},Percent) when is_integer(Percent) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:cast(?wxPrintPreview_SetZoom, <<ThisRef:32/?UI,Percent:32/?UI>>). -%% @spec (This::wxPrintPreview()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPrintPreview) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPrintPreview), wxe_util:destroy(?DESTROY_OBJECT,Obj), |