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