.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxAcceleratorTable 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxAcceleratorTable \- 
  Accelerator table
 
.SH DESCRIPTION

  


   An accelerator table allows the application to specify a table of keyboard
   shortcuts for menus or other commands. On Windows, menu or button commands
   are supported; on GTK, only menu commands are supported.
  
  


   The object
   
    wxNullAcceleratorTable
   
   is defined to be a table with no data, and is the initial accelerator table
   for a window.
  
 
.SH REMARKS

  
   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).
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/accel.h
.SH MEMBERS

  
.SS  wxAcceleratorTable ()

     


      Default constructor.
     
    
.SS  wxAcceleratorTable (const wxAcceleratorTable& bitmap)

     


      Copy constructor.
     
    
.SS  wxAcceleratorTable (int nwxAcceleratorEntry entries[])

     


      Creates from an array of
      wxAcceleratorEntry
      objects.
     
    
.SS  wxAcceleratorTable (const wxString& resource)

     


      Loads the accelerator table from a Windows resource (Windows only).
     
    
   
  
.SS  ~wxAcceleratorTable ()

     


      Destroys the wxAcceleratorTable object.
     
    
   
  
.SS bool Ok ()

     


      Returns true if the accelerator table is valid.
     
    
   
  
.SS wxAcceleratorTable&  operator = (const wxAcceleratorTable& accel)

     


      Assignment operator. This operator does not copy any data, but instead
      passes a pointer to the data in
      
       accel
      
      and increments a reference counter. It is a fast operation.
     
    
   
  
.SS bool operator == (const wxAcceleratorTable& accel)

     


      Equality operator. This operator tests whether the internal data pointers
      are equal (a fast test).
     
    
   
  
.SS bool operator != (const wxAcceleratorTable& accel)

     


      Inequality operator. This operator tests whether the internal data
      pointers are unequal (a fast test).
     
    
 
.SH EXAMPLE

  
  wxAcceleratorEntry entries[4];
  entries[0].Set(wxACCEL_CTRL,  (int) 'N',     ID_NEW_WINDOW);
  entries[1].Set(wxACCEL_CTRL,  (int) 'X',     wxID_EXIT);
  entries[2].Set(wxACCEL_SHIFT, (int) 'A',     ID_ABOUT);
  entries[3].Set(wxACCEL_NORMAL,  WXK_DELETE,    wxID_CUT);
  wxAcceleratorTable accel(4, entries);
  frame->SetAcceleratorTable(accel);

 
.SH "SEE ALSO"

  wxObject
 
  wxAcceleratorEntry
  wxWindow::SetAcceleratorTable
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.