Fl_OpButton.H

Go to the documentation of this file.

#ifndef _FL_OPBUTTON_H_
#define _FL_OPBUTTON_H_

//INSERT-LGPL-HEADER-HERE//


#include <vector>
#include <string>

#include <FL/Fl.H>
#include <FL/Fl_Button.H>
#include <FL/fl_draw.H>

#include "Fl_OpBox.H"

class Fl_OpDesk;
class Fl_OpBox;
class Fl_OpConnect;

enum Fl_OpButtonType {
    FL_OP_INPUT_BUTTON,         
    FL_OP_OUTPUT_BUTTON,        
};


class Fl_OpButton;

// Operation Buttons
//    Manages all the input buttons for Fl_OpBoxes
//
class Fl_OpButton : public Fl_Button {
    Fl_OpButtonType           button_type;      // type of this button (input|output)
    std::vector<Fl_OpButton*> connected_to;     // array of button(s) we're connected to
    int                       dragging;         // used for connection dragging

    // PRIVATE METHODS
    friend class Fl_OpDesk;
    void _RemoveConnect(Fl_OpButton *but);
    int  _ConnectToOnly(Fl_OpButton *but, std::string &errmsg);
    void _DisconnectOnly(Fl_OpButton *but);

public:
    // CTORS
    Fl_OpButton(const char *L, Fl_OpButtonType io);
    ~Fl_OpButton();
    Fl_OpButton(const Fl_OpButton&);

    // FLTK
    void draw();
    int handle(int e);

    // MISC
    Fl_OpButtonType GetButtonType() const;
    int GetMinimumHeight() const;
    int GetMinimumWidth() const;
    std::string GetFullName() const;

    // PARENT ACCESS
    Fl_OpBox *GetOpBox();
    const Fl_OpBox* GetOpBox() const;
    Fl_OpDesk *GetOpDesk();
    const Fl_OpDesk* GetOpDesk() const;

    // CONNECTIONS
    int IsConnected() const;
    int IsConnected(const Fl_OpButton *but) const;
    int ConnectTo(Fl_OpButton *but, std::string &errmsg);
    void Disconnect(Fl_OpButton *but);
    void DisconnectAll();

    Fl_OpButton* GetConnectedButton(size_t index=0);
    const Fl_OpButton* GetConnectedButton(size_t index=0) const;
    size_t GetTotalConnectedButtons() const;
    void GetOutputBoxes(std::vector<Fl_OpBox*> &outboxes);
    Fl_OpConnect* GetConnection(size_t index);

    // VIRTUALS

    virtual int Connecting(Fl_OpButton*, std::string& errmsg) {
        return(0);
    }

    virtual void Disconnecting(Fl_OpButton*) {
        return;
    }

};
#endif /* _FL_OPBUTTON_H_ */