完善Readme

README.md

@@ -2,6 +2,7 @@
 ## 简介
   这个库提供一系列的函数来简化对Windows控制台窗口的输入输出（主要是输出）控制。通过它，你可以将窗口分割为不同的窗格，你也可以创建分隔线来分隔它们。而不管是窗口、窗格还是分隔线，你可以随时修改它们的大小和位置。
 
+
 ## 特性
   你可以将控制台窗口分割为若干个**窗格**，窗格之间可创建**分割线**来区别它们。每个窗格拥有一个行缓存，包含若干**行**。你可以改变行缓存的大小。
 
@@ -10,37 +11,104 @@
 &emsp;&emsp;你可以为每一**行**设定字符格式，字符格式由Windows的一些<a href="#constant">常量</a>定义。
 
 
-
 ## 开发环境
 &emsp;&emsp;Windows，Visual Studio 2017
 
+## 编译方式
+* ### 获取项目：
+	> `git clone https://github.com/mattuylee/conctrl.git`
+
+* ### 编译
+	
+	用Visual Studio打开conctrl.sln，编译方式选择Release，平台x86或者x64根据需求选择，然后选择生成（build）菜单，选择生成解决方案(Build Solution)。得到*conctrl.dll*和*constrl.lib*文件。
+
+	注：如果编译不成功请检查项目属性，如果配置类型（Configuration Type）为应用程序(.exe)请改为动态链接库(.dll)。
+
+
+## 使用方法
+* ### C++
+    将代码目录里的conctrl.h，编译得到的conctrl.dll和conctrl.lib放在相同目录，在你的代码中添加：
+    > `#include "conctrl.h"`  
+    > `#pragma comment(lib, "conctrl.lib")`
+
+    <a href="#usage_cpp">查看示例</a>
+* ### 其他语言
+	根据调用操作系统动态库的规则调用dll内的导出函数即可。注意，C语言无法像C++一样调用此dll，因此只能显式调用，通过LoadLibrary动态加载DLL。
+
 ## 注意事项
 &emsp;&emsp;需要注意的是，窗格只是逻辑意义上的窗格，它们属于同一个控制台窗口，共享输入缓冲区，因此这个库仅**适用于需要多个窗格用于输出**而不超过1个窗格同时用来输入。
 
 &emsp;&emsp;分隔线是需要占用空间的，由于制表符是双字节字符，因此分隔线长度必须是2的倍数。同时注意，水平分割线的**高度**是1个字符，而**垂直分隔线的宽度是2个字符**。
 
 &emsp;&emsp;构建这个库的初衷是为了方便某些高级语言操作控制台，因此没有导出类而是封装了一系列C函数，并将它们的参数都设定为简单的数值型和字符串，避免在高级语言中额外定义数据类型，方便使用。
-### &emsp;&emsp;**你不应该直接操作ConsoleWindow、Pannel、和Spliter类对象**，而应仅将它们的指针作为参数传递。
+
+<big> &emsp;&emsp;**你不应该直接操作ConsoleWindow、Pannel、和Spliter类对象**，而应仅将它们的指针作为参数传递。</big>
 
 &emsp;&emsp;此库通过调用Windows API实现，因此仅适用于Windows系统。
 
-## 使用方法
-* ### C++
-    将conctrl.h，conctrl.dll和conctrl.lib放在源代码目录，并在源代码中添加：
-    > `#include "conctrl.h"`  
-    > `#pragma comment(lib, "conctrl.lib")`
-
-    <a href="#usage_cpp">查看示例</a>
-* ### 其他语言
-
 
 
 ## 导出函数列表
+&emsp;&emsp;具体说明和参数列表见头文件**conctrl.h**
 
