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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "stockitem.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/wxchar.h"
  21 #include "wx/string.h"
  22
  23 // ----------------------------------------------------------------------------
  24 // Helper functions for stock items handling:
  25 // ----------------------------------------------------------------------------
  26
  27 // Returns true if the ID is in the list of recognized stock actions
  28 WXDLLEXPORT bool wxIsStockID(wxWindowID id);
  29
  30 // Returns true of the label is empty or label of a stock button with
  31 // given ID
  32 WXDLLEXPORT bool wxIsStockLabel(wxWindowID id, const wxString& label);
  33
  34 // Returns label that should be used for given stock UI element (e.g. "&OK"
  35 // for wxSTOCK_OK):
  36 WXDLLEXPORT wxString wxGetStockLabel(wxWindowID id,
  37                                      bool withCodes = true,
  38                                      wxString accelerator = wxEmptyString);
  39
  40 #ifdef __WXGTK20__
  41 // Translates stock ID to GTK+'s stock item string indentifier:
  42 WXDLLEXPORT const char *wxGetStockGtkID(wxWindowID id);
  43 #endif
  44
  45 #endif // _WX_STOCKITEM_H_