Rhino C++ API  8.5
Public Member Functions | Protected Attributes | List of all members
CRhinoUiOptionsListCtrlEditBox Class Reference

#include <RhinoSdkUiOptionsListCtrlItem.h>

Inheritance diagram for CRhinoUiOptionsListCtrlEditBox:
CRhinoUiEdit CRhinoUiOptionsListCtrlItem CRhinoUiOptionsListCtrlFileNameEditBox

Public Member Functions

 CRhinoUiOptionsListCtrlEditBox (LPCTSTR lpsLabel=NULL, LPCTSTR lpsText=NULL, int iIndentLevel=0)
 
virtual ~CRhinoUiOptionsListCtrlEditBox ()
 
bool BeginEditItem (CRhinoUiOptionsListCtrl &list_ctrl, const CRect rEdit, begin_edit_item_reason eir)
 
void MoveItemWindow (CRhinoUiOptionsListCtrl &list_ctrl, const CRect rEdit)
 
void OnDrawItem (CDC &dc, const CRect &rItem, const CRect &rDeflate) const
 
afx_msg void OnEnChange ()
 
virtual bool OnEndEdit (LPCTSTR lps) const
 
afx_msg void OnEnKillfocus ()
 
afx_msg BOOL32 OnEraseBkgnd (CDC *pDC)
 
afx_msg BOOL32 OnMouseWheel (UINT nFlags, short zDelta, CPoint pt)
 
virtual BOOL32 PreTranslateMessage (MSG *pMsg)
 
void SetNumber (double d)
 
void SetNumber (int i)
 
void SetText (LPCTSTR lps)
 
virtual LRESULT WindowProc (UINT message, WPARAM wParam, LPARAM lParam)
 
- Public Member Functions inherited from CRhinoUiEdit
 CRhinoUiEdit ()
 
virtual ~CRhinoUiEdit ()
 
void DDX_Text (CDataExchange *pDX, int nIDC, double &nValue)
 
void DDX_Text (CDataExchange *pDX, int nIDC, int &nValue)
 
void DDX_Text (CDataExchange *pDX, int nIDC, ON_wString &wValue)
 
int DisplayPrecision () const
 
void Format ()
 
const CString & FormatKeyword () const
 
int GetEditType () const
 
void GetNumericValue (double &d)
 
void GetNumericValue (int &n)
 
CSpinButtonCtrl * GetSpinButtonCtrl () const
 
void GetStringValue (ON_wString &w)
 
bool IncludeSpinner () const
 
void LinkToSliderCtrl (CRhinoUiSliderCtrl *)
 
afx_msg void OnChar (UINT nChar, UINT nRepCnt, UINT nFlags)
 
afx_msg int OnCreate (LPCREATESTRUCT lpCreateStruct)
 
afx_msg void OnDestroy ()
 
afx_msg void OnKillFocus (CWnd *pNewWnd)
 
on_number_error OnNumberErrorMode () const
 
afx_msg void OnSetFocus (CWnd *pOldWnd)
 
afx_msg void OnSize (UINT nType, int cx, int cy)
 
void SetAllowEmpty (bool bSet=true)
 
void SetDisplayPrecision (int precision)
 
int SetEditType (edit_type et)
 
void SetFormatKeyword (const char *lps)
 
void SetFormatKeyword (const wchar_t *lps)
 
bool SetIncludeSpinner (bool b)
 
void SetMax (bool bSet, double nMax=0.0)
 
void SetMax (bool bSet, int nMax=0)
 
void SetMin (bool bSet, double nMin=0.0)
 
void SetMin (bool bSet, int nMin=0)
 
void SetNonZero (bool bSet=TRUE)
 
void SetNumber (double d)
 
void SetNumber (int i)
 
void SetOnNumberErrorMode (on_number_error mode)
 
void SetStringValue (const char *s, bool bAppend=false)
 
void SetStringValue (const wchar_t *w, bool bAppend=false)
 
void SetValue (double nValue)
 
void SetValue (int nValue)
 
ON_wString StringValue ()
 
void SynchSlider ()
 
void VerifyValue (double &nValue)
 
void VerifyValue (int &nValue)
 
- Public Member Functions inherited from CRhinoUiOptionsListCtrlItem
 CRhinoUiOptionsListCtrlItem (const CRhinoUiOptionsListCtrlItem &)
 
 CRhinoUiOptionsListCtrlItem (control_type ct=ct_invalid, LPCTSTR lpsLabel=NULL, LPCTSTR lpsText=NULL, int iIndentLevel=0)
 
virtual ~CRhinoUiOptionsListCtrlItem ()
 
bool AutoDelete () const
 
control_type ControlType () const
 
void DrawItemText (CDC &dc, const CString &s, const CRect &rItem, const CRect &rDeflate) const
 
bool GetItemProperty (item_property iprop) const
 
