fluxbox/util/fbrun/FbRun.hh

// FbRun.hh
// Copyright (c) 2002 Henrik Kinnunen (fluxgen@linuxmail.org)
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

// $Id: FbRun.hh,v 1.11 2003/07/25 11:17:41 rathnor Exp $

#ifndef FBRUN_HH
#define FBRUN_HH

#include "EventHandler.hh"
#include "Font.hh"
#include "FbWindow.hh"

#include <string>
#include <vector>

/**
   Creates and managed a run window
*/
class FbRun: public FbTk::EventHandler {
public:
    FbRun(int x = 0, int y = 0, size_t width = 200);
    ~FbRun();
    void handleEvent(XEvent * const ev);
    void setText(const std::string &text);
    void setTitle(const std::string &title);
    void move(int x, int y);
    void resize(size_t width, size_t height);
    size_t height() const { return m_win.height(); }
    size_t width() const { return m_win.width(); }
    /// hide window
    void hide();
    /// show window
    void show();
    /// load and reconfigure for new font
    bool loadFont(const std::string &fontname);
    void setForeground(const FbTk::Color &color);
    void setBackground(const FbTk::Color &color);
    void setAntialias(bool val) { m_font.setAntialias(val); }
    const FbTk::Font &font() const { return m_font; }
    /// execute command and exit
    void run(const std::string &execstring);
    /// is this application done?
    bool end() const { return m_end; }
    /**
       loads history file.
       @return true on success, else false
    */
    bool loadHistory(const char *filename);
    /**
       @name events
    */
    ///@{
    void exposeEvent(XExposeEvent &ev);
    void keyPressEvent(XKeyEvent &ev);
    ///@}

private:
    void nextHistoryItem();
    void prevHistoryItem();
    void cursorLeft();
    void cursorRight();
    void drawString(int x, int y, const char *text, size_t len);
    void getSize(size_t &width, size_t &height);
    void createWindow(int x, int y, size_t width, size_t height);
    void redrawLabel();
    /// set no maximizable for this window
    void setNoMaximize();

    void cursorHome();
    void cursorEnd();
    void backspace();
    void deleteForward();
    void killToEnd();
    void insertCharacter(KeySym ks, char *keychar);
    void adjustStartPos();
    void adjustEndPos();
    void firstHistoryItem();
    void lastHistoryItem();
    void tabCompleteHistory();

    FbTk::Font m_font; ///< font used to draw command text
    Display *m_display;  ///< display connection
    FbTk::FbWindow m_win;  ///< toplevel window 
    std::string m_runtext; ///< command to execute
    int m_bevel; ///< distance to window edge from font in pixels
    GC m_gc; ///< graphic context
    bool m_end; ///< marks when this object is done
    std::vector<std::string> m_history; ///< history list of commands
    size_t m_current_history_item; ///< holds current position in command history
    std::string m_history_file; ///< holds filename for command history file
    Cursor m_cursor;

    int m_start_pos; ///< start position of portion of text to display
    int m_cursor_pos; ///< relative to m_start_pos
    int m_end_pos; ///< end postition of portion of text to display

};

#endif // FBRUN_HH