include/wx/stockitem.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/stockitem.h
   3 // Purpose:     stock items helpers (privateh header)
   4 // Author:      Vaclav Slavik
   5 // Modified by:
   6 // Created:     2004-08-15
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vaclav Slavik, 2004
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_STOCKITEM_H_
  13 #define _WX_STOCKITEM_H_
  14
  15 #include "wx/defs.h"
  16 #include "wx/wxchar.h"
  17 #include "wx/string.h"
  18
  19 // ----------------------------------------------------------------------------
  20 // Helper functions for stock items handling:
  21 // ----------------------------------------------------------------------------
  22
  23 // Returns true if the ID is in the list of recognized stock actions
  24 WXDLLEXPORT bool wxIsStockID(wxWindowID id);
  25
  26 // Returns true of the label is empty or label of a stock button with
  27 // given ID
  28 WXDLLEXPORT bool wxIsStockLabel(wxWindowID id, const wxString& label);
  29
  30 // Returns label that should be used for given stock UI element (e.g. "&OK"
  31 // for wxSTOCK_OK):
  32 WXDLLEXPORT wxString wxGetStockLabel(wxWindowID id,
  33                                      bool withCodes = true,
  34                                      const wxString& accelerator = wxEmptyString);
  35
  36 #ifdef __WXGTK20__
  37 // Translates stock ID to GTK+'s stock item string indentifier:
  38 WXDLLEXPORT const char *wxGetStockGtkID(wxWindowID id);
  39 #endif
  40
  41 #endif // _WX_STOCKITEM_H_