/////////////////////////////////////////////////////////////////////////////
-// Name: wx/propgeid/propgridiface.h
+// Name: wx/propgrid/propgridiface.h
// Purpose: wxPropertyGridInterface class
// Author: Jaakko Salli
// Modified by:
// Created: 2008-08-24
-// RCS-ID: $Id$
// Copyright: (c) Jaakko Salli
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef __WX_PROPGRID_PROPGRIDIFACE_H__
#define __WX_PROPGRID_PROPGRIDIFACE_H__
+#include "wx/defs.h"
+
#if wxUSE_PROPGRID
#include "wx/propgrid/property.h"
// -----------------------------------------------------------------------
-#ifndef SWIG
-
/** @section wxPGPropArgCls
Most property grid functions have this type as their argument, as it can
class WXDLLIMPEXP_PROPGRID wxPGPropArgCls
{
public:
- wxPGPropArgCls() { }
wxPGPropArgCls( const wxPGProperty* property )
{
m_ptr.property = (wxPGProperty*) property;
m_ptr.charName = str;
m_flags = IsCharPtr;
}
-#if wxUSE_WCHAR_T
wxPGPropArgCls( const wchar_t* str )
{
m_ptr.wcharName = str;
m_flags = IsWCharPtr;
}
-#endif
/** This constructor is required for NULL. */
wxPGPropArgCls( int )
{
{
wxPGProperty* property;
const char* charName;
-#if wxUSE_WCHAR_T
const wchar_t* wcharName;
-#endif
const wxString* stringName;
} m_ptr;
unsigned char m_flags;
};
-#endif
-
typedef const wxPGPropArgCls& wxPGPropArg;
// -----------------------------------------------------------------------
@return Returns @true if successful or if there was no selection. May
fail if validation was enabled and active editor had invalid
value.
+
+ @remarks In wxPropertyGrid 1.4, this member function used to send
+ wxPG_EVT_SELECTED. In wxWidgets 2.9 and later, it no longer
+ does that.
*/
- bool ClearSelection( bool validation = false);
+ bool ClearSelection( bool validation = false );
/** Resets modified status of all properties.
*/
bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
/**
- Deletes a property by id. If category is deleted, all children are
- automatically deleted as well.
- */
+ Removes and deletes a property and any children.
+
+ @param id
+ Pointer or name of a property.
+
+ @remarks If you delete a property in a wxPropertyGrid event
+ handler, the actual deletion is postponed until the next
+ idle event.
+
+ This functions deselects selected property, if any.
+ Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not
+ respected, ie. selection is cleared even if editor had
+ invalid value.
+ */
void DeleteProperty( wxPGPropArg id );
/**
- Removes and returns a property.
+ Removes a property. Does not delete the property object, but
+ instead returns it.
@param id
Pointer or name of a property.
@remarks Removed property cannot have any children.
+
+ Also, if you remove property in a wxPropertyGrid event
+ handler, the actual removal is postponed until the next
+ idle event.
*/
wxPGProperty* RemoveProperty( wxPGPropArg id );
- /** Disables property. */
+ /**
+ Disables a property.
+
+ @see EnableProperty(), wxPGProperty::Enable()
+ */
bool DisableProperty( wxPGPropArg id ) { return EnableProperty(id,false); }
/**
/**
Enables or disables property, depending on whether enable is true or
- false.
+ false. Disabled property usually appears as having grey text.
+
+ @param id
+ Name or pointer to a property.
+ @param enable
+ If @false, property is disabled instead.
+
+ @see wxPGProperty::Enable()
*/
bool EnableProperty( wxPGPropArg id, bool enable = true );
If there is no property with such name, @NULL pointer is returned.
@remarks Properties which have non-category, non-root parent
- can not be accessed globally by their name. Instead, use
+ cannot be accessed globally by their name. Instead, use
"<property>.<subproperty>" instead of "<subproperty>".
*/
wxPGProperty* GetProperty( const wxString& name ) const
return m_pState->GetPropertyCategory(p);
}
-#ifndef SWIG
/** Returns client data (void*) of a property. */
void* GetPropertyClientData( wxPGPropArg id ) const
{
wxPG_PROP_ARG_CALL_PROLOG_RETVAL(NULL)
return p->GetClientData();
}
-#endif
/**
Returns first property which label matches given string.
{
return (unsigned long) GetPropertyValueAsLong(id);
}
-#ifndef SWIG
int GetPropertyValueAsInt( wxPGPropArg id ) const
{ return (int)GetPropertyValueAsLong(id); }
-#endif
bool GetPropertyValueAsBool( wxPGPropArg id ) const;
double GetPropertyValueAsDouble( wxPGPropArg id ) const;
}
#endif
-#ifndef SWIG
/** Returns a wxVariant list containing wxVariant versions of all
property values. Order is not guaranteed.
@param flags
{
return m_pState->DoGetPropertyValues(listname, baseparent, flags);
}
-#endif
- /** Returns currently selected property. */
- wxPGProperty* GetSelection() const
+ /**
+ Returns currently selected property. NULL if none.
+
+ @remarks When wxPG_EX_MULTIPLE_SELECTION extra style is used, this
+ member function returns the focused property, that is the
+ one which can have active editor.
+ */
+ wxPGProperty* GetSelection() const;
+
+ /**
+ Returns list of currently selected properties.
+
+ @remarks wxArrayPGProperty should be compatible with std::vector API.
+ */
+ const wxArrayPGProperty& GetSelectedProperties() const
{
- return m_pState->GetSelection();
+ return m_pState->m_selection;
}
-#ifndef SWIG
wxPropertyGridPageState* GetState() const { return m_pState; }
-#endif
/** Similar to GetIterator(), but instead returns wxPGVIterator instance,
which can be useful for forward-iterating through arbitrary property
return ( (p->GetFlags() & wxPG_PROP_MODIFIED) ? true : false );
}
+ /**
+ Returns true if property is selected.
+ */
+ bool IsPropertySelected( wxPGPropArg id ) const
+ {
+ wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
+ return m_pState->DoIsPropertySelected(p);
+ }
+
/**
Returns true if property is shown (ie hideproperty with true not
called for it).
- */
+ */
bool IsPropertyShown( wxPGPropArg id ) const
{
wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
wxString SaveEditableState( int includedStates = AllStates ) const;
/**
- Lets user to set the strings listed in the choice dropdown of a
+ Lets user set the strings listed in the choice dropdown of a
wxBoolProperty. Defaults are "True" and "False", so changing them to,
say, "Yes" and "No" may be useful in some less technical applications.
*/
static void SetBoolChoices( const wxString& trueChoice,
const wxString& falseChoice );
+ /**
+ Set proportion of a auto-stretchable column. wxPG_SPLITTER_AUTO_CENTER
+ window style needs to be used to indicate that columns are auto-
+ resizable.
+
+ @returns Returns @false on failure.
+
+ @remarks You should call this for individual pages of
+ wxPropertyGridManager (if used).
+
+ @see GetColumnProportion()
+ */
+ bool SetColumnProportion( unsigned int column, int proportion );
+
+ /**
+ Returns auto-resize proportion of the given column.
+
+ @see SetColumnProportion()
+ */
+ int GetColumnProportion( unsigned int column ) const
+ {
+ return m_pState->DoGetColumnProportion(column);
+ }
+
/** Sets an attribute for this property.
@param name
Text identifier of attribute. See @ref propgrid_property_attributes.
@param colour
New background colour.
- @param recursively
- If True, child properties are affected recursively. Property
- categories are skipped if this flag is used.
+ @param flags
+ Default is wxPG_RECURSE which causes colour to be set recursively.
+ Omit this flag to only set colour for the property in question
+ and not any of its children.
*/
void SetPropertyBackgroundColour( wxPGPropArg id,
const wxColour& colour,
- bool recursively = true );
+ int flags = wxPG_RECURSE );
/** Resets text and background colours of given property.
*/
@param colour
New background colour.
- @param recursively
- If True, child properties are affected recursively. Property
- categories are skipped if this flag is used.
+ @param flags
+ Default is wxPG_RECURSE which causes colour to be set recursively.
+ Omit this flag to only set colour for the property in question
+ and not any of its children.
*/
void SetPropertyTextColour( wxPGPropArg id,
const wxColour& col,
- bool recursively = true );
+ int flags = wxPG_RECURSE );
/**
Returns background colour of first cell of a property.
const wxColour& fgCol = wxNullColour,
const wxColour& bgCol = wxNullColour );
-#ifndef SWIG
/** Sets client data (void*) of a property.
@remarks
This untyped client data has to be deleted manually.
p->SetEditor(editor);
RefreshProperty(p);
}
-#endif
/** Sets editor control of a property. As editor argument, use
editor name string, such as "TextCtrl" or "Choice".
void SetPropertyValueUnspecified( wxPGPropArg id )
{
wxPG_PROP_ARG_CALL_PROLOG()
- wxVariant nullVariant;
- SetPropVal(p, nullVariant);
+ p->SetValueToUnspecified();
}
-#ifndef SWIG
/**
Sets property values from a list of wxVariants.
*/
{
SetPropertyValues(list.GetList(),defaultCategory);
}
-#endif
/** Associates the help string with property.
@remarks
}
#endif
-#ifndef SWIG
/** Sets value (long integer) of a property.
*/
void SetPropertyValue( wxPGPropArg id, long value )
wxVariant v(value);
SetPropVal( id, v );
}
-#if wxUSE_WCHAR_T
void SetPropertyValue( wxPGPropArg id, const wchar_t* value )
{
SetPropertyValueString( id, wxString(value) );
}
-#endif
void SetPropertyValue( wxPGPropArg id, const char* value )
{
SetPropertyValueString( id, wxString(value) );
wxVariant v = WXVARIANT(value);
SetPropVal( id, v );
}
-#endif // !SWIG
/** Sets value (wxString) of a property.
SetPropVal( id, value );
}
-#ifndef SWIG
/** Sets value (wxVariant&) of a property. Same as SetPropertyValue, but
accepts reference. */
void SetPropVal( wxPGPropArg id, wxVariant& value );
-#endif
/** Adjusts how wxPropertyGrid behaves when invalid value is entered
in a property.
static wxPGEditor* GetEditorByName( const wxString& editorName );
+ // NOTE: This function reselects the property and may cause
+ // excess flicker, so to just call Refresh() on a rect
+ // of single property, call DrawItem() instead.
virtual void RefreshProperty( wxPGProperty* p ) = 0;
protected:
+ bool DoClearSelection( bool validation = false,
+ int selFlags = 0 );
+
/**
In derived class, implement to set editable state component with
given name to given value.
// Default call's m_pState's BaseGetPropertyByName
virtual wxPGProperty* DoGetPropertyByName( const wxString& name ) const;
-#ifndef SWIG
-
// Deriving classes must set this (it must be only or current page).
wxPropertyGridPageState* m_pState;
// Cannot be GetGrid() due to ambiguity issues.
wxPropertyGrid* GetPropertyGrid()
{
+ if ( !m_pState )
+ return NULL;
return m_pState->GetGrid();
}
// Cannot be GetGrid() due to ambiguity issues.
const wxPropertyGrid* GetPropertyGrid() const
{
- return (const wxPropertyGrid*) m_pState->GetGrid();
+ if ( !m_pState )
+ return NULL;
+
+ return m_pState->GetGrid();
}
-#endif // #ifndef SWIG
friend class wxPropertyGrid;
friend class wxPropertyGridManager;
projects / wxWidgets.git / blobdiff