From 4a9055ebb2f5fc69205a1082bbc813839c0e3138 Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Thu, 21 Nov 2013 14:18:31 +0100 Subject: wx: Update documentation links to wxWidgets --- lib/wx/src/gen/wxDC.erl | 176 ++++++++++++++++++++++++------------------------ 1 file changed, 88 insertions(+), 88 deletions(-) (limited to 'lib/wx/src/gen/wxDC.erl') diff --git a/lib/wx/src/gen/wxDC.erl b/lib/wx/src/gen/wxDC.erl index 42d5d7b1df..2a7717b3c3 100644 --- a/lib/wx/src/gen/wxDC.erl +++ b/lib/wx/src/gen/wxDC.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2012. All Rights Reserved. +%% Copyright Ericsson AB 2008-2013. 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 @@ -17,7 +17,7 @@ %% %CopyrightEnd% %% This file is generated DO NOT EDIT -%% @doc See external documentation: wxDC. +%% @doc See external documentation: wxDC. %% @type wxDC(). An object reference, The representation is internal %% and can be changed without notice. It can't be used for comparsion %% stored on disc or distributed for use on other nodes. @@ -64,7 +64,7 @@ blit(This,DestPt={DestPtX,DestPtY},Sz={SzW,SzH},Source,SrcPt={SrcPtX,SrcPtY}) when is_record(This, wx_ref),is_integer(DestPtX),is_integer(DestPtY),is_integer(SzW),is_integer(SzH),is_record(Source, wx_ref),is_integer(SrcPtX),is_integer(SrcPtY) -> blit(This,DestPt,Sz,Source,SrcPt, []). -%% @doc See external documentation. +%% @doc See external documentation. %%
Rop = integer -spec blit(This, DestPt, Sz, Source, SrcPt, [Option]) -> boolean() when This::wxDC(), DestPt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Source::wxDC(), SrcPt::{X::integer(), Y::integer()}, @@ -83,7 +83,7 @@ blit(#wx_ref{type=ThisT,ref=ThisRef},{DestPtX,DestPtY},{SzW,SzH},#wx_ref{type=So wxe_util:call(?wxDC_Blit, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec calcBoundingBox(This, X, Y) -> ok when This::wxDC(), X::integer(), Y::integer(). calcBoundingBox(#wx_ref{type=ThisT,ref=ThisRef},X,Y) @@ -92,7 +92,7 @@ calcBoundingBox(#wx_ref{type=ThisT,ref=ThisRef},X,Y) wxe_util:cast(?wxDC_CalcBoundingBox, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec clear(This) -> ok when This::wxDC(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -100,7 +100,7 @@ clear(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxDC_Clear, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec computeScaleAndOrigin(This) -> ok when This::wxDC(). computeScaleAndOrigin(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -108,7 +108,7 @@ computeScaleAndOrigin(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxDC_ComputeScaleAndOrigin, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec crossHair(This, Pt) -> ok when This::wxDC(), Pt::{X::integer(), Y::integer()}. crossHair(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) @@ -117,7 +117,7 @@ crossHair(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) wxe_util:cast(?wxDC_CrossHair, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec destroyClippingRegion(This) -> ok when This::wxDC(). destroyClippingRegion(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -125,7 +125,7 @@ destroyClippingRegion(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxDC_DestroyClippingRegion, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec deviceToLogicalX(This, X) -> integer() when This::wxDC(), X::integer(). deviceToLogicalX(#wx_ref{type=ThisT,ref=ThisRef},X) @@ -134,7 +134,7 @@ deviceToLogicalX(#wx_ref{type=ThisT,ref=ThisRef},X) wxe_util:call(?wxDC_DeviceToLogicalX, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec deviceToLogicalXRel(This, X) -> integer() when This::wxDC(), X::integer(). deviceToLogicalXRel(#wx_ref{type=ThisT,ref=ThisRef},X) @@ -143,7 +143,7 @@ deviceToLogicalXRel(#wx_ref{type=ThisT,ref=ThisRef},X) wxe_util:call(?wxDC_DeviceToLogicalXRel, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec deviceToLogicalY(This, Y) -> integer() when This::wxDC(), Y::integer(). deviceToLogicalY(#wx_ref{type=ThisT,ref=ThisRef},Y) @@ -152,7 +152,7 @@ deviceToLogicalY(#wx_ref{type=ThisT,ref=ThisRef},Y) wxe_util:call(?wxDC_DeviceToLogicalY, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec deviceToLogicalYRel(This, Y) -> integer() when This::wxDC(), Y::integer(). deviceToLogicalYRel(#wx_ref{type=ThisT,ref=ThisRef},Y) @@ -161,7 +161,7 @@ deviceToLogicalYRel(#wx_ref{type=ThisT,ref=ThisRef},Y) wxe_util:call(?wxDC_DeviceToLogicalYRel, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawArc(This, Pt1, Pt2, Centre) -> ok when This::wxDC(), Pt1::{X::integer(), Y::integer()}, Pt2::{X::integer(), Y::integer()}, Centre::{X::integer(), Y::integer()}. drawArc(#wx_ref{type=ThisT,ref=ThisRef},{Pt1X,Pt1Y},{Pt2X,Pt2Y},{CentreX,CentreY}) @@ -178,7 +178,7 @@ drawBitmap(This,Bmp,Pt={PtX,PtY}) when is_record(This, wx_ref),is_record(Bmp, wx_ref),is_integer(PtX),is_integer(PtY) -> drawBitmap(This,Bmp,Pt, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawBitmap(This, Bmp, Pt, [Option]) -> ok when This::wxDC(), Bmp::wxBitmap:wxBitmap(), Pt::{X::integer(), Y::integer()}, Option :: {useMask, boolean()}. @@ -192,7 +192,7 @@ drawBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef},{PtX,Pt wxe_util:cast(?wxDC_DrawBitmap, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawCheckMark(This, Rect) -> ok when This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. drawCheckMark(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) @@ -201,7 +201,7 @@ drawCheckMark(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:cast(?wxDC_DrawCheckMark, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawCircle(This, Pt, Radius) -> ok when This::wxDC(), Pt::{X::integer(), Y::integer()}, Radius::integer(). drawCircle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},Radius) @@ -210,7 +210,7 @@ drawCircle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},Radius) wxe_util:cast(?wxDC_DrawCircle, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawEllipse(This, Rect) -> ok when This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. drawEllipse(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) @@ -219,7 +219,7 @@ drawEllipse(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:cast(?wxDC_DrawEllipse_1, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawEllipse(This, Pt, Sz) -> ok when This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}. drawEllipse(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) @@ -228,7 +228,7 @@ drawEllipse(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) wxe_util:cast(?wxDC_DrawEllipse_2, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawEllipticArc(This, Pt, Sz, Sa, Ea) -> ok when This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Sa::number(), Ea::number(). drawEllipticArc(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH},Sa,Ea) @@ -237,7 +237,7 @@ drawEllipticArc(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH},Sa,Ea) wxe_util:cast(?wxDC_DrawEllipticArc, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawIcon(This, Icon, Pt) -> ok when This::wxDC(), Icon::wxIcon:wxIcon(), Pt::{X::integer(), Y::integer()}. drawIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef},{PtX,PtY}) @@ -255,7 +255,7 @@ drawLabel(This,Text,Rect={RectX,RectY,RectW,RectH}) when is_record(This, wx_ref),is_list(Text),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> drawLabel(This,Text,Rect, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawLabel(This, Text, Rect, [Option]) -> ok when This::wxDC(), Text::unicode:chardata(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, Option :: {alignment, integer()} @@ -271,7 +271,7 @@ drawLabel(#wx_ref{type=ThisT,ref=ThisRef},Text,{RectX,RectY,RectW,RectH}, Option wxe_util:cast(?wxDC_DrawLabel, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawLine(This, Pt1, Pt2) -> ok when This::wxDC(), Pt1::{X::integer(), Y::integer()}, Pt2::{X::integer(), Y::integer()}. drawLine(#wx_ref{type=ThisT,ref=ThisRef},{Pt1X,Pt1Y},{Pt2X,Pt2Y}) @@ -288,7 +288,7 @@ drawLines(This,Points) when is_record(This, wx_ref),is_list(Points) -> drawLines(This,Points, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawLines(This, Points, [Option]) -> ok when This::wxDC(), Points::[{X::integer(), Y::integer()}], Option :: {xoffset, integer()} @@ -312,7 +312,7 @@ drawPolygon(This,Points) when is_record(This, wx_ref),is_list(Points) -> drawPolygon(This,Points, []). -%% @doc See external documentation. +%% @doc See external documentation. %%
FillStyle = integer -spec drawPolygon(This, Points, [Option]) -> ok when This::wxDC(), Points::[{X::integer(), Y::integer()}], @@ -331,7 +331,7 @@ drawPolygon(#wx_ref{type=ThisT,ref=ThisRef},Points, Options) <> || {X,Y} <- Points>>)/binary, BinOpt/binary>>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawPoint(This, Pt) -> ok when This::wxDC(), Pt::{X::integer(), Y::integer()}. drawPoint(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) @@ -340,7 +340,7 @@ drawPoint(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) wxe_util:cast(?wxDC_DrawPoint, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawRectangle(This, Rect) -> ok when This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. drawRectangle(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) @@ -349,7 +349,7 @@ drawRectangle(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:cast(?wxDC_DrawRectangle_1, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawRectangle(This, Pt, Sz) -> ok when This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}. drawRectangle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) @@ -358,7 +358,7 @@ drawRectangle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) wxe_util:cast(?wxDC_DrawRectangle_2, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawRotatedText(This, Text, Pt, Angle) -> ok when This::wxDC(), Text::unicode:chardata(), Pt::{X::integer(), Y::integer()}, Angle::number(). drawRotatedText(#wx_ref{type=ThisT,ref=ThisRef},Text,{PtX,PtY},Angle) @@ -368,7 +368,7 @@ drawRotatedText(#wx_ref{type=ThisT,ref=ThisRef},Text,{PtX,PtY},Angle) wxe_util:cast(?wxDC_DrawRotatedText, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawRoundedRectangle(This, R, Radius) -> ok when This::wxDC(), R::{X::integer(), Y::integer(), W::integer(), H::integer()}, Radius::number(). drawRoundedRectangle(#wx_ref{type=ThisT,ref=ThisRef},{RX,RY,RW,RH},Radius) @@ -377,7 +377,7 @@ drawRoundedRectangle(#wx_ref{type=ThisT,ref=ThisRef},{RX,RY,RW,RH},Radius) wxe_util:cast(?wxDC_DrawRoundedRectangle_2, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawRoundedRectangle(This, Pt, Sz, Radius) -> ok when This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Radius::number(). drawRoundedRectangle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH},Radius) @@ -386,7 +386,7 @@ drawRoundedRectangle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH},Radius) wxe_util:cast(?wxDC_DrawRoundedRectangle_3, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec drawText(This, Text, Pt) -> ok when This::wxDC(), Text::unicode:chardata(), Pt::{X::integer(), Y::integer()}. drawText(#wx_ref{type=ThisT,ref=ThisRef},Text,{PtX,PtY}) @@ -396,7 +396,7 @@ drawText(#wx_ref{type=ThisT,ref=ThisRef},Text,{PtX,PtY}) wxe_util:cast(?wxDC_DrawText, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec endDoc(This) -> ok when This::wxDC(). endDoc(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -404,7 +404,7 @@ endDoc(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxDC_EndDoc, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec endPage(This) -> ok when This::wxDC(). endPage(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -420,7 +420,7 @@ floodFill(This,Pt={PtX,PtY},Col) when is_record(This, wx_ref),is_integer(PtX),is_integer(PtY),tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> floodFill(This,Pt,Col, []). -%% @doc See external documentation. +%% @doc See external documentation. %%
Style = integer -spec floodFill(This, Pt, Col, [Option]) -> boolean() when This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::wx:wx_colour(), @@ -434,7 +434,7 @@ floodFill(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},Col, Options) wxe_util:call(?wxDC_FloodFill, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getBackground(This) -> wxBrush:wxBrush() when This::wxDC(). getBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -442,7 +442,7 @@ getBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetBackground, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getBackgroundMode(This) -> integer() when This::wxDC(). getBackgroundMode(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -450,7 +450,7 @@ getBackgroundMode(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetBackgroundMode, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getBrush(This) -> wxBrush:wxBrush() when This::wxDC(). getBrush(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -458,7 +458,7 @@ getBrush(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetBrush, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getCharHeight(This) -> integer() when This::wxDC(). getCharHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -466,7 +466,7 @@ getCharHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetCharHeight, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getCharWidth(This) -> integer() when This::wxDC(). getCharWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -474,7 +474,7 @@ getCharWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetCharWidth, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getClippingBox(This) -> Result when Result ::{X::integer(), Y::integer(), W::integer(), H::integer()}, This::wxDC(). @@ -483,7 +483,7 @@ getClippingBox(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetClippingBox, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getFont(This) -> wxFont:wxFont() when This::wxDC(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -491,7 +491,7 @@ getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetFont, <>). -%% @doc See external documentation. +%% @doc See external documentation. %%
Res = ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft -spec getLayoutDirection(This) -> wx:wx_enum() when This::wxDC(). @@ -500,7 +500,7 @@ getLayoutDirection(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetLayoutDirection, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getLogicalFunction(This) -> integer() when This::wxDC(). getLogicalFunction(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -508,7 +508,7 @@ getLogicalFunction(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetLogicalFunction, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getMapMode(This) -> integer() when This::wxDC(). getMapMode(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -516,7 +516,7 @@ getMapMode(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetMapMode, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getMultiLineTextExtent(This, String) -> {W::integer(), H::integer()} when This::wxDC(), String::unicode:chardata(). getMultiLineTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String) @@ -526,7 +526,7 @@ getMultiLineTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String) wxe_util:call(?wxDC_GetMultiLineTextExtent_1, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getMultiLineTextExtent(This, String, [Option]) -> {Width::integer(), Height::integer(), HeightLine::integer()} when This::wxDC(), String::unicode:chardata(), Option :: {font, wxFont:wxFont()}. @@ -540,7 +540,7 @@ getMultiLineTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String, Options) wxe_util:call(?wxDC_GetMultiLineTextExtent_4, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getPartialTextExtents(This, Text) -> Result when Result ::{Res ::boolean(), Widths::[integer()]}, This::wxDC(), Text::unicode:chardata(). @@ -551,7 +551,7 @@ getPartialTextExtents(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:call(?wxDC_GetPartialTextExtents, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getPen(This) -> wxPen:wxPen() when This::wxDC(). getPen(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -559,7 +559,7 @@ getPen(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetPen, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getPixel(This, Pt) -> Result when Result ::{Res ::boolean(), Col::wx:wx_colour4()}, This::wxDC(), Pt::{X::integer(), Y::integer()}. @@ -569,7 +569,7 @@ getPixel(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) wxe_util:call(?wxDC_GetPixel, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getPPI(This) -> {W::integer(), H::integer()} when This::wxDC(). getPPI(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -577,7 +577,7 @@ getPPI(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetPPI, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getSize(This) -> {W::integer(), H::integer()} when This::wxDC(). getSize(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -585,7 +585,7 @@ getSize(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetSize, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getSizeMM(This) -> {W::integer(), H::integer()} when This::wxDC(). getSizeMM(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -593,7 +593,7 @@ getSizeMM(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetSizeMM, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getTextBackground(This) -> wx:wx_colour4() when This::wxDC(). getTextBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -601,7 +601,7 @@ getTextBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetTextBackground, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getTextExtent(This, String) -> {W::integer(), H::integer()} when This::wxDC(), String::unicode:chardata(). getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String) @@ -611,7 +611,7 @@ getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String) wxe_util:call(?wxDC_GetTextExtent_1, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getTextExtent(This, String, [Option]) -> Result when Result :: {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}, This::wxDC(), String::unicode:chardata(), @@ -626,7 +626,7 @@ getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String, Options) wxe_util:call(?wxDC_GetTextExtent_4, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getTextForeground(This) -> wx:wx_colour4() when This::wxDC(). getTextForeground(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -634,7 +634,7 @@ getTextForeground(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetTextForeground, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getUserScale(This) -> {X::number(), Y::number()} when This::wxDC(). getUserScale(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -642,7 +642,7 @@ getUserScale(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_GetUserScale, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec gradientFillConcentric(This, Rect, InitialColour, DestColour) -> ok when This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:wx_colour(), DestColour::wx:wx_colour(). gradientFillConcentric(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},InitialColour,DestColour) @@ -651,7 +651,7 @@ gradientFillConcentric(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH} wxe_util:cast(?wxDC_GradientFillConcentric_3, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec gradientFillConcentric(This, Rect, InitialColour, DestColour, CircleCenter) -> ok when This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:wx_colour(), DestColour::wx:wx_colour(), CircleCenter::{X::integer(), Y::integer()}. gradientFillConcentric(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},InitialColour,DestColour,{CircleCenterX,CircleCenterY}) @@ -668,7 +668,7 @@ gradientFillLinear(This,Rect={RectX,RectY,RectW,RectH},InitialColour,DestColour) when is_record(This, wx_ref),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),tuple_size(InitialColour) =:= 3; tuple_size(InitialColour) =:= 4,tuple_size(DestColour) =:= 3; tuple_size(DestColour) =:= 4 -> gradientFillLinear(This,Rect,InitialColour,DestColour, []). -%% @doc See external documentation. +%% @doc See external documentation. %%
NDirection = ?wxLEFT | ?wxRIGHT | ?wxUP | ?wxDOWN | ?wxTOP | ?wxBOTTOM | ?wxNORTH | ?wxSOUTH | ?wxWEST | ?wxEAST | ?wxALL -spec gradientFillLinear(This, Rect, InitialColour, DestColour, [Option]) -> ok when This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:wx_colour(), DestColour::wx:wx_colour(), @@ -682,7 +682,7 @@ gradientFillLinear(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},Ini wxe_util:cast(?wxDC_GradientFillLinear, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec logicalToDeviceX(This, X) -> integer() when This::wxDC(), X::integer(). logicalToDeviceX(#wx_ref{type=ThisT,ref=ThisRef},X) @@ -691,7 +691,7 @@ logicalToDeviceX(#wx_ref{type=ThisT,ref=ThisRef},X) wxe_util:call(?wxDC_LogicalToDeviceX, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec logicalToDeviceXRel(This, X) -> integer() when This::wxDC(), X::integer(). logicalToDeviceXRel(#wx_ref{type=ThisT,ref=ThisRef},X) @@ -700,7 +700,7 @@ logicalToDeviceXRel(#wx_ref{type=ThisT,ref=ThisRef},X) wxe_util:call(?wxDC_LogicalToDeviceXRel, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec logicalToDeviceY(This, Y) -> integer() when This::wxDC(), Y::integer(). logicalToDeviceY(#wx_ref{type=ThisT,ref=ThisRef},Y) @@ -709,7 +709,7 @@ logicalToDeviceY(#wx_ref{type=ThisT,ref=ThisRef},Y) wxe_util:call(?wxDC_LogicalToDeviceY, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec logicalToDeviceYRel(This, Y) -> integer() when This::wxDC(), Y::integer(). logicalToDeviceYRel(#wx_ref{type=ThisT,ref=ThisRef},Y) @@ -718,7 +718,7 @@ logicalToDeviceYRel(#wx_ref{type=ThisT,ref=ThisRef},Y) wxe_util:call(?wxDC_LogicalToDeviceYRel, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec maxX(This) -> integer() when This::wxDC(). maxX(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -726,7 +726,7 @@ maxX(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_MaxX, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec maxY(This) -> integer() when This::wxDC(). maxY(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -734,7 +734,7 @@ maxY(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_MaxY, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec minX(This) -> integer() when This::wxDC(). minX(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -742,7 +742,7 @@ minX(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_MinX, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec minY(This) -> integer() when This::wxDC(). minY(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -750,7 +750,7 @@ minY(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_MinY, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec isOk(This) -> boolean() when This::wxDC(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -758,7 +758,7 @@ isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxDC_IsOk, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec resetBoundingBox(This) -> ok when This::wxDC(). resetBoundingBox(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -766,7 +766,7 @@ resetBoundingBox(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxDC_ResetBoundingBox, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setAxisOrientation(This, XLeftRight, YBottomUp) -> ok when This::wxDC(), XLeftRight::boolean(), YBottomUp::boolean(). setAxisOrientation(#wx_ref{type=ThisT,ref=ThisRef},XLeftRight,YBottomUp) @@ -775,7 +775,7 @@ setAxisOrientation(#wx_ref{type=ThisT,ref=ThisRef},XLeftRight,YBottomUp) wxe_util:cast(?wxDC_SetAxisOrientation, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setBackground(This, Brush) -> ok when This::wxDC(), Brush::wxBrush:wxBrush(). setBackground(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> @@ -784,7 +784,7 @@ setBackground(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) wxe_util:cast(?wxDC_SetBackground, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setBackgroundMode(This, Mode) -> ok when This::wxDC(), Mode::integer(). setBackgroundMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) @@ -793,7 +793,7 @@ setBackgroundMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) wxe_util:cast(?wxDC_SetBackgroundMode, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setBrush(This, Brush) -> ok when This::wxDC(), Brush::wxBrush:wxBrush(). setBrush(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> @@ -802,7 +802,7 @@ setBrush(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> wxe_util:cast(?wxDC_SetBrush, <>). -%% @doc See external documentation. +%% @doc See external documentation. %%
Also:
%% setClippingRegion(This, Rect) -> ok when
%% This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
@@ -822,7 +822,7 @@ setClippingRegion(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:cast(?wxDC_SetClippingRegion_1_1, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setClippingRegion(This, Pt, Sz) -> ok when This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}. setClippingRegion(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) @@ -831,7 +831,7 @@ setClippingRegion(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) wxe_util:cast(?wxDC_SetClippingRegion_2, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setDeviceOrigin(This, X, Y) -> ok when This::wxDC(), X::integer(), Y::integer(). setDeviceOrigin(#wx_ref{type=ThisT,ref=ThisRef},X,Y) @@ -840,7 +840,7 @@ setDeviceOrigin(#wx_ref{type=ThisT,ref=ThisRef},X,Y) wxe_util:cast(?wxDC_SetDeviceOrigin, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setFont(This, Font) -> ok when This::wxDC(), Font::wxFont:wxFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> @@ -849,7 +849,7 @@ setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> wxe_util:cast(?wxDC_SetFont, <>). -%% @doc See external documentation. +%% @doc See external documentation. %%
Dir = ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft -spec setLayoutDirection(This, Dir) -> ok when This::wxDC(), Dir::wx:wx_enum(). @@ -859,7 +859,7 @@ setLayoutDirection(#wx_ref{type=ThisT,ref=ThisRef},Dir) wxe_util:cast(?wxDC_SetLayoutDirection, <>). -%% @doc See external documentation. +%% @doc See external documentation. %%
Function = integer -spec setLogicalFunction(This, Function) -> ok when This::wxDC(), Function::wx:wx_enum(). @@ -869,7 +869,7 @@ setLogicalFunction(#wx_ref{type=ThisT,ref=ThisRef},Function) wxe_util:cast(?wxDC_SetLogicalFunction, <>). -%% @doc See external documentation. +%% @doc See external documentation. %%
Mode = integer -spec setMapMode(This, Mode) -> ok when This::wxDC(), Mode::wx:wx_enum(). @@ -879,7 +879,7 @@ setMapMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) wxe_util:cast(?wxDC_SetMapMode, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setPalette(This, Palette) -> ok when This::wxDC(), Palette::wxPalette:wxPalette(). setPalette(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PaletteT,ref=PaletteRef}) -> @@ -888,7 +888,7 @@ setPalette(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PaletteT,ref=PaletteRef} wxe_util:cast(?wxDC_SetPalette, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setPen(This, Pen) -> ok when This::wxDC(), Pen::wxPen:wxPen(). setPen(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PenT,ref=PenRef}) -> @@ -897,7 +897,7 @@ setPen(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PenT,ref=PenRef}) -> wxe_util:cast(?wxDC_SetPen, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setTextBackground(This, Colour) -> ok when This::wxDC(), Colour::wx:wx_colour(). setTextBackground(#wx_ref{type=ThisT,ref=ThisRef},Colour) @@ -906,7 +906,7 @@ setTextBackground(#wx_ref{type=ThisT,ref=ThisRef},Colour) wxe_util:cast(?wxDC_SetTextBackground, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setTextForeground(This, Colour) -> ok when This::wxDC(), Colour::wx:wx_colour(). setTextForeground(#wx_ref{type=ThisT,ref=ThisRef},Colour) @@ -915,7 +915,7 @@ setTextForeground(#wx_ref{type=ThisT,ref=ThisRef},Colour) wxe_util:cast(?wxDC_SetTextForeground, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setUserScale(This, X, Y) -> ok when This::wxDC(), X::number(), Y::number(). setUserScale(#wx_ref{type=ThisT,ref=ThisRef},X,Y) @@ -924,7 +924,7 @@ setUserScale(#wx_ref{type=ThisT,ref=ThisRef},X,Y) wxe_util:cast(?wxDC_SetUserScale, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec startDoc(This, Message) -> boolean() when This::wxDC(), Message::unicode:chardata(). startDoc(#wx_ref{type=ThisT,ref=ThisRef},Message) @@ -934,7 +934,7 @@ startDoc(#wx_ref{type=ThisT,ref=ThisRef},Message) wxe_util:call(?wxDC_StartDoc, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec startPage(This) -> ok when This::wxDC(). startPage(#wx_ref{type=ThisT,ref=ThisRef}) -> -- cgit v1.2.3