Browse Source

Rename focus and modal flags to 'keep'

Michael Ragazzon 6 years ago
parent
commit
07805b7d91

+ 8 - 8
Include/RmlUi/Core/ElementDocument.h

@@ -42,18 +42,18 @@ class StyleSheet;
 
 /**
 	 ModalFlag used for controlling the modal state of the document.
-		None: Remove modal state.
+		None:  Remove modal state.
 		Modal: Set modal state, other documents cannot receive focus.
-		Previous: Modal state unchanged.
+		Keep:  Modal state unchanged.
 
 	FocusFlag used for displaying the document.
-	   None: No focus.
-	   Document: Focus the document.
-	   Previous: Focus the previously focused element in the document.
-	   Auto: Focus the first tab element with the 'autofocus' attribute or else the document.
+		None:     No focus.
+		Document: Focus the document.
+		Keep:     Focus the element in the document which last had focus.
+		Auto:     Focus the first tab element with the 'autofocus' attribute or else the document.
 */
-enum class ModalFlag { None, Modal, Previous };
-enum class FocusFlag { None, Document, Previous, Auto };
+enum class ModalFlag { None, Modal, Keep };
+enum class FocusFlag { None, Document, Keep, Auto };
 
 
 /**

+ 2 - 2
Samples/basic/demo/src/main.cpp

@@ -109,7 +109,7 @@ public:
 			if (event.GetParameter("ctrl_key", 0))
 				modal_flag = ModalFlag::Modal;
 			else if (event.GetParameter("shift_key", 0))
-				modal_flag = ModalFlag::Previous;
+				modal_flag = ModalFlag::Keep;
 			
 			if (key_identifier == Rml::Core::Input::KI_Q)
 			{
@@ -121,7 +121,7 @@ public:
 			}
 			else if (key_identifier == Rml::Core::Input::KI_E)
 			{
-				window2->GetDocument()->Show(modal_flag, FocusFlag::Previous);
+				window2->GetDocument()->Show(modal_flag, FocusFlag::Keep);
 			}
 			else if (key_identifier == Rml::Core::Input::KI_R)
 			{

+ 2 - 2
Source/Core/ElementDocument.cpp

@@ -213,7 +213,7 @@ void ElementDocument::Show(ModalFlag modal_flag, FocusFlag focus_flag)
 	{
 	case Rml::Core::ModalFlag::None:     modal = false; break;
 	case Rml::Core::ModalFlag::Modal:    modal = true;  break;
-	case Rml::Core::ModalFlag::Previous: break;
+	case Rml::Core::ModalFlag::Keep: break;
 	}
 
 	bool focus = false;
@@ -227,7 +227,7 @@ void ElementDocument::Show(ModalFlag modal_flag, FocusFlag focus_flag)
 	case FocusFlag::Document:
 		focus = true;
 		break;
-	case FocusFlag::Previous:
+	case FocusFlag::Keep:
 		focus = true;
 		focus_previous = true;
 		break;

+ 4 - 4
Source/Core/Lua/Document.cpp

@@ -54,8 +54,8 @@ template<> void ExtraInit<Document>(lua_State* L, int metatable_index)
         lua_setfield(L,-2,"None");
         lua_pushinteger(L,(int)ModalFlag::Modal);
         lua_setfield(L,-2,"Modal");
-		lua_pushinteger(L, (int)ModalFlag::Previous);
-        lua_setfield(L,-2,"Previous");
+		lua_pushinteger(L, (int)ModalFlag::Keep);
+        lua_setfield(L,-2,"Keep");
         lua_setglobal(L,"DocumentModal");
     }
 
@@ -69,8 +69,8 @@ template<> void ExtraInit<Document>(lua_State* L, int metatable_index)
 		lua_setfield(L, -2, "None");
 		lua_pushinteger(L, (int)FocusFlag::Document);
 		lua_setfield(L, -2, "Document");
-		lua_pushinteger(L, (int)FocusFlag::Previous);
-		lua_setfield(L, -2, "Modal");
+		lua_pushinteger(L, (int)FocusFlag::Keep);
+		lua_setfield(L, -2, "Keep");
 		lua_pushinteger(L, (int)FocusFlag::Auto);
 		lua_setfield(L, -2, "Auto");
 		lua_setglobal(L, "DocumentFocus");

+ 8 - 8
readme.md

@@ -286,18 +286,18 @@ The flags are specified as follows:
 ```C++
 /**
 	 ModalFlag used for controlling the modal state of the document.
-		None: Remove modal state.
+		None:  Remove modal state.
 		Modal: Set modal state, other documents cannot receive focus.
-		Previous: Modal state unchanged.
+		Keep:  Modal state unchanged.
 
 	FocusFlag used for displaying the document.
-	   None: No focus.
-	   Document: Focus the document.
-	   Previous: Focus the previously focused element in the document.
-	   Auto: Focus the first tab element with the 'autofocus' attribute or else the document.
+		None:     No focus.
+		Document: Focus the document.
+		Keep:     Focus the element in the document which last had focus.
+		Auto:     Focus the first tab element with the 'autofocus' attribute or else the document.
 */
-enum class ModalFlag { None, Modal, Previous };
-enum class FocusFlag { None, Document, Previous, Auto };
+enum class ModalFlag { None, Modal, Keep };
+enum class FocusFlag { None, Document, Keep, Auto };
 ```