%        /\  ) (  |  |¯\ /¯\ /¯  |_/   /\  |¯\ ¯|¯              
%\  W X /¯¯\ \_/  |  |_/ \_/ \_, | \  /¯¯\ |¯\  | . E  R  L 
%%—————————————————————————————————————————————————————————
%%
%%   Copyright Ericsson AB 2008-2013. All Rights Reserved.
%%
%%——————————————————————————————————————————————
%% Whitespace Beautified by ScriptCulture © 2018
%% Sit Back · Feet Up · Learn wxErlang
%% For use as a reference only
%% www.scriptculture.com
%% Not check-summed 
%% wx 1.8 —————————————————————————————————————— 
%%
%% Licensed under the Apache License, 
%% Version 2.0 (the "License"); you may 
%% not use this file except in compliance 
%% with the License. You may obtain a copy 
%% of the License at:
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by 
%% applicable law or agreed to in writing, software
%% distributed under the License is distributed 
%% on an "AS IS" BASIS, WITHOUT WARRANTIES 
%% OR CONDITIONS OF ANY KIND, either 
%% express or implied. See the 
%% License for the specific 
%% language governing 
%% permissions and
%% limitations 
%% under the 
%% License.
%%%%%%%
%%%%
%%%%%
%% @doc See external documentation: <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxauidockart.html">wxAuiDockArt</a>.
%% @type wxAuiDockArt().  
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%   
%%   OVERVIEW
%%   ––––––––
%%   wxAuiDockArt is part of the wxAUI class framework.
%%   Check out the wxAUI Overview.
%%
%%   wxAuiDockArt is the art provider: 
%%   provides all drawing functionality to the wxAui dock manager. 
%%   This allows the dock manager to have a plugable look-and-feel.
%%
%%   By default, a wxAuiManager uses an instance of this class called 
%%   wxAuiDefaultDockArt which provides bitmap art and a colour scheme 
%%   that is adapted to the major platforms' look. You can either derive 
%%   from that class to alter its behaviour or write a completely new dock art class. 
%%   Call wxAuiManager::SetArtProvider to force wxAUI to use your new dock art provider.
%%   
%%   
%%   See Also:
%%   —————————
%%   wxAuiManager, wxAuiPaneInfo 
%%   
%%   
-module(wxAuiDockArt).
-include("wxe.hrl").
-export([

                getColour/2,
                getFont/2,
                getMetric/2,

                setColour/3,
                setFont/3,
                setMetric/3
                                  ]).


%% inherited exports
-export([parent_class/1]).

-export_type([wxAuiDockArt/0]).


%% @hidden
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).




-type wxAuiDockArt()  ::  wx:wx_object().




           %·%% GET COLOUR %%·%

%%   
%%   Get the colour of a certain setting.
%%
%%   id can be one of the colour values of wxAuiPaneDockArtSetting.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getColour(This, Id) -> wx:wx_colour4()
           when
 	         This :: wxAuiDockArt(), 
           Id   ::      integer().

getColour(#wx_ref{type=ThisT,ref=ThisRef},Id)
           when 
           is_integer(Id) ->
                           ?CLASS(ThisT,wxAuiDockArt),
             wxe_util:call(?wxAuiDockArt_GetColour,
             <<ThisRef:32/?UI,Id:32/?UI>>).





           %·%% GET FONT %%·%

%%   
%%   Get a font setting. 
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getFont(This, Id) -> wxFont:wxFont()
           when
 	         This :: wxAuiDockArt(), 
           Id   ::      integer().

getFont(#wx_ref{type=ThisT,ref=ThisRef}, Id)
           when 
           is_integer(Id) ->
                           ?CLASS(ThisT,wxAuiDockArt),
             wxe_util:call(?wxAuiDockArt_GetFont,
             <<ThisRef:32/?UI,Id:32/?UI>>).





           %·%% GET METRIC %%·%

%%   
%%   Get the value of a certain setting.
%%
%%   id can be one of the size values of wxAuiPaneDockArtSetting.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getMetric(This, Id) -> integer()
           when
 	         This :: wxAuiDockArt(), 
           Id   ::      integer().

getMetric(#wx_ref{type=ThisT,ref=ThisRef}, Id)
           when 
           is_integer(Id) ->
                           ?CLASS(ThisT,wxAuiDockArt),
             wxe_util:call(?wxAuiDockArt_GetMetric,
             <<ThisRef:32/?UI,Id:32/?UI>>).





           %·%% SET COLOUR %%·%

%%   
%%   Set a certain setting with the value colour.
%%
%%   id can be one of the colour values of wxAuiPaneDockArtSetting.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setColour(This, Id, Colour) -> ok
           when
 	         This   :: wxAuiDockArt(), 
           Id     ::      integer(), 
           Colour :: wx:wx_colour().

setColour(#wx_ref{type=ThisT,ref=ThisRef}, Id, Colour)
           when 
           is_integer(Id),
           tuple_size(Colour) =:= 3; 
           tuple_size(Colour) =:= 4 ->
                                     ?CLASS(ThisT,wxAuiDockArt),
                       wxe_util:cast(?wxAuiDockArt_SetColour,
                       <<ThisRef:32/?UI,Id:32/?UI,(wxe_util:colour_bin(Colour)):16/binary>>).





           %·%% SET FONT %%·%

%%   
%%   Set a font setting. 
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setFont(This, Id, Font) -> ok
           when
 	         This ::  wxAuiDockArt(), 
           Id   ::       integer(), 
           Font :: wxFont:wxFont().

setFont(#wx_ref{type=ThisT,ref=ThisRef},
                                      Id,
          #wx_ref{type=FontT,ref=FontRef})
           when 
           is_integer(Id) ->
                           ?CLASS(ThisT,wxAuiDockArt),
                           ?CLASS(FontT,wxFont),
             wxe_util:cast(?wxAuiDockArt_SetFont,
             <<ThisRef:32/?UI,Id:32/?UI,FontRef:32/?UI>>).





           %·%% SET METRIC %%·%

%%   
%%   Set a certain setting with the value new_val.
%%
%%   id can be one of the size values of wxAuiPaneDockArtSetting.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setMetric(This, Id, New_val) -> ok
           when
 	         This    :: wxAuiDockArt(), 
           Id      ::      integer(), 
           New_val ::      integer().

setMetric(#wx_ref{type=ThisT,ref=ThisRef}, Id, New_val)
           when 
           is_integer(Id),
           is_integer(New_val) ->
                                ?CLASS(ThisT,wxAuiDockArt),
                  wxe_util:cast(?wxAuiDockArt_SetMetric,
                  <<ThisRef:32/?UI,Id:32/?UI,New_val:32/?UI>>).