// Name: editors.h
// Purpose: interface of wxPropertyGrid editors
// Author: wxWidgets team
-// RCS-ID: $Id:
-// Licence: wxWindows license
+// RCS-ID: $Id$
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-// -----------------------------------------------------------------------
/**
@class wxPGEditor
public:
/** Constructor. */
- wxPGEditor()
- : wxObject()
- {
- m_clientData = NULL;
- }
+ wxPGEditor();
/** Destructor. */
virtual ~wxPGEditor();
/**
Returns pointer to the name of the editor. For example,
- wxPGEditor_TextCtrl has name "TextCtrl".
+ wxPGEditor_TextCtrl has name "TextCtrl". If you dont' need to access
+ your custom editor by string name, then you do not need to implement
+ this function.
*/
- virtual wxString GetName() const = 0;
+ virtual wxString GetName() const;
/**
Instantiates editor controls.
@remarks
- Primary control shall use id wxPG_SUBID1, and secondary (button) control
shall use wxPG_SUBID2.
- - Implementation shoud connect all necessary events to the
- wxPropertyGrid::OnCustomEditorEvent. For Example:
- @code
- // Relays wxEVT_COMMAND_TEXT_UPDATED events of primary editor
- // control to the OnEvent.
- propgrid->Connect(control->GetId(), wxEVT_COMMAND_TEXT_UPDATED,
- wxCommandEventHandler(wxPropertyGrid::OnCustomEditorEvent));
- @endcode
- OnCustomEditorEvent will then forward events, first to
- wxPGEditor::OnEvent() and then to wxPGProperty::OnEvent().
+ - Unlike in previous version of wxPropertyGrid, it is no longer
+ necessary to call wxEvtHandler::Connect() for interesting editor
+ events. Instead, all events from control are now automatically
+ forwarded to wxPGEditor::OnEvent() and wxPGProperty::OnEvent().
*/
virtual wxPGWindowList CreateControls( wxPropertyGrid* propgrid,
wxPGProperty* property,
/**
Handles events. Returns @true if value in control was modified
(see wxPGProperty::OnEvent() for more information).
+
+ @remarks wxPropertyGrid will automatically unfocus the editor when
+ @c wxEVT_COMMAND_TEXT_ENTER is received and when it results in
+ property value being modified. This happens regardless of
+ editor type (ie. behaviour is same for any wxTextCtrl and
+ wxComboBox based editor).
*/
virtual bool OnEvent( wxPropertyGrid* propgrid, wxPGProperty* property,
wxWindow* wnd_primary, wxEvent& event ) const = 0;
Returns @true if value was different.
*/
virtual bool GetValueFromControl( wxVariant& variant, wxPGProperty* property,
- wxWindow* ctrl ) const;
+ wxWindow* ctrl ) const;
/** Sets value in control to unspecified. */
virtual void SetValueToUnspecified( wxPGProperty* property,
- wxWindow* ctrl ) const = 0;
+ wxWindow* ctrl ) const = 0;
+
+ /**
+ Called by property grid to set new appearance for the control.
+ Default implementation sets foreground colour, background colour,
+ font, plus text for wxTextCtrl and wxComboCtrl.
+
+ The parameter @a appearance represents the new appearance to be applied.
+
+ The parameter @a oldAppearance is the previously applied appearance.
+ Used to detect which control attributes need to be changed (e.g. so we only
+ change background colour if really needed).
+
+ Finally, the parameter @a unspecified if @true tells this function that
+ the new appearance represents an unspecified property value.
+ */
+ virtual void SetControlAppearance( wxPropertyGrid* pg,
+ wxPGProperty* property,
+ wxWindow* ctrl,
+ const wxPGCell& appearance,
+ const wxPGCell& oldAppearance,
+ bool unspecified ) const;
/** Sets control's value specifically from string. */
virtual void SetControlStringValue( wxPGProperty* property,
- wxWindow* ctrl, const wxString& txt ) const;
+ wxWindow* ctrl, const wxString& txt ) const;
/** Sets control's value specifically from int (applies to choice etc.). */
virtual void SetControlIntValue( wxPGProperty* property,
- wxWindow* ctrl, int value ) const;
+ wxWindow* ctrl, int value ) const;
/**
Inserts item to existing control. Index -1 means end of list.
Default implementation does nothing. Returns index of item added.
*/
- virtual int InsertItem( wxWindow* ctrl, const wxString& label,
- int index ) const;
+ virtual int InsertItem( wxWindow* ctrl, const wxString& label, int index ) const;
/**
Deletes item from existing control.
virtual void DeleteItem( wxWindow* ctrl, int index ) const;
/**
- Extra processing when control gains focus. For example, wxTextCtrl
- based controls should select all text.
+ Extra processing when control gains focus.
+ For example, wxTextCtrl based controls should select all text.
*/
virtual void OnFocus( wxPGProperty* property, wxWindow* wnd ) const;
/**
- Returns @true if control itself can contain the custom image. Default
- implementation returns @false.
+ Returns @true if control itself can contain the custom image.
+ Default implementation returns @false.
*/
virtual bool CanContainCustomImage() const;
};
-// -----------------------------------------------------------------------
+
/**
@class wxPGMultiButton
For instance, here we add three buttons to a TextCtrl editor:
@code
-
#include <wx/propgrid/editors.h>
class wxSampleMultiButtonEditor : public wxPGTextCtrlEditor
{
- DECLARE_DYNAMIC_CLASS(wxSampleMultiButtonEditor)
+ wxDECLARE_DYNAMIC_CLASS(wxSampleMultiButtonEditor);
+
public:
wxSampleMultiButtonEditor() {}
virtual ~wxSampleMultiButtonEditor() {}
wxEvent& event ) const;
};
- IMPLEMENT_DYNAMIC_CLASS(wxSampleMultiButtonEditor, wxPGTextCtrlEditor)
+ wxIMPLEMENT_DYNAMIC_CLASS(wxSampleMultiButtonEditor, wxPGTextCtrlEditor);
wxPGWindowList wxSampleMultiButtonEditor::CreateControls( wxPropertyGrid* propGrid,
wxPGProperty* property,
if ( event.GetId() == buttons->GetButtonId(0) )
{
- // Do something when first button is pressed
- return true;
+ // Do something when the first button is pressed
+ // Return true if the action modified the value in editor.
+ ...
}
if ( event.GetId() == buttons->GetButtonId(1) )
{
- // Do something when second button is pressed
- return true;
+ // Do something when the second button is pressed
+ ...
}
if ( event.GetId() == buttons->GetButtonId(2) )
{
- // Do something when third button is pressed
- return true;
+ // Do something when the third button is pressed
+ ...
}
}
return wxPGTextCtrlEditor::OnEvent(propGrid, property, ctrl, event);
}
-
@endcode
Further to use this editor, code like this can be used:
@code
-
// Register editor class - needs only to be called once
wxPGEditor* multiButtonEditor = new wxSampleMultiButtonEditor();
wxPropertyGrid::RegisterEditorClass( multiButtonEditor );
// Change property to use editor created in the previous code segment
propGrid->SetPropertyEditor( "MultipleButtons", multiButtonEditor );
-
@endcode
@library{wxpropgrid}
class WXDLLIMPEXP_PROPGRID wxPGMultiButton : public wxWindow
{
public:
-
/**
Constructor.
*/
wxWindow* GetButton( unsigned int i );
/**
- Returns Id of one of the buttons. This is utility function to be
- used in event handlers.
+ Returns Id of one of the buttons.
+ This is utility function to be used in event handlers.
*/
int GetButtonId( unsigned int i ) const;
/**
Returns number of buttons.
*/
- int GetCount();
+ unsigned int GetCount();
/**
Returns size of primary editor control, as appropriately
wxSize GetPrimarySize() const;
};
-// -----------------------------------------------------------------------
projects / wxWidgets.git / blobdiff