bool GetItemState (item_state istate) const
 
CRhinoUiOptionsListCtrlGetListCtrl () const
 
int IndentLevel () const
 
bool IsEnabled () const
 
bool IsFullRowItem () const
 
bool IsItemExpandable () const
 
bool IsItemHidden () const
 
bool IsReadOnly () const
 
virtual int ItemHeight () const
 
unsigned int ItemID () const
 
LPCTSTR Label () const
 
COLORREF LabelBackGroundColor () const
 
COLORREF LabelTextColor () const
 
const CRhinoUiOptionsListCtrlItemoperator= (const CRhinoUiOptionsListCtrlItem &)
 
int ParentIndex () const
 
bool SetAutoDelete (bool b)
 
int SetIndentLevel (int iIndentLevel)
 
bool SetIsEnabled (bool b)
 
bool SetIsFullRowItem (bool b)
 
bool SetIsReadOnly (bool b)
 
bool SetItemProperty (item_property iprop, bool bEnabled)
 
bool SetItemState (item_state istate, bool bEnabled)
 
bool SetLabel (LPCTSTR lpsLabel)
 
COLORREF SetLabelBackGroundColor (COLORREF cr)
 
COLORREF SetLabelTextColor (COLORREF cr)
 
bool SetParentIndex (int iItem)
 
bool SetUseLabelColors (bool b)
 
virtual LPCTSTR Text () const
 
bool UseLabelColors () const
 

Protected Attributes

bool m_bCancel
 
int m_edit_state = 0
 
- Protected Attributes inherited from CRhinoUiEdit
bool m_allowemtpy
 
int m_displayprecision
 
int m_edit_type
 
bool m_hasmax
 
bool m_hasmin
 
bool m_include_buddy
 
CString m_key_word
 
CString m_last_good_string
 
double m_lastgoodnumber
 
CRhinoUiSliderCtrlm_linked_slider
 
double m_max
 
double m_min
 
bool m_nonzero
 
on_number_error m_on_number_error
 
- Protected Attributes inherited from CRhinoUiOptionsListCtrlItem
CPoint m_ptEndTrackSelect
 

Additional Inherited Members

- Public Types inherited from CRhinoUiEdit
enum  edit_type {
  et_text = 0, et_int, et_double, et_ip,
  et_invalid, force_32bit_edit_type = 0xFFFFFFFF
}
 
enum  on_number_error { one_use_last_good_number = 0, one_clamp_to_min_max_value, force_32bit_number_error = 0xFFFFFFFF }
 
- Public Types inherited from CRhinoUiOptionsListCtrlItem
enum  control_type {
  ct_static_text = 0, ct_edit_box, ct_check_box, ct_combo_box,
  ct_push_button, ct_ip_address, ct_radio_buttons, ct_color_combo_box,
  ct_color_button, ct_file, ct_font_combo, ct_layer_combo_box,
  ct_linetype_combo_box, ct_print_width_combo_box, ct_separator, ct_folder,
  ct_hyperlink, ct_custom_control, ct_invalid, force_32bit_control_type = 0xFFFFFFFF
}
 
enum  item_property {
  full_row_item_property = 1, use_label_colors_property = 2, is_group_combo_item_property = 4, property0 = 8,
  property1 = 0x10, property2 = 0x20, property3 = 0x40, property4 = 0x80,
  property5 = 0x100, property6 = 0x200, property7 = 0x400, property8 = 0x800,
  property9 = 0x1000, force_32bit_item_property = 0xFFFFFFFF
}
 
enum  item_state {
  expanded_state = 1, hidden_state = 2, enabled_state = 4, readonly_state = 8,
  hidden_group_state = 0x10, state0 = 0x20, state1 = 0x40, state2 = 0x80,
  state3 = 0x100, state4 = 0x200, state5 = 0x400, state6 = 0x800,
  state7 = 0x1000, state8 = 0x2000, state9 = 0x4000, force_32bit_item_state = 0xFFFFFFFF
}
 
- Protected Types inherited from CRhinoUiOptionsListCtrlItem
enum  begin_edit_item_reason {
  eir_label_left_clicked = 0, eir_value_left_clicked, eir_f2_pressed, eir_navigation_key,
  force_32bit_begin_edit_item_reason = 0xFFFFFFFF
}
 
- Protected Member Functions inherited from CRhinoUiEdit
bool CreateBuddy ()
 
void FormatInt ()
 
void FormatReal ()
 
void OnCharInt (UINT nChar, UINT nRepCnt, UINT nFlags)
 
void OnCharReal (UINT nChar, UINT nRepCnt, UINT nFlags)
 
virtual BOOL32 PreCreateWindow (CREATESTRUCT &cs)
 
virtual void PreSubclassWindow ()
 
- Protected Member Functions inherited from CRhinoUiOptionsListCtrlItem
bool ForwardOnMouseWheel (CWnd &wnd, UINT nFlags, short zDelta, CPoint pt)
 
