kicad/include/dialog_helpers.h

176 lines
5.2 KiB
C
Raw Normal View History

/**
* @file dialog_helpers.h
* @brief Helper dialog and control classes.
* @note Due to use of wxFormBuilder to create dialogs many of them should be removed.
*/
2010-11-18 21:16:28 +00:00
2012-03-19 20:57:19 +00:00
#ifndef DIALOG_HELPERS_H_
#define DIALOG_HELPERS_H_
2010-11-18 21:16:28 +00:00
#include <common.h> // EDA_UNITS_T
class EDA_DRAW_FRAME;
2010-11-19 18:50:23 +00:00
/**
* class EDA_LIST_DIALOG
2010-11-19 18:50:23 +00:00
*
* Used to display a list of elements for selection, and an help of info line
* about the selected item.
*/
class EDA_LIST_DIALOG : public wxDialog
2010-11-19 18:50:23 +00:00
{
private:
wxListBox* m_listBox;
wxTextCtrl* m_messages;
void (*m_callBackFct)( wxString& Text );
public:
/**
* Constructor:
* @param aParent Pointer to the parent window.
* @param aTitle The title shown on top.
* @param aItemList A wxArrayString of the list of elements.
* @param aRefText An item name if an item must be preselected.
2010-11-19 18:50:23 +00:00
* @param aCallBackFunction callback function to display comments
* @param aPos The position of the dialog.
2010-11-19 18:50:23 +00:00
*/
EDA_LIST_DIALOG( EDA_DRAW_FRAME* aParent, const wxString& aTitle,
const wxArrayString& aItemList, const wxString& aRefText,
void(* aCallBackFunction)(wxString& Text) = NULL,
wxPoint aPos = wxDefaultPosition );
~EDA_LIST_DIALOG();
2010-11-19 18:50:23 +00:00
void SortList();
void Append( const wxString& aItemStr );
void InsertItems( const wxArrayString& aItemList, int aPosition = 0 );
void MoveMouseToOrigin();
wxString GetTextSelection();
private:
void OnClose( wxCloseEvent& event );
void OnCancelClick( wxCommandEvent& event );
void OnOkClick( wxCommandEvent& event );
void ClickOnList( wxCommandEvent& event );
void D_ClickOnList( wxCommandEvent& event );
void OnKeyEvent( wxKeyEvent& event );
DECLARE_EVENT_TABLE()
};
/**
* Class EDA_GRAPHIC_TEXT_CTRL
* is a custom text edit control to edit/enter Kicad dimensions ( INCHES or MM )
*/
class EDA_GRAPHIC_TEXT_CTRL
2010-11-18 21:16:28 +00:00
{
public:
EDA_UNITS_T m_UserUnit;
2010-11-18 21:16:28 +00:00
wxTextCtrl* m_FrameText;
wxTextCtrl* m_FrameSize;
private:
wxStaticText* m_Title;
public:
EDA_GRAPHIC_TEXT_CTRL( wxWindow* parent, const wxString& Title,
const wxString& TextToEdit, int textsize,
EDA_UNITS_T user_unit, wxBoxSizer* BoxSizer, int framelen = 200 );
2010-11-18 21:16:28 +00:00
~EDA_GRAPHIC_TEXT_CTRL();
2010-11-18 21:16:28 +00:00
const wxString GetText() const;
2010-11-18 21:16:28 +00:00
int GetTextSize();
void Enable( bool state );
void SetTitle( const wxString& title );
void SetFocus() { m_FrameText->SetFocus(); }
2010-11-18 21:16:28 +00:00
void SetValue( const wxString& value );
void SetValue( int value );
/**
* Function FormatSize
* formats a string containing the size in the desired units.
*/
static wxString FormatSize( EDA_UNITS_T user_unit, int textSize );
2010-11-18 21:16:28 +00:00
static int ParseSize( const wxString& sizeText, EDA_UNITS_T user_unit );
2010-11-18 21:16:28 +00:00
};
/**************************************************************************/
/* Class to edit/enter a coordinate (pair of values) ( INCHES or MM ) in */
/* dialog boxes, */
/**************************************************************************/
class EDA_POSITION_CTRL
2010-11-18 21:16:28 +00:00
{
public:
EDA_UNITS_T m_UserUnit;
2010-11-18 21:16:28 +00:00
wxPoint m_Pos_To_Edit;
wxTextCtrl* m_FramePosX;
wxTextCtrl* m_FramePosY;
private:
wxStaticText* m_TextX, * m_TextY;
public:
EDA_POSITION_CTRL( wxWindow* parent, const wxString& title,
const wxPoint& pos_to_edit, EDA_UNITS_T user_unit, wxBoxSizer* BoxSizer );
2010-11-18 21:16:28 +00:00
~EDA_POSITION_CTRL();
2010-11-18 21:16:28 +00:00
void Enable( bool x_win_on, bool y_win_on );
void SetValue( int x_value, int y_value );
wxPoint GetValue();
};
/*************************************************************
* Class to edit/enter a size (pair of values for X and Y size)
* ( INCHES or MM ) in dialog boxes
***************************************************************/
class EDA_SIZE_CTRL : public EDA_POSITION_CTRL
2010-11-18 21:16:28 +00:00
{
public:
EDA_SIZE_CTRL( wxWindow* parent, const wxString& title,
const wxSize& size_to_edit, EDA_UNITS_T user_unit, wxBoxSizer* BoxSizer );
2010-11-18 21:16:28 +00:00
~EDA_SIZE_CTRL() { }
2010-11-18 21:16:28 +00:00
wxSize GetValue();
};
/****************************************************************/
/* Class to edit/enter a value ( INCHES or MM ) in dialog boxes */
/****************************************************************/
class EDA_VALUE_CTRL
2010-11-18 21:16:28 +00:00
{
public:
EDA_UNITS_T m_UserUnit;
2010-11-18 21:16:28 +00:00
int m_Value;
wxTextCtrl* m_ValueCtrl;
private:
wxStaticText* m_Text;
public:
EDA_VALUE_CTRL( wxWindow* parent, const wxString& title, int value,
EDA_UNITS_T user_unit, wxBoxSizer* BoxSizer );
2010-11-18 21:16:28 +00:00
~EDA_VALUE_CTRL();
2010-11-18 21:16:28 +00:00
int GetValue();
void SetValue( int new_value );
void Enable( bool enbl );
void SetToolTip( const wxString& text )
{
m_ValueCtrl->SetToolTip( text );
}
};
2012-03-19 20:57:19 +00:00
#endif // DIALOG_HELPERS_H_