Coverage for src/robotide/action/action.py: 75%

1# Copyright 2008-2015 Nokia Networks 

2# Copyright 2016- Robot Framework Foundation 

3# 

4# Licensed under the Apache License, Version 2.0 (the "License"); 

5# you may not use this file except in compliance with the License. 

6# You may obtain a copy of the License at 

7# 

8# http://www.apache.org/licenses/LICENSE-2.0 

9# 

10# Unless required by applicable law or agreed to in writing, software 

11# distributed under the License is distributed on an "AS IS" BASIS, 

12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

13# See the License for the specific language governing permissions and 

14# limitations under the License. 

15 

16 

17def action_factory(action_info): 2 ctx1ac

18 if action_info.is_separator(): 3 ctx1abd

19 return _MenuSeparator(action_info) 3 ctx1abd

20 return Action(action_info) 2 ctx1ab

21 

22 

23class _Registrable(object): 2 ctx1ac

24 

25 def __init__(self, action_info): 2 ctx1ac

26 self._registered_to = [] 3 ctx1abd

27 self.action = None 3 ctx1abd

28 self.shortcut = None 3 ctx1abd

29 self.icon = None 3 ctx1abd

30 self._insertion_point = action_info.insertion_point 3 ctx1abd

31 self._enabled = True 3 ctx1abd

32 self._enabled_status_listeners = [] 3 ctx1abd

33 

34 disable = enable = lambda event: None 2 ctx1ac

35 

36 def is_separator(self): 2 ctx1ac

37 return False 3 ctx1abd

38 

39 def get_insertion_index(self, menu): 2 ctx1ac

40 return self._insertion_point.get_index(menu) 3 ctx1abd

41 

42 def register(self, registerer): 2 ctx1ac

43 self._registered_to.append(registerer) 3 ctx1abd

44 

45 def unregister(self): 2 ctx1ac

46 for registerer in self._registered_to: 

47 registerer.unregister(self) 

48 self._registered_to = [] 

49 

50 def has_action(self): 2 ctx1ac

51 return self.action is not None 2 ctx1ab

52 

53 def has_shortcut(self): 2 ctx1ac

54 return bool(self.shortcut) 2 ctx1ab

55 

56 def has_icon(self): 2 ctx1ac

57 return self.icon is not None 2 ctx1ab

58 

59 def inform_changes_in_enabled_status(self, listener): 2 ctx1ac

60 self._enabled_status_listeners.append(listener) (empty)

61 

62 

63class Action(_Registrable): 2 ctx1ac

64 """Acts based on user actions if action is enabled. Created from `ActionInfo`. 

65 

66 If `ActionInfo` contains container, acts and allows to select related UI 

67 widgets (menu item, toolbar button) and shortcuts only if the focus is in the given  

68 container or its children. 

69 Action can be set enabled or disabled which enables/disables also related UI 

70 widgets and shortcut. 

71 """ 

72 

73 def __init__(self, action_info): 2 ctx1ac

74 _Registrable.__init__(self, action_info) 2 ctx1ab

75 self.menu_name = action_info.menu_name 2 ctx1ab

76 self.name = action_info.name 2 ctx1ab

77 self.action = action_info.action 2 ctx1ab

78 self.container = action_info.container 2 ctx1ab

79 self.shortcut = action_info.shortcut 2 ctx1ab

80 self.icon = action_info.icon 2 ctx1ab

81 self.doc = action_info.doc 2 ctx1ab

82 # print("DEBUG: Action: %s::%s" % (self.menu_name,self.name)) 

83 

84 def get_shortcut(self): 2 ctx1ac

85 return self.shortcut.printable 3 ctx1abd

86 

87 def act(self, event): 2 ctx1ac

88 if self.is_active(): 

89 self.action(event) 

90 

91 def disable(self): 2 ctx1ac

92 """Disables action and related menu item, toolbar button and shortcut""" 

93 self._enabled = False (empty)

94 self._inform_changes_in_enabled_status() (empty)

95 

96 def enable(self): 2 ctx1ac

97 """Enables action and related menu item, toolbar button and shortcut""" 

98 self._enabled = True (empty)

99 self._inform_changes_in_enabled_status() (empty)

100 

101 def _inform_changes_in_enabled_status(self): 2 ctx1ac

102 for listener in self._enabled_status_listeners: (empty)

103 listener.enabled_status_changed(self) (empty)

104 

105 def is_active(self): 2 ctx1ac

106 if self._is_always_inactive() or not self._enabled: (empty)

107 return False (empty)

108 if self._is_always_active(): 108 ↛ 110line 108 didn't jump to line 110 because the condition on line 108 was always true(empty)

109 return True (empty)

110 return self._container_is_active() 

111 

112 def _is_always_inactive(self): 2 ctx1ac

113 return self.action is None (empty)

114 

115 def _is_always_active(self): 2 ctx1ac

116 return self.container is None (empty)

117 

118 def _container_is_active(self): 2 ctx1ac

119 if not self.container.IsShownOnScreen(): 

120 return False 

121 widget = self.container.FindFocus() 

122 while widget: 

123 if widget == self.container.Parent: 

124 return True 

125 widget = widget.GetParent() 

126 return False 

127 

128 

129class _MenuSeparator(_Registrable): 2 ctx1ac

130 

131 def __init__(self, action_info): 2 ctx1ac

132 _Registrable.__init__(self, action_info) 3 ctx1abd

133 self.menu_name = action_info.menu_name 3 ctx1abd

134 self.name = '---' 3 ctx1abd

135 

136 def is_separator(self): 2 ctx1ac

137 return True 3 ctx1abd