Minor tweaks to the user guide.

This commit is contained in:
omar 2017-11-01 12:33:38 +01:00
parent e55caf0b95
commit 6ab20ff9bf
2 changed files with 29 additions and 30 deletions

View File

@ -59,23 +59,21 @@
END-USER GUIDE END-USER GUIDE
============== ==============
- Double-click title bar to collapse window - Double-click on title bar to collapse window.
- Click upper right corner to close a window, available when 'bool* p_open' is passed to ImGui::Begin() - Click upper right corner to close a window, available when 'bool* p_open' is passed to ImGui::Begin().
- Click and drag on lower right corner to resize window - Click and drag on lower right corner to resize window (double-click to auto fit window to its contents).
- Click and drag on any empty space to move window - Click and drag on any empty space to move window.
- Double-click/double-tap on lower right corner grip to auto-fit to content - TAB/SHIFT+TAB to cycle through keyboard editable fields.
- TAB/SHIFT+TAB to cycle through keyboard editable fields - CTRL+Click on a slider or drag box to input value as text.
- Use mouse wheel to scroll - Use mouse wheel to scroll.
- Use CTRL+mouse wheel to zoom window contents (if io.FontAllowScaling is true)
- CTRL+Click on a slider or drag box to input value as text
- Text editor: - Text editor:
- Hold SHIFT or use mouse to select text. - Hold SHIFT or use mouse to select text.
- CTRL+Left/Right to word jump - CTRL+Left/Right to word jump.
- CTRL+Shift+Left/Right to select words - CTRL+Shift+Left/Right to select words.
- CTRL+A our Double-Click to select all - CTRL+A our Double-Click to select all.
- CTRL+X,CTRL+C,CTRL+V to use OS clipboard - CTRL+X,CTRL+C,CTRL+V to use OS clipboard/
- CTRL+Z,CTRL+Y to undo/redo - CTRL+Z,CTRL+Y to undo/redo.
- ESCAPE to revert text to its original value - ESCAPE to revert text to its original value.
- You can apply arithmetic operators +,*,/ on numerical values. Use +- to subtract (because - would set a negative value!) - You can apply arithmetic operators +,*,/ on numerical values. Use +- to subtract (because - would set a negative value!)
- Controls are automatically adjusted for OSX to match standard OSX text editing operations. - Controls are automatically adjusted for OSX to match standard OSX text editing operations.

View File

@ -101,23 +101,23 @@ static void ShowHelpMarker(const char* desc)
void ImGui::ShowUserGuide() void ImGui::ShowUserGuide()
{ {
ImGui::BulletText("Double-click on title bar to collapse window."); ImGui::BulletText("Double-click on title bar to collapse window.");
ImGui::BulletText("Click and drag on lower right corner to resize window."); ImGui::BulletText("Click and drag on lower right corner to resize window\n(double-click to auto fit window to its contents).");
ImGui::BulletText("Click and drag on any empty space to move window."); ImGui::BulletText("Click and drag on any empty space to move window.");
ImGui::BulletText("Mouse Wheel to scroll."); ImGui::BulletText("TAB/SHIFT+TAB to cycle through keyboard editable fields.");
ImGui::BulletText("CTRL+Click on a slider or drag box to input value as text.");
if (ImGui::GetIO().FontAllowUserScaling) if (ImGui::GetIO().FontAllowUserScaling)
ImGui::BulletText("CTRL+Mouse Wheel to zoom window contents."); ImGui::BulletText("CTRL+Mouse Wheel to zoom window contents.");
ImGui::BulletText("TAB/SHIFT+TAB to cycle through keyboard editable fields."); ImGui::BulletText("Mouse Wheel to scroll.");
ImGui::BulletText("CTRL+Click on a slider or drag box to input text."); ImGui::BulletText("While editing text:\n");
ImGui::BulletText( ImGui::Indent();
"While editing text:\n" ImGui::BulletText("Hold SHIFT or use mouse to select text.");
"- Hold SHIFT or use mouse to select text\n" ImGui::BulletText("CTRL+Left/Right to word jump.");
"- CTRL+Left/Right to word jump\n" ImGui::BulletText("CTRL+A or double-click to select all.");
"- CTRL+A or double-click to select all\n" ImGui::BulletText("CTRL+X,CTRL+C,CTRL+V to use clipboard.");
"- CTRL+X,CTRL+C,CTRL+V clipboard\n" ImGui::BulletText("CTRL+Z,CTRL+Y to undo/redo.");
"- CTRL+Z,CTRL+Y undo/redo\n" ImGui::BulletText("ESCAPE to revert.");
"- ESCAPE to revert\n" ImGui::BulletText("You can apply arithmetic operators +,*,/ on numerical values.\nUse +- to subtract.");
"- You can apply arithmetic operators +,*,/ on numerical values.\n" ImGui::Unindent();
" Use +- to subtract.\n");
} }
// Demonstrate most ImGui features (big function!) // Demonstrate most ImGui features (big function!)
@ -230,7 +230,8 @@ void ImGui::ShowTestWindow(bool* p_open)
ImGui::Spacing(); ImGui::Spacing();
if (ImGui::CollapsingHeader("Help")) if (ImGui::CollapsingHeader("Help"))
{ {
ImGui::TextWrapped("This window is being created by the ShowTestWindow() function. Please refer to the code for programming reference.\n\nUser Guide:"); ImGui::TextWrapped("This window is being created by the ShowTestWindow() function. Please refer to the code in imgui_demo.cpp for reference.\n\n");
ImGui::Text("USER GUIDE:");
ImGui::ShowUserGuide(); ImGui::ShowUserGuide();
} }