+* **CreateConsoleWindow**，  
+  创建控制器，调用其他任何函数之前应先调用此函数
+
+* DestroyConsoleWindow,  
+  销毁控制器，它将销毁所有创建的窗格，并抹除上面的字符
+
+* ResizeScreenBuffer,  
+  设置控制台屏幕缓冲区大小（不是窗口大小）
+
+* SetConsoleWindowTitle,  
+  设置控制台窗口标题
+
+* **CreatePannel**,  
+  创建一个窗格
+
+* DestroyPannel,  
+  销毁窗格
+
+* SetMaxLineCache,  
+  设置窗格行缓存的最大值（单位行） 
+
+* **AddPannelText**,  
+  向窗格添加文本
+
+* **AddPannelLine**,  
+  向窗格添加文本行
+
+* ClearPannel,  
+  清除窗格文本和行缓存
+
+* **MovePannel**,  
+  移动或重新设置窗格大小
+
+* ScrollPannelBackward,  
+  向前翻页
+
+* ScrollPannelForward,  
+  向后翻页
+
+* ScrollPannelTo,  
+  跳转到指定行
+
+* **FocusOnPannel**,  
+  将光标定位到指定窗格的指定位置
+
+* **CreateSpliter**,  
+  创建分割线
+
+* DestroySpliter,  
+  删除分割线
+
+* MoveSpliter,  
+  移动或修改分割线长度
 
 ## 缺陷
 * 对用户输入的控制比较无力
 * 只能对整行设定字符样式
+* **功能没有全部测试**
 * 其他
 
 
@@ -50,29 +118,25 @@
 
 ```C++
 #include <stdio.h>
+#include <string.h>
 #include <Windows.h>
 #include "conctrl.h"
-#pragma comment(lib, "conctrl.lib")
 int main() {
 	ConsoleWindow* window = CreateConsoleWindow(80, 40);
 	Pannel* messagePannel = CreatePannel(window, 0, 0, 78, 25);
-	Pannel* writePannel= CreatePannel(window, 0, 26, 80, 40);
+	Pannel* writePannel = CreatePannel(window, 0, 26, 80, 40);
 	Spliter* spliter = CreateSpliter(window, 0, 25, 80, false, FOREGROUND_GREEN);
-	AddPannelLine(messagePannel, "请在下方区域输入任意内容", false);
+	AddPannelText(messagePannel, "输入任意内容，回车发送", true, true, 7);
 	FocusOnPannel(writePannel, 0, 0);
 	while (true) {
 		char str[1024];
-		gets_s(str, 1024);
+		gets_s(str, 1023);
-		AddPannelLine(messagePannel, str, false, FOREGROUND_RED|FOREGROUND_GREEN);
+		AddPannelText(messagePannel, str, false, false, FOREGROUND_RED | FOREGROUND_GREEN);
 		ClearPannel(writePannel);
 		FocusOnPannel(writePannel, 0, 0);
 	}
 }
 ```
-```C
-
-```
-
 
 ## 辅助资料
 

conctrl/conctrl.vcxproj

@@ -22,6 +22,7 @@
     <ClCompile Include="coding.cpp" />
     <ClCompile Include="conctrl.cpp" />
     <ClCompile Include="console_window.cpp" />
+    <ClCompile Include="main.cpp" />
     <ClCompile Include="pannel.cpp" />
     <ClCompile Include="spliter.cpp" />
   </ItemGroup>

conctrl/conctrl.vcxproj.filters

@@ -30,6 +30,9 @@
     <ClCompile Include="spliter.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="main.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="coding.h">
@@ -49,10 +52,10 @@
     </ClInclude>
   </ItemGroup>
   <ItemGroup>
-    <None Include="..\README.md">
+    <None Include="conctrl.def">
       <Filter>Resource Files</Filter>
     </None>
-    <None Include="conctrl.def">
+    <None Include="..\README.md">
       <Filter>Resource Files</Filter>
     </None>
   </ItemGroup>

conctrl/main.cpp

@@ -0,0 +1,19 @@
+#include <stdio.h>
+#include <string.h>
+#include <Windows.h>
+#include "conctrl.h"
+int main() {
+	ConsoleWindow* window = CreateConsoleWindow(80, 40);
+	Pannel* messagePannel = CreatePannel(window, 0, 0, 78, 25);
+	Pannel* writePannel = CreatePannel(window, 0, 26, 80, 40);
+	Spliter* spliter = CreateSpliter(window, 0, 25, 80, false, FOREGROUND_GREEN);
+	AddPannelText(messagePannel, "输入任意内容，回车发送", true, true, 7);
+	FocusOnPannel(writePannel, 0, 0);
+	while (true) {
+		char text[1024];
+		gets_s(text, 1024);
+		AddPannelText(messagePannel, text, false, false, FOREGROUND_RED | FOREGROUND_GREEN);
+		ClearPannel(writePannel);
+		FocusOnPannel(writePannel, 0, 0);
+	}
+}