diff --git a/Import/GacUI.h b/Import/GacUI.h
index fb119e89..a8ef7015 100644
--- a/Import/GacUI.h
+++ b/Import/GacUI.h
@@ -2071,6 +2071,7 @@ Native Window Services
/// Test is the current thread the main thread.
///
/// Returns true if the current thread is the main thread.
+ /// A window to access the corressponding main thread.
virtual bool IsInMainThread(INativeWindow* window)=0;
///
/// Invoke a specified function with an specified argument asynchronisly.
@@ -2080,12 +2081,14 @@ Native Window Services
///
/// Invoke a specified function with an specified argument in the main thread.
///
+ /// A window to access the corressponding main thread.
/// The specified function.
virtual void InvokeInMainThread(INativeWindow* window, const Func& proc)=0;
///
/// Invoke a specified function with an specified argument in the main thread and wait for the function to complete or timeout.
///
/// Return true if the function complete. Return false if the function has not completed during a specified period of time.
+ /// A window to access the corressponding main thread.
/// The specified function.
/// The specified period of time to wait. Set to -1 (default value) to wait forever until the function completed.
virtual bool InvokeInMainThreadAndWait(INativeWindow* window, const Func& proc, vint milliseconds=-1)=0;
@@ -3900,7 +3903,6 @@ Resource Image
/// Create an image data with a specified image and a frame index.
/// The specified image.
/// The specified frame index.
- /// The file path of the image. This parameter is only for metadata, it will not affect the content of the image.
GuiImageData(Ptr _image, vint _frameIndex);
~GuiImageData();
@@ -3968,7 +3970,8 @@ Resource Structure
/// The file absolute path of this resource node .
const WString& GetFileAbsolutePath();
/// Set the file content path of this resource node.
- /// The file content path of this resource node .
+ /// The file content path of this resource node .
+ /// The file absolute path of this resource node .
void SetFileContentPath(const WString& content, const WString& absolute);
};
@@ -4182,7 +4185,8 @@ Resource
/// Load a resource from an xml file. If the xml file refers other files, they will be loaded as well.
/// The loaded resource.
/// The xml document.
- /// The working directory for loading image files.
+ /// The file path of the resource.
+ /// The working directory for loading external resources.
/// All collected errors during loading a resource.
static Ptr LoadFromXml(Ptr xml, const WString& filePath, const WString& workingDirectory, GuiResourceError::List& errors);
@@ -4447,17 +4451,20 @@ Resource Type Resolver
public:
/// Serialize a resource to an xml element. This function is called if this type resolver does not have a preload type.
/// The serialized xml element.
- /// The resource.
+ /// The resource item containing the resource.
+ /// The object to serialize.
virtual Ptr Serialize(Ptr resource, Ptr content) = 0;
/// Load a resource for a type inside an xml element.
/// The resource.
+ /// The resource item containing the resource.
/// The xml element.
/// All collected errors during loading a resource.
virtual Ptr ResolveResource(Ptr resource, Ptr element, GuiResourceError::List& errors) = 0;
/// Load a resource for a type from a file.
/// The resource.
+ /// The resource item containing the resource.
/// The file path.
/// All collected errors during loading a resource.
virtual Ptr ResolveResource(Ptr resource, const WString& path, GuiResourceError::List& errors) = 0;
@@ -4468,12 +4475,14 @@ Resource Type Resolver
{
public:
/// Serialize a precompiled resource to a stream.
- /// The resource.
+ /// The resource item containing the resource.
+ /// The content to serialize.
/// The stream.
virtual void SerializePrecompiled(Ptr resource, Ptr content, stream::IStream& stream) = 0;
/// Load a precompiled resource from a stream.
/// The resource.
+ /// The resource item containing the resource.
/// The stream.
/// All collected errors during loading a resource.
virtual Ptr ResolveResourcePrecompiled(Ptr resource, stream::IStream& stream, GuiResourceError::List& errors) = 0;
@@ -4492,12 +4501,13 @@ Resource Type Resolver
/// Serialize a resource to a resource in preload type.
/// The serialized resource.
- /// The resource.
+ /// The resource item containing the resource.
+ /// The object to serialize.
virtual Ptr Serialize(Ptr resource, Ptr content) = 0;
/// Load a resource for a type from a resource loaded by the preload type resolver.
/// The resource.
- /// The resource.
+ /// The resource item containing the resource.
/// The path resolver. This is only for delay load resource.
/// All collected errors during loading a resource.
virtual Ptr ResolveResource(Ptr resource, Ptr resolver, GuiResourceError::List& errors) = 0;
@@ -4930,6 +4940,7 @@ Rich Content Document (model)
/// Load a document model from an xml.
/// The loaded document model.
+ /// The resource item containing the resource.
/// The xml document.
/// A document resolver to resolve symbols in non-embedded objects like image.
/// All collected errors during loading a resource.
@@ -8244,7 +8255,7 @@ namespace vl
/// The item source.
Ptr GetItemSource();
/// Set the item source.
- /// The item source. Null is acceptable if you want to clear all data.
+ /// The item source. Null is acceptable if you want to clear all data.
void SetItemSource(Ptr value);
};
@@ -8438,13 +8449,19 @@ Animation
/// Play the animation. The animation should calculate the time itself to determine the content of the current state of animating objects.
virtual void Run() = 0;
- /// Returns true if the animation has ended.
+ /// Test if the animation has ended.
+ /// Returns true if the animation has ended.
virtual bool GetStopped() = 0;
/// Create a finite animation.
+ /// Returns the created animation.
+ /// The animation callback for each frame.
+ /// The length of the animation.
static Ptr CreateAnimation(const Func& run, vuint64_t milliseconds);
/// Create an infinite animation.
+ /// Returns the created animation.
+ /// The animation callback for each frame.
static Ptr CreateAnimation(const Func& run);
};
@@ -9222,12 +9239,13 @@ namespace vl
#undef GUI_DEFINE_ITEM_PROPERTY
};
- /// Get the current theme style factory object. The default theme is [T:vl.presentation.win7.Win7Theme]. Call [M:vl.presentation.theme.SetCurrentTheme] to change the default theme.
+ /// Get the current theme style factory object. Call or to change the default theme.
/// The current theme style factory object.
extern ITheme* GetCurrentTheme();
extern void InitializeTheme();
extern void FinalizeTheme();
/// Register a control template collection object.
+ /// Returns true if this operation succeeded.
/// The name of the theme.
/// The control template collection object.
extern bool RegisterTheme(const WString& name, Ptr theme);
@@ -9490,6 +9508,7 @@ Host
/// The main compositoin.
GuiGraphicsComposition* GetMainComposition();
/// Render the main composition and all content to the associated window.
+ /// Set to true to force updating layout and then render.
void Render(bool forceUpdate);
/// Request a rendering
void RequestRender();
@@ -9742,10 +9761,10 @@ Basic Construction
/// Get the associated style controller.
/// The associated style controller.
templates::GuiControlTemplate* GetControlTemplateObject();
- /// Get the bounds composition for the control. The value is from .
+ /// Get the bounds composition for the control.
/// The bounds composition.
compositions::GuiBoundsComposition* GetBoundsComposition();
- /// Get the container composition for the control. The value is from .
+ /// Get the container composition for the control.
/// The container composition.
compositions::GuiGraphicsComposition* GetContainerComposition();
/// Get the focusable composition for the control. A focusable composition is the composition to be focused when the control is focused.
@@ -10743,6 +10762,7 @@ Scroll View
/// The view position.
Point GetViewPosition();
/// Set the position of the left-top corner of the view bounds.
+ /// The position.
void SetViewPosition(Point value);
/// Get the horizontal scroll control.
@@ -11049,6 +11069,7 @@ Window
/// Move the window to the center of the screen. If multiple screens exist, the window move to the screen that contains the biggest part of the window.
void MoveToScreenCenter();
/// Move the window to the center of the specified screen.
+ /// The screen.
void MoveToScreenCenter(INativeScreen* screen);
///
@@ -11338,15 +11359,18 @@ Application
/// Test is the current thread the main thread for GUI.
/// Returns true if the current thread is the main thread for GUI.
+ /// A control host to access the corressponding main thread.
bool IsInMainThread(GuiControlHost* controlHost);
/// Invoke a specified function asynchronously.
/// The specified function.
void InvokeAsync(const Func& proc);
/// Invoke a specified function in the main thread.
+ /// A control host to access the corressponding main thread.
/// The specified function.
void InvokeInMainThread(GuiControlHost* controlHost, const Func& proc);
/// Invoke a specified function in the main thread and wait for the function to complete or timeout.
/// Return true if the function complete. Return false if the function has not completed during a specified period of time.
+ /// A control host to access the corressponding main thread.
/// The specified function.
/// The specified period of time to wait. Set to -1 (default value) to wait forever until the function completed.
bool InvokeInMainThreadAndWait(GuiControlHost* controlHost, const Func& proc, vint milliseconds=-1);
@@ -11361,6 +11385,7 @@ Application
/// Time to delay.
Ptr DelayExecuteInMainThread(const Func& proc, vint milliseconds);
/// Run the specified function in the main thread. If the caller is in the main thread, then run the specified function directly.
+ /// A control host to access the corressponding main thread.
/// The specified function.
void RunGuiTask(GuiControlHost* controlHost, const Func& proc);
@@ -11598,7 +11623,7 @@ List Control
/// The index of the item.
virtual description::Value GetBindingValue(vint itemIndex) = 0;
- /// Request a view for this item provider. If the specified view is not supported, it returns null. If you want to get a view of type IXXX, use IXXX::Identifier as the identifier. When the view object is no longer needed, Calling to the [M:vl.presentation.controls.GuiListControl.IItemProvider.ReleaseView] is needed.
+ /// Request a view for this item provider. If the specified view is not supported, it returns null. If you want to get a view of type IXXX, use IXXX::Identifier as the identifier.
/// The view object.
/// The identifier for the requested view.
virtual IDescriptable* RequestView(const WString& identifier) = 0;
@@ -11803,14 +11828,12 @@ List Control
/// The item arranger.
virtual IItemArranger* GetArranger();
/// Set the item arranger
- /// The old item arranger
/// The new item arranger
virtual void SetArranger(Ptr value);
/// Get the item coordinate transformer.
/// The item coordinate transformer.
virtual compositions::IGuiAxis* GetAxis();
/// Set the item coordinate transformer
- /// The old item coordinate transformer
/// The new item coordinate transformer
virtual void SetAxis(Ptr value);
/// Adjust the view location to make an item visible.
@@ -12299,7 +12322,7 @@ GuiVirtualTextList
void OnItemTemplateChanged(compositions::GuiGraphicsComposition* sender, compositions::GuiEventArgs& arguments);
public:
/// Create a Text list control in virtual mode.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
/// The item provider for this control.
GuiVirtualTextList(theme::ThemeName themeName, GuiListControl::IItemProvider* _itemProvider);
~GuiVirtualTextList();
@@ -12326,7 +12349,7 @@ GuiTextList
list::TextItemProvider* items;
public:
/// Create a Text list control.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
GuiTextList(theme::ThemeName themeName);
~GuiTextList();
@@ -12467,7 +12490,7 @@ NodeItemProvider
/// The binding value of a node.
/// The node.
virtual description::Value GetBindingValue(INodeProvider* node) = 0;
- /// Request a view for this node provider. If the specified view is not supported, it returns null. If you want to get a view of type IXXX, use IXXX::Identifier as the identifier. When the view object is no longer needed, A call to the [M:vl.presentation.controls.tree.INodeRootProvider.ReleaseView] is needed.
+ /// Request a view for this node provider. If the specified view is not supported, it returns null. If you want to get a view of type IXXX, use IXXX::Identifier as the identifier.
/// The view object.
/// The identifier for the requested view.
virtual IDescriptable* RequestView(const WString& identifier)=0;
@@ -12480,7 +12503,7 @@ NodeItemProvider
// Tree to ListControl (IItemProvider)
//-----------------------------------------------------------
- /// The required view for [T:vl.presentation.controls.tree.NodeItemStyleProvider]. [T:vl.presentation.controls.tree.NodeItemProvider] provides this view. In most of the cases, the NodeItemProvider class and this view is not required users to create, or even to touch. [T:vl.presentation.controls.GuiVirtualTreeListControl] already handled all of this.
+ /// The required view for [T:vl.presentation.controls.tree.GuiVirtualTreeView]. [T:vl.presentation.controls.tree.NodeItemProvider] provides this view. In most of the cases, the NodeItemProvider class and this view is not required users to create, or even to touch. [T:vl.presentation.controls.GuiVirtualTreeListControl] already handled all of this.
class INodeItemView : public virtual IDescriptable, public Description
{
public:
@@ -12676,7 +12699,7 @@ GuiVirtualTreeListControl
void OnNodeLeftButtonDoubleClick(compositions::GuiGraphicsComposition* sender, compositions::GuiNodeMouseEventArgs& arguments);
public:
/// Create a tree list control in virtual mode.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
/// The node root provider for this control.
GuiVirtualTreeListControl(theme::ThemeName themeName, Ptr _nodeRootProvider);
~GuiVirtualTreeListControl();
@@ -12724,7 +12747,7 @@ TreeViewItemRootProvider
namespace tree
{
- /// The required view for [T:vl.presentation.controls.tree.TreeViewNodeItemStyleProvider].
+ /// The required view for [T:vl.presentation.controls.GuiVirtualTreeView].
class ITreeViewItemView : public virtual IDescriptable, public Description
{
public:
@@ -12806,8 +12829,8 @@ GuiVirtualTreeView
void OnItemCollapsed(tree::INodeProvider* node)override;
void OnStyleInstalled(vint itemIndex, ItemStyle* style)override;
public:
- /// Create a tree view control in virtual mode. A [T:vl.presentation.controls.tree.TreeViewNodeItemStyleProvider] is created as a node item style provider by default.
- /// The control template for this control.
+ /// Create a tree view control in virtual mode.
+ /// The theme name for retriving a default control template.
/// The node root provider for this control.
GuiVirtualTreeView(theme::ThemeName themeName, Ptr _nodeRootProvider);
~GuiVirtualTreeView();
@@ -12824,7 +12847,7 @@ GuiTreeView
Ptr nodes;
public:
/// Create a tree view control.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
GuiTreeView(theme::ThemeName themeName);
~GuiTreeView();
@@ -15148,13 +15171,13 @@ namespace vl
void SetColumnSortingState(ColumnSortingState value);
};
- /// List view base control. All list view controls inherit from this class. is suggested to be the base class of item style providers for list view control.
+ /// List view base control. All list view controls inherit from this class.
class GuiListViewBase : public GuiSelectableListControl, public Description
{
GUI_SPECIFY_CONTROL_TEMPLATE_TYPE(ListViewTemplate, GuiSelectableListControl)
public:
/// Create a list view base control.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
/// The item provider for this control.
GuiListViewBase(theme::ThemeName themeName, GuiListControl::IItemProvider* _itemProvider);
~GuiListViewBase();
@@ -15169,7 +15192,7 @@ ListView ItemStyleProvider
namespace list
{
- /// The required view for .
+ /// The required view for .
class IListViewItemView : public virtual IDescriptable, public Description
{
public:
@@ -15476,7 +15499,7 @@ ListViewItemProvider
~ListViewColumns();
};
- /// Item provider for and .
+ /// Item provider for .
class ListViewItemProvider
: public ListProvider>
, protected virtual IListViewItemProvider
@@ -15557,7 +15580,7 @@ GuiVirtualListView
void OnItemTemplateChanged(compositions::GuiGraphicsComposition* sender, compositions::GuiEventArgs& arguments);
public:
/// Create a list view control in virtual mode.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
/// The item provider for this control.
GuiVirtualListView(theme::ThemeName themeName, GuiListControl::IItemProvider* _itemProvider);
~GuiVirtualListView();
@@ -15581,7 +15604,7 @@ GuiListView
list::ListViewItemProvider* items;
public:
/// Create a list view control.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
GuiListView(theme::ThemeName themeName);
~GuiListView();
@@ -15918,7 +15941,7 @@ Datagrid Interfaces
public:
/// Create a data visualizer.
/// The created data visualizer.
- /// Context information of the data grid.
+ /// Context information of the data grid.
virtual Ptr CreateVisualizer(IDataGridContext* dataGridContext) = 0;
};
@@ -15953,7 +15976,7 @@ Datagrid Interfaces
public:
/// Create a data editor.
/// The created data editor.
- /// The callback for the created editor to send notification.
+ /// Context information of the data grid.
virtual Ptr CreateEditor(IDataGridContext* dataGridContext) = 0;
};
@@ -16081,7 +16104,6 @@ Extension Bases
public:
/// Create the data visualizer.
- /// The decorated data visualizer inside the current data visualizer.
DataVisualizerBase();
~DataVisualizerBase();
@@ -16443,7 +16465,7 @@ GuiVirtualDataGrid
public:
/// Create a data grid control in virtual mode.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
/// The item provider for this control.
GuiVirtualDataGrid(theme::ThemeName themeName, GuiListControl::IItemProvider* _itemProvider);
~GuiVirtualDataGrid();
@@ -16736,7 +16758,6 @@ DataColumn
Ptr GetVisualizerFactory();
/// Set the visualizer factory for the column.
/// The visualizer factory.
- /// The current column provider itself.
void SetVisualizerFactory(Ptr value);
/// Get the editor factory for the column.
@@ -16744,7 +16765,6 @@ DataColumn
Ptr GetEditorFactory();
/// Set the editor factory for the column.
/// The editor factory.
- /// The current column provider itself.
void SetEditorFactory(Ptr value);
/// Get the text value from an item.
@@ -16835,8 +16855,7 @@ DataProvider
ItemProperty> smallImageProperty;
public:
- /// Create a data provider from a .
- /// The structured data provider.
+ /// Create a data provider.
DataProvider();
~DataProvider();
@@ -16902,7 +16921,7 @@ GuiBindableDataGrid
public:
/// Create a bindable Data grid control.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
GuiBindableDataGrid(theme::ThemeName themeName);
~GuiBindableDataGrid();
@@ -17094,8 +17113,7 @@ GuiBindableTextList
public:
/// Create a bindable Text list control.
- /// The control template for this control.
- /// The factory object to create the control styles for bullet before a text item.
+ /// The theme name for retriving a default control template.
GuiBindableTextList(theme::ThemeName themeName);
~GuiBindableTextList();
@@ -17207,7 +17225,7 @@ GuiBindableListView
public:
/// Create a bindable List view control.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
GuiBindableListView(theme::ThemeName themeName);
~GuiBindableListView();
@@ -17336,7 +17354,7 @@ GuiBindableTreeView
public:
/// Create a bindable Tree view control.
- /// The control template for this control.
+ /// The theme name for retriving a default control template.
GuiBindableTreeView(theme::ThemeName themeName);
~GuiBindableTreeView();
@@ -18232,6 +18250,7 @@ Ribbon Gallery
public:
/// Create a control with a specified default theme.
/// The theme name for retriving a default control template.
+ /// The owner menu item of the parent menu.
GuiRibbonToolstripMenu(theme::ThemeName themeName, GuiControl* owner);
~GuiRibbonToolstripMenu();
@@ -18511,7 +18530,7 @@ Ribbon Gallery List
void SelectItem(vint index);
/// Get the minimum items visible in the drop down menu.
- /// The minimum items visible in the drop down menu.
+ /// The minimum items visible in the drop down menu.
vint GetVisibleItemCount();
/// Set minimum items visible in the drop down menu.
/// The minimum items visible in the drop down menu.
diff --git a/Import/Vlpp.h b/Import/Vlpp.h
index 64df29e6..c5c69972 100644
--- a/Import/Vlpp.h
+++ b/Import/Vlpp.h
@@ -10841,11 +10841,10 @@ namespace vl
const FilePath& GetFilePath()const;
/// Get the content of the file as text with encoding testing.
- /// The content of the file.
/// Returns false if this operation succeeded.
/// The content of the file.
/// The encoding.
- /// True if there is BOM.
+ /// True if there is BOM.
bool ReadAllTextWithEncodingTesting(WString& text, stream::BomEncoder::Encoding& encoding, bool& containsBom);
/// Get the content of the file as text.
/// The content of the file.
diff --git a/Import/VlppWorkflowCompiler.h b/Import/VlppWorkflowCompiler.h
index 17788305..49e5e62e 100644
--- a/Import/VlppWorkflowCompiler.h
+++ b/Import/VlppWorkflowCompiler.h
@@ -3982,6 +3982,7 @@ Scope Manager
void Clear(bool keepTypeDescriptorNames, bool deleteModules);
/// Compile.
/// Set to false to delete all cache of reflectable C++ types before compiling.
+ /// The callback to receive progress information, could be nullptr.
void Rebuild(bool keepTypeDescriptorNames, IWfCompilerCallback* callback = nullptr);
bool ResolveMember(ITypeDescriptor* typeDescriptor, const WString& name, bool preferStatic, collections::SortedList& searchedTypes, collections::List& results);
@@ -4490,6 +4491,7 @@ Code Generation
/// Generate an assembly from a compiler. [M:vl.workflow.analyzer.WfLexicalScopeManager.Rebuild] should be called before using this function.
/// The generated assembly.
/// The Workflow compiler.
+ /// The callback to receive progress information, could be nullptr.
extern Ptr GenerateAssembly(analyzer::WfLexicalScopeManager* manager, IWfCompilerCallback* callback = nullptr);
/// Compile a Workflow program.