finalcut/src/fbuttongroup.h

// File: fbuttongroup.h
// Provides: class FButtonGroup
//
//  Inheritance diagram
//  ═══════════════════
//
// ▕▔▔▔▔▔▔▔▔▔▏ ▕▔▔▔▔▔▔▔▔▔▏
// ▕ FObject ▏ ▕  FTerm  ▏
// ▕▁▁▁▁▁▁▁▁▁▏ ▕▁▁▁▁▁▁▁▁▁▏
//      ▲           ▲
//      │           │
//      └─────┬─────┘
//            │
//       ▕▔▔▔▔▔▔▔▔▏
//       ▕ FVTerm ▏
//       ▕▁▁▁▁▁▁▁▁▏
//            ▲
//            │
//       ▕▔▔▔▔▔▔▔▔▔▏
//       ▕ FWidget ▏
//       ▕▁▁▁▁▁▁▁▁▁▏
//            ▲
//            │
//     ▕▔▔▔▔▔▔▔▔▔▔▔▔▔▔▏
//     ▕ FButtonGroup ▏
//     ▕▁▁▁▁▁▁▁▁▁▁▁▁▁▁▏

#ifndef _FBUTTONGROUP_H
#define _FBUTTONGROUP_H

#include "fwidget.h"


// class forward declaration
class FToggleButton;

//----------------------------------------------------------------------
// class FButtonGroup
//----------------------------------------------------------------------

#pragma pack(push)
#pragma pack(1)

class FButtonGroup : public FWidget
{
 public:
   // Constructors
   explicit FButtonGroup (FWidget* = 0);
   FButtonGroup (const FString&, FWidget* = 0);

   // Destructor
   virtual ~FButtonGroup();

   // Accessor
   const char*    getClassName() const;
   FToggleButton* getFirstButton();
   FToggleButton* getLastButton();
   FString&       getText();

   // Mutator
   bool           setEnable(bool);
   bool           setEnable();
   bool           unsetEnable();
   bool           setDisable();
   bool           setBorder(bool);
   bool           setBorder();
   bool           unsetBorder();
   void           setText (const FString&);

   // Inquiries
   bool           hasFocusedButton();
   bool           hasCheckedButton();

   // Methods
   void           hide();
   void           insert (FToggleButton*);
   void           remove (FToggleButton*);

   // Event handlers
   void           onMouseDown (FMouseEvent*);
   void           onAccel (FAccelEvent*);
   void           onFocusIn (FFocusEvent*);
   void           onFocusOut (FFocusEvent*);

   // Callback method
   void           cb_buttonToggled (FWidget*, void*);

 protected:
   // Accessor
   uChar          getHotkey();

   // Mutator
   void           setHotkeyAccelerator();

   // Methods
   virtual void   draw();
   void           drawLabel();

 private:
   // Typedef
   typedef std::vector<FToggleButton*> FButtonList;

   // Disable copy constructor
   FButtonGroup (const FButtonGroup&);

   // Disable assignment operator (=)
   FButtonGroup& operator = (const FButtonGroup&);

   // Inquiries
   bool isRadioButton(FToggleButton*) const;

   // Methods
   void init();
   void directFocus();

   // Data Members
   FString     text;
   bool        border;
   FButtonList buttonlist;
};
#pragma pack(pop)


// FButtonGroup inline functions
//----------------------------------------------------------------------
inline const char* FButtonGroup::getClassName() const
{ return "FButtonGroup"; }

//----------------------------------------------------------------------
inline bool FButtonGroup::setEnable()
{ return setEnable(true); }

//----------------------------------------------------------------------
inline bool FButtonGroup::unsetEnable()
{ return setEnable(false); }

//----------------------------------------------------------------------
inline bool FButtonGroup::setDisable()
{ return setEnable(false); }

//----------------------------------------------------------------------
inline bool FButtonGroup::setBorder()
{ return setBorder(true); }

//----------------------------------------------------------------------
inline bool FButtonGroup::unsetBorder()
{ return setBorder(false); }

//----------------------------------------------------------------------
inline FString& FButtonGroup::getText()
{ return text; }

#endif  // _FBUTTONGROUP_H