bool SetControlType (control_type ct)
 

Detailed Description


CRhinoUiOptionsListCtrlEditBox

Description: Edit box control. This control can be used to edit string, double or integer values.

Constructor & Destructor Documentation

◆ CRhinoUiOptionsListCtrlEditBox()

CRhinoUiOptionsListCtrlEditBox::CRhinoUiOptionsListCtrlEditBox ( LPCTSTR  lpsLabel = NULL,
LPCTSTR  lpsText = NULL,
int  iIndentLevel = 0 
)

Description: Constructor

Parameters: lpsLabel [in] Label for this item, appears in left column of options list lpsText [in] Text associated with this item, appears in right column of options list

See Also: CRhinoUiOptionsListCtrlItem constructor

◆ ~CRhinoUiOptionsListCtrlEditBox()

virtual CRhinoUiOptionsListCtrlEditBox::~CRhinoUiOptionsListCtrlEditBox ( )
virtual

Description: Destructor

Member Function Documentation

◆ BeginEditItem()

bool CRhinoUiOptionsListCtrlEditBox::BeginEditItem ( CRhinoUiOptionsListCtrl list_ctrl,
const CRect  rEdit,
begin_edit_item_reason  eir 
)
virtual

Description: CRhinoUiOptionsListCtrlItem virtual override

Create CRhinoUiEdit control for editing the Text() value associated with this item.

Parameters: See CRhinoUiOptionsListCtrlItem::BeginEditItem()

Returns: Returns true if edit control was created; otherwise false.

See Also: CRhinoUiOptionsListCtrlItem::BeginEditItem()

Implements CRhinoUiOptionsListCtrlItem.

Reimplemented in CRhinoUiOptionsListCtrlFileNameEditBox.

◆ MoveItemWindow()

void CRhinoUiOptionsListCtrlEditBox::MoveItemWindow ( CRhinoUiOptionsListCtrl list_ctrl,
const CRect  rEdit 
)
virtual

◆ OnDrawItem()

void CRhinoUiOptionsListCtrlEditBox::OnDrawItem ( CDC &  dc,
const CRect &  rItem,
const CRect &  rDeflate 
) const
virtual

Description: CRhinoUiOptionsListCtrlItem override

Reimplemented from CRhinoUiOptionsListCtrlItem.

Reimplemented in CRhinoUiOptionsListCtrlFileNameEditBox.

◆ OnEnChange()

afx_msg void CRhinoUiOptionsListCtrlEditBox::OnEnChange ( )

◆ OnEndEdit()

virtual bool CRhinoUiOptionsListCtrlEditBox::OnEndEdit ( LPCTSTR  lps) const
virtual

Description: This method is called when this edit control looses focus to validate the new control value prior to saving.

Parameters: lps [in] New text value

Returns: Returns true if lps is valid and should be saved; otherwise false.

◆ OnEnKillfocus()

afx_msg void CRhinoUiOptionsListCtrlEditBox::OnEnKillfocus ( )

◆ OnEraseBkgnd()

afx_msg BOOL32 CRhinoUiOptionsListCtrlEditBox::OnEraseBkgnd ( CDC *  pDC)

◆ OnMouseWheel()

afx_msg BOOL32 CRhinoUiOptionsListCtrlEditBox::OnMouseWheel ( UINT  nFlags,
short  zDelta,
CPoint  pt 
)

◆ PreTranslateMessage()

virtual BOOL32 CRhinoUiOptionsListCtrlEditBox::PreTranslateMessage ( MSG *  pMsg)
virtual

◆ SetNumber() [1/2]

void CRhinoUiOptionsListCtrlEditBox::SetNumber ( double  d)

Description: Convert double to string and put string in edit control.

Parameters: d [in] Value to place in edit control

◆ SetNumber() [2/2]

void CRhinoUiOptionsListCtrlEditBox::SetNumber ( int  i)

Description: Convert int to string and put string in edit control.

Parameters: i [in] Value to place in edit control

◆ SetText()

void CRhinoUiOptionsListCtrlEditBox::SetText ( LPCTSTR  lps)
virtual

Description: CRhinoUiOptionsListCtrlItem override

Reimplemented from CRhinoUiOptionsListCtrlItem.

Reimplemented in CRhinoUiOptionsListCtrlFileNameEditBox.

◆ WindowProc()

virtual LRESULT CRhinoUiOptionsListCtrlEditBox::WindowProc ( UINT  message,
WPARAM  wParam,
LPARAM  lParam 
)
virtual

Member Data Documentation

◆ m_bCancel

bool CRhinoUiOptionsListCtrlEditBox::m_bCancel
protected

◆ m_edit_state

int CRhinoUiOptionsListCtrlEditBox::m_edit_state = 0
mutableprotected