include/wx/unix/stdpaths.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/unix/stdpaths.h
   3 // Purpose:     wxStandardPaths for Unix systems
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     2004-10-19
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2004 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIX_STDPATHS_H_
  13 #define _WX_UNIX_STDPATHS_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // wxStandardPaths
  17 // ----------------------------------------------------------------------------
  18
  19 class WXDLLIMPEXP_BASE wxStandardPaths : public wxStandardPathsBase
  20 {
  21 public:
  22     // tries to determine the installation prefix automatically (Linux only right
  23     // now) and returns /usr/local if it failed
  24     void DetectPrefix();
  25
  26     // set the program installation directory which is /usr/local by default
  27     //
  28     // under some systems (currently only Linux) the program directory can be
  29     // determined automatically but for portable programs you should always set
  30     // it explicitly
  31     void SetInstallPrefix(const wxString& prefix);
  32
  33     // get the program installation prefix
  34     //
  35     // if the prefix had been previously by SetInstallPrefix, returns that
  36     // value, otherwise calls DetectPrefix()
  37     wxString GetInstallPrefix() const;
  38
  39
  40     // implement base class pure virtuals
  41     virtual wxString GetExecutablePath() const;
  42     virtual wxString GetConfigDir() const;
  43     virtual wxString GetUserConfigDir() const;
  44     virtual wxString GetDataDir() const;
  45     virtual wxString GetLocalDataDir() const;
  46     virtual wxString GetUserDataDir() const;
  47     virtual wxString GetPluginsDir() const;
  48     virtual wxString GetLocalizedResourcesDir(const wxString& lang,
  49                                               ResourceCat category) const;
  50 #ifndef __VMS
  51     virtual wxString GetDocumentsDir() const;
  52 #endif
  53
  54 protected:
  55     // Ctor is protected, use wxStandardPaths::Get() instead of instantiating
  56     // objects of this class directly.
  57     wxStandardPaths() { }
  58
  59 private:
  60     wxString m_prefix;
  61 };
  62
  63 #endif // _WX_UNIX_STDPATHS_H_
  64