libs/gtkmm2ext/gtkmm2ext/window_title.h

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef WINDOW_TITLE_INCLUDED
  21 #define WINDOW_TITLE_INCLUDED
  22
  23 #include <string>
  24
  25 #include "gtkmm2ext/visibility.h"
  26
  27 namespace Gtkmm2ext {
  28
  29 /**
  30  * \class The WindowTitle class can be used to maintain the
  31  * consistancy of window titles between windows and dialogs.
  32  *
  33  * Each string element that is added to the window title will
  34  * be separated by a hyphen.
  35  */
  36 class LIBGTKMM2EXT_API WindowTitle
  37 {
  38 public:
  39
  40         /**
  41          * \param title The first string/element of the window title
  42          * which will may be the application name or the document
  43          * name in a document based application.
  44          */
  45         WindowTitle(const std::string& title);
  46
  47         /**
  48          * Add an string element to the window title.
  49          */
  50         void operator+= (const std::string&);
  51
  52         /// @return The window title string.
  53         const std::string& get_string () { return m_title;}
  54
  55 private:
  56
  57         std::string                         m_title;
  58
  59 };
  60
  61 } // Gtkmm2ext
  62
  63 #endif // WINDOW_TITLE_INCLUDED