wxErlang

wxAcceleratorTable.erl

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
%        /\  /¯  /¯  |_¯ |   |_¯ |¯\  /\  ¯|¯ /¯\ |¯\  ¯|¯  /\  |¯|  |   |_¯ 
%\  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_wxacceleratortable.html">wxAcceleratorTable</a>.
%% @type wxAcceleratorTable().  
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%   
%%   OVERVIEW
%%   ––––––––
%%   An accelerator table allows the application to specify a table of keyboard 
%%   shortcuts for menu or button commands.
%%   
%%   The object wxNullAcceleratorTable is defined to be a table with no data, 
%%   and is the initial accelerator table for a window.
%%   
%%   An accelerator takes precedence over normal processing and can be a 
%%   convenient way to program some event handling. For example, you can use 
%%   an accelerator table to enable a dialog with a multi-line text control 
%%   to accept CTRL-Enter as meaning 'OK' (but not in GTK+ at present).
%%   
%%   See Also:
%%   —————————
%%    wxAcceleratorEntry, wxWindow:SetAcceleratorTable
%%   
%%   
-module(wxAcceleratorTable).
-include("wxe.hrl").
-export([
            destroy/1,
            
            new/0,
            new/2,

            ok/1]).

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

-export_type([wxAcceleratorTable/0]).


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




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


           %·%% NEW %%·%

%%   
%%   Default constructor.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec new() -> wxAcceleratorTable().
new() ->
  wxe_util:construct(?wxAcceleratorTable_new_0,
               <<>>).


%%   
%%   Creates from an array of wxAcceleratorEntry objects.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec new(N, Entries) -> wxAcceleratorTable()
           when
           N       ::                                 integer() ,
           Entries :: [ wxAcceleratorEntry:wxAcceleratorEntry() ].

new(N,Entries)
           when 
           is_integer(N),
           is_list(Entries) ->
                           [ ?CLASS(EntriesT,wxAcceleratorEntry) || #wx_ref{type=EntriesT} <- Entries ],
               
                  wxe_util:construct(?wxAcceleratorTable_new_2,
                  <<N:32/?UI,(length(Entries)):32/?UI,
                  
                                    (<< <<(C#wx_ref.ref):32/?UI>> || C <- Entries>>)/binary, 0:(((0+length(Entries)) rem 2)*32)>>).








           %·%% OK %%·%

%%   
%%    Returns true if the accelerator table is valid.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec ok(This) -> boolean()
           when
           This :: wxAcceleratorTable().

ok(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                     ?CLASS(ThisT,wxAcceleratorTable),
                       wxe_util:call(?wxAcceleratorTable_Ok,
                       <<ThisRef:32/?UI>>).








           %·%% DESTROY %%·%

%%   
%%   Destroys the wxAcceleratorTable object. 
%%   See reference-counted object destruction for more info.
%%   
%% @doc Destroys this object, do not use object again
          -spec destroy(This :: wxAcceleratorTable()) -> ok.

destroy(Obj=#wx_ref{type=Type}) ->
                                 ?CLASS(Type,wxAcceleratorTable),
                wxe_util:destroy(?DESTROY_OBJECT,Obj),
                ok.