// Author: Jaakko Salli
// Modified by:
// Created: 2008-08-23
-// RCS-ID: $Id:
+// RCS-ID: $Id$
// Copyright: (c) Jaakko Salli
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
#include "wx/intl.h"
#endif
-#include <wx/propgrid/propgrid.h>
+#include "wx/propgrid/propgrid.h"
#define PWC_CHILD_SUMMARY_LIMIT 16 // Maximum number of children summarized in a parent property's
#define PWC_CHILD_SUMMARY_CHAR_LIMIT 64 // Character limit of summary field when not editing
+#if wxPG_COMPATIBILITY_1_4
+
+// Used to establish backwards compatiblity
+const char* g_invalidStringContent = "@__TOTALLY_INVALID_STRING__@";
+
+#endif
// -----------------------------------------------------------------------
if ( column == 0 )
text = property->GetLabel();
else if ( column == 1 )
- text = property->GetValueString();
+ text = property->GetValueAsString();
else
text = wxEmptyString;
}
imageOffset = paintdata.m_drawnWidth;
}
- text = property->GetValueString();
+ text = property->GetValueAsString();
// Add units string?
if ( propertyGrid->GetColumnCount() <= 2 )
Init();
}
+void wxPGProperty::InitAfterAdded( wxPropertyGridPageState* pageState,
+ wxPropertyGrid* propgrid )
+{
+ //
+ // Called after property has been added to grid or page
+ // (so propgrid can be NULL, too).
+
+ wxPGProperty* parent = m_parent;
+ bool parentIsRoot = parent->IsKindOf(CLASSINFO(wxPGRootProperty));
+
+ m_parentState = pageState;
+
+#if wxPG_COMPATIBILITY_1_4
+ // Make sure deprecated virtual functions are not implemented
+ wxString s = GetValueAsString( 0xFFFF );
+ wxASSERT_MSG( s == g_invalidStringContent,
+ "Implement ValueToString() instead of GetValueAsString()" );
+#endif
+
+ if ( !parentIsRoot )
+ {
+ m_bgColIndex = parent->m_bgColIndex;
+ m_fgColIndex = parent->m_fgColIndex;
+ }
+
+ // If in hideable adding mode, or if assigned parent is hideable, then
+ // make this one hideable.
+ if (
+ ( !parentIsRoot && parent->HasFlag(wxPG_PROP_HIDDEN) ) ||
+ ( propgrid && (propgrid->HasInternalFlag(wxPG_FL_ADDING_HIDEABLES)) )
+ )
+ SetFlag( wxPG_PROP_HIDDEN );
+
+ // Set custom image flag.
+ int custImgHeight = OnMeasureImage().y;
+ if ( custImgHeight < 0 )
+ {
+ SetFlag(wxPG_PROP_CUSTOMIMAGE);
+ }
+
+ if ( propgrid && (propgrid->HasFlag(wxPG_LIMITED_EDITING)) )
+ SetFlag(wxPG_PROP_NOEDITOR);
+
+ // Make sure parent has some parental flags
+ if ( !parent->HasFlag(wxPG_PROP_PARENTAL_FLAGS) )
+ parent->SetParentalType(wxPG_PROP_MISC_PARENT);
+
+ if ( !IsCategory() )
+ {
+ // This is not a category.
+
+ // Depth.
+ //
+ unsigned char depth = 1;
+ if ( !parentIsRoot )
+ {
+ depth = parent->m_depth;
+ if ( !parent->IsCategory() )
+ depth++;
+ }
+ m_depth = depth;
+ unsigned char greyDepth = depth;
+
+ if ( !parentIsRoot )
+ {
+ wxPropertyCategory* pc;
+
+ if ( parent->IsCategory() )
+ pc = (wxPropertyCategory* ) parent;
+ else
+ // This conditional compile is necessary to
+ // bypass some compiler bug.
+ pc = pageState->GetPropertyCategory(parent);
+
+ if ( pc )
+ greyDepth = pc->GetDepth();
+ else
+ greyDepth = parent->m_depthBgCol;
+ }
+
+ m_depthBgCol = greyDepth;
+ }
+ else
+ {
+ // This is a category.
+
+ // depth
+ unsigned char depth = 1;
+ if ( !parentIsRoot )
+ {
+ depth = parent->m_depth + 1;
+ }
+ m_depth = depth;
+ m_depthBgCol = depth;
+ }
+
+ //
+ // Has initial children
+ if ( GetChildCount() )
+ {
+ FlagType parentalFlags = m_flags & wxPG_PROP_PARENTAL_FLAGS;
+
+ // Check parental flags
+ wxASSERT_MSG( parentalFlags,
+ "Call SetFlag(wxPG_PROP_MISC_PARENT) or"
+ "SetFlag(wxPG_PROP_AGGREGATE) before calling"
+ "wxPGProperty::AddChild()." );
+
+ if ( HasFlag(wxPG_PROP_AGGREGATE) )
+ {
+ // Properties with private children are not expanded by default.
+ SetExpanded(false);
+ }
+ else if ( propgrid && propgrid->HasFlag(wxPG_HIDE_MARGIN) )
+ {
+ // ...unless it cannot be expanded by user and therefore must
+ // remain visible at all times
+ SetExpanded(true);
+ }
+
+ //
+ // Prepare children recursively
+ for ( unsigned int i=0; i<GetChildCount(); i++ )
+ {
+ wxPGProperty* child = Item(i);
+ child->InitAfterAdded(pageState, pageState->GetGrid());
+ }
+
+ if ( propgrid && (propgrid->GetExtraStyle() & wxPG_EX_AUTO_UNSPECIFIED_VALUES) )
+ SetFlagRecursively(wxPG_PROP_AUTO_UNSPECIFIED, true);
+ }
+}
+
wxPGProperty::wxPGProperty()
: wxObject()
{
return wxEmptyString;
}
-void wxPGProperty::GenerateComposedValue( wxString& text, int argFlags ) const
+void wxPGProperty::DoGenerateComposedValue( wxString& text,
+ int argFlags,
+ const wxVariantList* valueOverrides,
+ wxPGHashMapS2S* childResults ) const
{
int i;
int iMax = m_children.size();
wxPGProperty* curChild = m_children[0];
+ bool overridesLeft = false;
+ wxVariant overrideValue;
+ wxVariantList::const_iterator node;
+
+ if ( valueOverrides )
+ {
+ node = valueOverrides->begin();
+ if ( node != valueOverrides->end() )
+ {
+ overrideValue = *node;
+ overridesLeft = true;
+ }
+ }
+
for ( i = 0; i < iMax; i++ )
{
+ wxVariant childValue;
+
+ wxString childLabel = curChild->GetLabel();
+
+ // Check for value override
+ if ( overridesLeft && overrideValue.GetName() == childLabel )
+ {
+ if ( !overrideValue.IsNull() )
+ childValue = overrideValue;
+ else
+ childValue = curChild->GetValue();
+ node++;
+ if ( node != valueOverrides->end() )
+ overrideValue = *node;
+ else
+ overridesLeft = false;
+ }
+ else
+ {
+ childValue = curChild->GetValue();
+ }
+
wxString s;
- if ( !curChild->IsValueUnspecified() )
- s = curChild->GetValueString(argFlags|wxPG_COMPOSITE_FRAGMENT);
+ if ( !childValue.IsNull() )
+ {
+ if ( overridesLeft &&
+ curChild->HasFlag(wxPG_PROP_COMPOSED_VALUE) &&
+ childValue.GetType() == wxPG_VARIANT_TYPE_LIST )
+ {
+ wxVariantList& childList = childValue.GetList();
+ DoGenerateComposedValue(s, argFlags|wxPG_COMPOSITE_FRAGMENT,
+ &childList, childResults);
+ }
+ else
+ {
+ s = curChild->ValueToString(childValue,
+ argFlags|wxPG_COMPOSITE_FRAGMENT);
+ }
+ }
+
+ if ( childResults && curChild->GetChildCount() )
+ (*childResults)[curChild->GetName()] = s;
bool skip = false;
if ( (argFlags & wxPG_UNEDITABLE_COMPOSITE_FRAGMENT) && !s.length() )
text += wxS("; ...");
}
-wxString wxPGProperty::GetValueAsString( int argFlags ) const
+wxString wxPGProperty::ValueToString( wxVariant& WXUNUSED(value),
+ int argFlags ) const
{
wxCHECK_MSG( GetChildCount() > 0,
wxString(),
- wxT("If user property does not have any children, it must override GetValueAsString") );
+ "If user property does not have any children, it must "
+ "override GetValueAsString" );
+
+ // FIXME: Currently code below only works if value is actually m_value
+ wxASSERT_MSG( argFlags & wxPG_VALUE_IS_CURRENT,
+ "Sorry, currently default wxPGProperty::ValueToString() "
+ "implementation only works if value is m_value." );
wxString text;
- GenerateComposedValue(text, argFlags);
+ DoGenerateComposedValue(text, argFlags);
return text;
}
-wxString wxPGProperty::GetValueString( int argFlags ) const
+wxString wxPGProperty::GetValueAsString( int argFlags ) const
{
+#if wxPG_COMPATIBILITY_1_4
+ // This is backwards compatibility test
+ // That is, to make sure this function is not overridden
+ // (instead, ValueToString() should be).
+ if ( argFlags == 0xFFFF )
+ {
+ // Do not override! (for backwards compliancy)
+ return g_invalidStringContent;
+ }
+#endif
+
if ( IsValueUnspecified() )
return wxEmptyString;
if ( m_commonValue == -1 )
- return GetValueAsString(argFlags);
+ {
+ wxVariant value(GetValue());
+ return ValueToString(value, argFlags|wxPG_VALUE_IS_CURRENT);
+ }
//
// Return common value's string representation
}
}
+wxString wxPGProperty::GetValueString( int argFlags ) const
+{
+ return GetValueAsString(argFlags);
+}
+
bool wxPGProperty::IntToValue( wxVariant& variant, int number, int WXUNUSED(argFlags) ) const
{
variant = (long)number;
wxVariantList temp_list;
wxVariant list(temp_list);
- int propagatedFlags = argFlags & wxPG_REPORT_ERROR;
+ int propagatedFlags = argFlags & (wxPG_REPORT_ERROR|wxPG_PROGRAMMATIC_VALUE);
#ifdef __WXDEBUG__
bool debug_print = false;
if ( !addOnlyIfNotEmpty || len > 0 )
{
const wxPGProperty* child = Item(curChild);
+ wxVariant variant(child->GetValue());
+ variant.SetName(child->GetBaseName());
+
#ifdef __WXDEBUG__
if ( debug_print )
wxLogDebug(wxT("token = '%s', child = %s"),token.c_str(),child->GetLabel().c_str());
#endif
- if ( len > 0 )
+ // Add only if editable or setting programmatically
+ if ( (argFlags & wxPG_PROGRAMMATIC_VALUE) ||
+ !child->HasFlag(wxPG_PROP_DISABLED|wxPG_PROP_READONLY) )
{
- bool wasUnspecified = child->IsValueUnspecified();
-
- wxVariant variant(child->GetValueRef());
- if ( child->StringToValue(variant, token, propagatedFlags|wxPG_COMPOSITE_FRAGMENT) )
+ if ( len > 0 )
{
- variant.SetName(child->GetBaseName());
+ bool wasUnspecified = child->IsValueUnspecified();
- // Clear unspecified flag only if OnSetValue() didn't
- // affect it.
- if ( child->IsValueUnspecified() &&
- (wasUnspecified || !UsesAutoUnspecified()) )
+ if ( child->StringToValue(variant, token, propagatedFlags|wxPG_COMPOSITE_FRAGMENT) )
{
- variant = child->GetDefaultValue();
- }
+ // Clear unspecified flag only if OnSetValue() didn't
+ // affect it.
+ if ( child->IsValueUnspecified() &&
+ (wasUnspecified || !UsesAutoUnspecified()) )
+ {
+ variant = child->GetDefaultValue();
+ }
- list.Append(variant);
+ list.Append(variant);
+ changed = true;
+ }
+ }
+ else
+ {
+ // Empty, becomes unspecified
+ variant.MakeNull();
+ list.Append(variant);
changed = true;
}
}
- else
- {
- // Empty, becomes unspecified
- wxVariant variant2;
- variant2.SetName(child->GetBaseName());
- list.Append(variant2);
- changed = true;
- }
curChild++;
if ( curChild >= iMax )
wxVariant oldChildValue = child->GetValue();
wxVariant variant(oldChildValue);
- bool stvRes = child->StringToValue( variant, token, propagatedFlags );
- if ( stvRes || (variant != oldChildValue) )
+
+ if ( (argFlags & wxPG_PROGRAMMATIC_VALUE) ||
+ !child->HasFlag(wxPG_PROP_DISABLED|wxPG_PROP_READONLY) )
{
- if ( stvRes )
+ bool stvRes = child->StringToValue( variant, token, propagatedFlags );
+ if ( stvRes || (variant != oldChildValue) )
+ {
+ if ( stvRes )
+ changed = true;
+ }
+ else
+ {
+ // Failed, becomes unspecified
+ variant.MakeNull();
changed = true;
- }
- else
- {
- // Failed, becomes unspecified
- variant.MakeNull();
- changed = true;
+ }
}
variant.SetName(child->GetBaseName());
const wxPGEditor* wxPGProperty::DoGetEditorClass() const
{
- return wxPG_EDITOR(TextCtrl);
+ return wxPGEditor_TextCtrl;
}
// Default extra property event handling - that is, none at all.
void wxPGProperty::SetValue( wxVariant value, wxVariant* pList, int flags )
{
+ // If auto unspecified values are not wanted (via window or property style),
+ // then get default value instead of wxNullVariant.
+ if ( value.IsNull() && (flags & wxPG_SETVAL_BY_USER) &&
+ !UsesAutoUnspecified() )
+ {
+ value = GetDefaultValue();
+ }
+
if ( !value.IsNull() )
{
wxVariant tempListVariant;
{
// TextCtrlAndButton -> ComboBoxAndButton
if ( editor->IsKindOf(CLASSINFO(wxPGTextCtrlAndButtonEditor)) )
- editor = wxPG_EDITOR(ChoiceAndButton);
+ editor = wxPGEditor_ChoiceAndButton;
// TextCtrl -> ComboBox
else if ( editor->IsKindOf(CLASSINFO(wxPGTextCtrlEditor)) )
- editor = wxPG_EDITOR(ComboBox);
+ editor = wxPGEditor_ComboBox;
}
return editor;
return false;
}
-bool wxPGProperty::PrepareValueForDialogEditing( wxPropertyGrid* propGrid )
-{
- return propGrid->EditorValidate();
-}
-
-
bool wxPGProperty::RecreateEditor()
{
wxPropertyGrid* pg = GetGrid();
else
{
m_children.insert( m_children.begin()+index, prop);
- if ( correct_mode ) FixIndexesOfChildren( index );
+ if ( correct_mode ) FixIndicesOfChildren( index );
}
prop->m_parent = this;
}
-void wxPGProperty::FixIndexesOfChildren( size_t starthere )
+void wxPGProperty::FixIndicesOfChildren( unsigned int starthere )
{
size_t i;
for ( i=starthere;i<GetChildCount();i++)
!parent->IsCategory() && !parent->IsRoot() )
{
wxString s;
- parent->GenerateComposedValue(s, 0);
+ parent->DoGenerateComposedValue(s);
parent->m_value = s;
return parent->UpdateParentValues();
}
return true;
}
-// Call for after sub-properties added with AddChild
-void wxPGProperty::PrepareSubProperties()
-{
- wxPropertyGridPageState* state = GetParentState();
-
- wxASSERT(state);
-
- if ( !GetChildCount() )
- return;
-
- wxByte depth = m_depth + 1;
- wxByte depthBgCol = m_depthBgCol;
-
- FlagType inheritFlags = m_flags & wxPG_INHERITED_PROPFLAGS;
-
- wxByte bgColIndex = m_bgColIndex;
- wxByte fgColIndex = m_fgColIndex;
-
- //
- // Set some values to the children
- //
- size_t i = 0;
- wxPGProperty* nparent = this;
-
- while ( i < nparent->GetChildCount() )
- {
- wxPGProperty* np = nparent->Item(i);
-
- np->m_parentState = state;
- np->m_flags |= inheritFlags; // Hideable also if parent.
- np->m_depth = depth;
- np->m_depthBgCol = depthBgCol;
- np->m_bgColIndex = bgColIndex;
- np->m_fgColIndex = fgColIndex;
-
- // Also handle children of children
- if ( np->GetChildCount() > 0 )
- {
- nparent = np;
- i = 0;
-
- // Init
- nparent->SetParentalType(wxPG_PROP_AGGREGATE);
- nparent->SetExpanded(false);
- depth++;
- }
- else
- {
- // Next sibling
- i++;
- }
-
- // After reaching last sibling, go back to processing
- // siblings of the parent
- while ( i >= nparent->GetChildCount() )
- {
- // Exit the loop when top parent hit
- if ( nparent == this )
- break;
-
- depth--;
-
- i = nparent->GetIndexInParent() + 1;
- nparent = nparent->GetParent();
- }
- }
-}
-
// Call after fixed sub-properties added/removed after creation.
// if oldSelInd >= 0 and < new max items, then selection is
// moved to it. Note: oldSelInd -2 indicates that this property
wxPropertyGridPageState* state = GetParentState();
wxPropertyGrid* grid = state->GetGrid();
- PrepareSubProperties();
+ //
+ // Re-repare children (recursively)
+ for ( unsigned int i=0; i<GetChildCount(); i++ )
+ {
+ wxPGProperty* child = Item(i);
+ child->InitAfterAdded(state, grid);
+ }
wxPGProperty* sel = (wxPGProperty*) NULL;
if ( oldSelInd >= (int)m_children.size() )
}
-wxString wxPropertyCategory::GetValueAsString( int ) const
+wxString wxPropertyCategory::ValueToString( wxVariant& WXUNUSED(value),
+ int WXUNUSED(argFlags) ) const
{
return wxEmptyString;
}
projects / wxWidgets.git / blobdiff