godot/scene/gui/popup_menu.cpp
Ivan P. Skodje 0701e7c2d8 PopupMenu upgrade: Hide on item selection (#7306)
* Added the option to set hide on item selection. Usable in GDScript and from within the source code when you want to specify popup menus you don't want to close immediately when selecting an item

* Renamed getter from get_ to is_, fixed parent/child behavior, renamed bool variable to match most code and added ADD_PROPERTYNO to save some memory

(cherry picked from commit da950cd0f2)
2017-01-12 19:15:28 +01:00

1170 lines
29 KiB
C++

/*************************************************************************/
/* popup_menu.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* http://www.godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
#include "popup_menu.h"
#include "print_string.h"
#include "os/keyboard.h"
#include "translation.h"
#include "os/input.h"
String PopupMenu::_get_accel_text(int p_item) const {
ERR_FAIL_INDEX_V(p_item,items.size(),String());
if (items[p_item].shortcut.is_valid())
return items[p_item].shortcut->get_as_text();
else if (items[p_item].accel)
return keycode_get_string(items[p_item].accel);
return String();
/*
String atxt;
if (p_accel&KEY_MASK_SHIFT)
atxt+="Shift+";
if (p_accel&KEY_MASK_ALT)
atxt+="Alt+";
if (p_accel&KEY_MASK_CTRL)
atxt+="Ctrl+";
if (p_accel&KEY_MASK_META)
atxt+="Meta+";
p_accel&=KEY_CODE_MASK;
atxt+=String::chr(p_accel).to_upper();
return atxt;
*/
}
Size2 PopupMenu::get_minimum_size() const {
int vseparation = get_constant("vseparation");
int hseparation = get_constant("hseparation");
Size2 minsize = get_stylebox("panel")->get_minimum_size();
Ref<Font> font = get_font("font");
float max_w=0;
int font_h = font->get_height();
int check_w = get_icon("checked")->get_width();
int accel_max_w=0;
for (int i=0;i<items.size();i++) {
Size2 size;
if (!items[i].icon.is_null()) {
Size2 icon_size = items[i].icon->get_size();
size.height = MAX( icon_size.height, font_h );
size.width+=icon_size.width;
size.width+=hseparation;
} else {
size.height=font_h;
}
if (items[i].checkable) {
size.width+=check_w+hseparation;
}
String text = items[i].shortcut.is_valid() ? String(tr(items[i].shortcut->get_name())) : items[i].text;
size.width+=font->get_string_size(text).width;
if (i>0)
size.height+=vseparation;
if (items[i].accel || (items[i].shortcut.is_valid() && items[i].shortcut->is_valid())) {
int accel_w = hseparation*2;
accel_w+=font->get_string_size(_get_accel_text(i)).width;
accel_max_w = MAX( accel_w, accel_max_w );
}
minsize.height+=size.height;
max_w = MAX( max_w, size.width );
}
minsize.width+=max_w+accel_max_w;
return minsize;
}
int PopupMenu::_get_mouse_over(const Point2& p_over) const {
if (p_over.x<0 || p_over.x>=get_size().width)
return -1;
Ref<StyleBox> style = get_stylebox("panel");
Point2 ofs=style->get_offset();
if (ofs.y>p_over.y)
return -1;
Ref<Font> font = get_font("font");
int vseparation = get_constant("vseparation");
// int hseparation = get_constant("hseparation");
float font_h=font->get_height();
for (int i=0;i<items.size();i++) {
if (i>0)
ofs.y+=vseparation;
float h;
if (!items[i].icon.is_null()) {
Size2 icon_size = items[i].icon->get_size();
h = MAX( icon_size.height, font_h );
} else {
h=font_h;
}
ofs.y+=h;
if (p_over.y < ofs.y) {
return i;
}
}
return -1;
}
void PopupMenu::_activate_submenu(int over) {
Node* n = get_node(items[over].submenu);
ERR_EXPLAIN("item subnode does not exist: "+items[over].submenu);
ERR_FAIL_COND(!n);
Popup *pm = n->cast_to<Popup>();
ERR_EXPLAIN("item subnode is not a Popup: "+items[over].submenu);
ERR_FAIL_COND(!pm);
if (pm->is_visible())
return; //already visible!
Point2 p = get_global_pos();
Rect2 pr(p,get_size());
Ref<StyleBox> style = get_stylebox("panel");
Point2 pos = p+Point2(get_size().width,items[over]._ofs_cache-style->get_offset().y);
Size2 size = pm->get_size();
// fix pos
if (pos.x+size.width > get_viewport_rect().size.width)
pos.x=p.x-size.width;
pm->set_pos(pos);
pm->popup();
PopupMenu *pum = pm->cast_to<PopupMenu>();
if (pum) {
pr.pos-=pum->get_global_pos();
pum->clear_autohide_areas();
pum->add_autohide_area(Rect2(pr.pos.x,pr.pos.y,pr.size.x,items[over]._ofs_cache));
if (over<items.size()-1) {
int from = items[over+1]._ofs_cache;
pum->add_autohide_area(Rect2(pr.pos.x,pr.pos.y+from,pr.size.x,pr.size.y-from));
}
}
}
void PopupMenu::_submenu_timeout() {
if (mouse_over==submenu_over) {
_activate_submenu(mouse_over);
submenu_over=-1;
}
}
void PopupMenu::_input_event(const InputEvent &p_event) {
switch( p_event.type) {
case InputEvent::KEY: {
if (!p_event.key.pressed)
break;
switch(p_event.key.scancode) {
case KEY_DOWN: {
for(int i=mouse_over+1;i<items.size();i++) {
if (i<0 || i>=items.size())
continue;
if (!items[i].separator && !items[i].disabled) {
mouse_over=i;
update();
break;
}
}
} break;
case KEY_UP: {
for(int i=mouse_over-1;i>=0;i--) {
if (i<0 || i>=items.size())
continue;
if (!items[i].separator && !items[i].disabled) {
mouse_over=i;
update();
break;
}
}
} break;
case KEY_RETURN:
case KEY_ENTER: {
if (mouse_over>=0 && mouse_over<items.size() && !items[mouse_over].separator) {
activate_item(mouse_over);
}
} break;
}
} break;
case InputEvent::MOUSE_BUTTON: {
const InputEventMouseButton &b=p_event.mouse_button;
if (b.pressed)
break;
switch(b.button_index) {
case BUTTON_WHEEL_DOWN: {
if (get_global_pos().y + get_size().y > get_viewport_rect().size.y) {
int vseparation = get_constant("vseparation");
Ref<Font> font = get_font("font");
Point2 pos = get_pos();
int s = (vseparation+font->get_height())*3;
pos.y-=s;
set_pos(pos);
//update hover
InputEvent ie;
ie.type=InputEvent::MOUSE_MOTION;
ie.mouse_motion.x=b.x;
ie.mouse_motion.y=b.y+s;
_input_event(ie);
}
} break;
case BUTTON_WHEEL_UP: {
if (get_global_pos().y < 0) {
int vseparation = get_constant("vseparation");
Ref<Font> font = get_font("font");
Point2 pos = get_pos();
int s = (vseparation+font->get_height())*3;
pos.y+=s;
set_pos(pos);
//update hover
InputEvent ie;
ie.type=InputEvent::MOUSE_MOTION;
ie.mouse_motion.x=b.x;
ie.mouse_motion.y=b.y-s;
_input_event(ie);
}
} break;
case BUTTON_LEFT: {
int over=_get_mouse_over(Point2(b.x,b.y));
if (invalidated_click) {
invalidated_click=false;
break;
}
if (over<0) {
hide();
break; //non-activable
}
if (items[over].separator || items[over].disabled)
break;
if (items[over].submenu!="") {
_activate_submenu(over);
return;
}
activate_item(over);
} break;
}
//update();
} break;
case InputEvent::MOUSE_MOTION: {
if (invalidated_click) {
moved+=Vector2(p_event.mouse_motion.relative_x,p_event.mouse_motion.relative_y);
if (moved.length()>4)
invalidated_click=false;
}
const InputEventMouseMotion &m=p_event.mouse_motion;
for(List<Rect2>::Element *E=autohide_areas.front();E;E=E->next()) {
if (!Rect2(Point2(),get_size()).has_point(Point2(m.x,m.y)) && E->get().has_point(Point2(m.x,m.y))) {
call_deferred("hide");
return;
}
}
int over=_get_mouse_over(Point2(m.x,m.y));
int id = (over<0 || items[over].separator || items[over].disabled)?-1:(items[over].ID>=0?items[over].ID:over);
if (id<0) {
mouse_over=-1;
update();
break;
}
if (items[over].submenu!="" && submenu_over!=over) {
submenu_over=over;
submenu_timer->start();
}
if (over!=mouse_over) {
mouse_over=over;
update();
}
} break;
}
}
bool PopupMenu::has_point(const Point2& p_point) const {
if (parent_rect.has_point(p_point))
return true;
for(const List<Rect2>::Element *E=autohide_areas.front();E;E=E->next()) {
if (E->get().has_point(p_point))
return true;
}
return Control::has_point(p_point);
}
void PopupMenu::_notification(int p_what) {
switch(p_what) {
case NOTIFICATION_DRAW: {
RID ci = get_canvas_item();
Size2 size=get_size();
Ref<StyleBox> style = get_stylebox("panel");
Ref<StyleBox> hover = get_stylebox("hover");
Ref<Font> font = get_font("font");
Ref<Texture> check = get_icon("checked");
Ref<Texture> uncheck = get_icon("unchecked");
Ref<Texture> submenu= get_icon("submenu");
Ref<StyleBox> separator = get_stylebox("separator");
style->draw( ci, Rect2( Point2(), get_size() ) );
Point2 ofs=style->get_offset();
int vseparation = get_constant("vseparation");
int hseparation = get_constant("hseparation");
Color font_color = get_color("font_color");
Color font_color_disabled = get_color("font_color_disabled");
Color font_color_accel = get_color("font_color_accel");
Color font_color_hover = get_color("font_color_hover");
float font_h=font->get_height();
for (int i=0;i<items.size();i++) {
if (i>0)
ofs.y+=vseparation;
Point2 item_ofs=ofs;
float h;
Size2 icon_size;
if (!items[i].icon.is_null()) {
icon_size = items[i].icon->get_size();
h = MAX( icon_size.height, font_h );
} else {
h=font_h;
}
if (i==mouse_over) {
hover->draw(ci, Rect2( ofs+Point2(-hseparation,-vseparation), Size2( get_size().width - style->get_minimum_size().width + hseparation*2, h+vseparation*2 ) ));
}
if (items[i].separator) {
int sep_h=separator->get_center_size().height+separator->get_minimum_size().height;
separator->draw(ci, Rect2( ofs+Point2(0,Math::floor((h-sep_h)/2.0)), Size2( get_size().width - style->get_minimum_size().width , sep_h ) ));
}
if (items[i].checkable) {
if (items[i].checked)
check->draw(ci, item_ofs+Point2(0,Math::floor((h-check->get_height())/2.0)));
else
uncheck->draw(ci, item_ofs+Point2(0,Math::floor((h-check->get_height())/2.0)));
item_ofs.x+=check->get_width()+hseparation;
}
if (!items[i].icon.is_null()) {
items[i].icon->draw( ci, item_ofs+Point2(0,Math::floor((h-icon_size.height)/2.0)));
item_ofs.x+=items[i].icon->get_width();
item_ofs.x+=hseparation;
}
if (items[i].submenu!="") {
submenu->draw( ci, Point2(size.width - style->get_margin(MARGIN_RIGHT) - submenu->get_width(),item_ofs.y+Math::floor(h-submenu->get_height())/2));
}
item_ofs.y+=font->get_ascent();
String text = items[i].shortcut.is_valid() ? String(tr(items[i].shortcut->get_name())) : items[i].text;
if (!items[i].separator) {
font->draw(ci,item_ofs+Point2(0,Math::floor((h-font_h)/2.0)),text,items[i].disabled?font_color_disabled:(i==mouse_over?font_color_hover:font_color));
}
if (items[i].accel || (items[i].shortcut.is_valid() && items[i].shortcut->is_valid())) {
//accelerator
String text = _get_accel_text(i);
item_ofs.x=size.width-style->get_margin(MARGIN_RIGHT)-font->get_string_size(text).width;
font->draw(ci,item_ofs+Point2(0,Math::floor((h-font_h)/2.0)),text,i==mouse_over?font_color_hover:font_color_accel);
}
items[i]._ofs_cache=ofs.y;
ofs.y+=h;
}
} break;
case NOTIFICATION_MOUSE_ENTER: {
grab_focus();
} break;
case NOTIFICATION_MOUSE_EXIT: {
if (mouse_over>=0) {
mouse_over=-1;
update();
}
} break;
}
}
void PopupMenu::add_icon_item(const Ref<Texture>& p_icon,const String& p_label,int p_ID,uint32_t p_accel) {
Item item;
item.icon=p_icon;
item.text=p_label;
item.accel=p_accel;
item.ID=p_ID;
items.push_back(item);
update();
}
void PopupMenu::add_item(const String& p_label,int p_ID,uint32_t p_accel) {
Item item;
item.text=XL_MESSAGE(p_label);
item.accel=p_accel;
item.ID=p_ID;
items.push_back(item);
update();
}
void PopupMenu::add_submenu_item(const String& p_label, const String& p_submenu,int p_ID){
Item item;
item.text=XL_MESSAGE(p_label);
item.ID=p_ID;
item.submenu=p_submenu;
items.push_back(item);
update();
}
void PopupMenu::add_icon_check_item(const Ref<Texture>& p_icon,const String& p_label,int p_ID,uint32_t p_accel) {
Item item;
item.icon=p_icon;
item.text=XL_MESSAGE(p_label);
item.accel=p_accel;
item.ID=p_ID;
item.checkable=true;
items.push_back(item);
update();
}
void PopupMenu::add_check_item(const String& p_label,int p_ID,uint32_t p_accel) {
Item item;
item.text=XL_MESSAGE(p_label);
item.accel=p_accel;
item.ID=p_ID;
item.checkable=true;
items.push_back(item);
update();
}
void PopupMenu::add_icon_shortcut(const Ref<Texture>& p_icon,const Ref<ShortCut>& p_shortcut,int p_ID) {
ERR_FAIL_COND(p_shortcut.is_null());
_ref_shortcut(p_shortcut);
Item item;
item.ID=p_ID;
item.icon=p_icon;
item.shortcut=p_shortcut;
items.push_back(item);
update();
}
void PopupMenu::add_shortcut(const Ref<ShortCut>& p_shortcut,int p_ID){
ERR_FAIL_COND(p_shortcut.is_null());
_ref_shortcut(p_shortcut);
Item item;
item.ID=p_ID;
item.shortcut=p_shortcut;
items.push_back(item);
update();
}
void PopupMenu::add_icon_check_shortcut(const Ref<Texture>& p_icon,const Ref<ShortCut>& p_shortcut,int p_ID){
ERR_FAIL_COND(p_shortcut.is_null());
_ref_shortcut(p_shortcut);
Item item;
item.ID=p_ID;
item.shortcut=p_shortcut;
item.checkable=true;
item.icon=p_icon;
items.push_back(item);
update();
}
void PopupMenu::add_check_shortcut(const Ref<ShortCut>& p_shortcut,int p_ID){
ERR_FAIL_COND(p_shortcut.is_null());
_ref_shortcut(p_shortcut);
Item item;
item.ID=p_ID;
item.shortcut=p_shortcut;
item.checkable=true;
items.push_back(item);
update();
}
void PopupMenu::set_item_text(int p_idx,const String& p_text) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].text=XL_MESSAGE(p_text);
update();
}
void PopupMenu::set_item_icon(int p_idx,const Ref<Texture>& p_icon) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].icon=p_icon;
update();
}
void PopupMenu::set_item_checked(int p_idx,bool p_checked) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].checked=p_checked;
update();
}
void PopupMenu::set_item_ID(int p_idx,int p_ID) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].ID=p_ID;
update();
}
void PopupMenu::set_item_accelerator(int p_idx,uint32_t p_accel) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].accel=p_accel;
update();
}
void PopupMenu::set_item_metadata(int p_idx,const Variant& p_meta) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].metadata=p_meta;
update();
}
void PopupMenu::set_item_disabled(int p_idx,bool p_disabled) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].disabled=p_disabled;
update();
}
void PopupMenu::set_item_submenu(int p_idx, const String& p_submenu) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].submenu=p_submenu;
update();
}
void PopupMenu::toggle_item_checked(int p_idx) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].checked = !items[p_idx].checked;
update();
}
String PopupMenu::get_item_text(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),"");
return items[p_idx].text;
}
Ref<Texture> PopupMenu::get_item_icon(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),Ref<Texture>());
return items[p_idx].icon;
}
uint32_t PopupMenu::get_item_accelerator(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),0);
return items[p_idx].accel;
}
Variant PopupMenu::get_item_metadata(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),Variant());
return items[p_idx].metadata;
}
bool PopupMenu::is_item_disabled(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),false);
return items[p_idx].disabled;
}
bool PopupMenu::is_item_checked(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),false);
return items[p_idx].checked;
}
int PopupMenu::get_item_ID(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),0);
return items[p_idx].ID;
}
int PopupMenu::get_item_index(int p_ID) const {
for(int i=0;i<items.size();i++) {
if (items[i].ID==p_ID)
return i;
}
return -1;
}
String PopupMenu::get_item_submenu(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),"");
return items[p_idx].submenu;
}
String PopupMenu::get_item_tooltip(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),"");
return items[p_idx].tooltip;
}
Ref<ShortCut> PopupMenu::get_item_shortcut(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),Ref<ShortCut>());
return items[p_idx].shortcut;
}
void PopupMenu::set_item_as_separator(int p_idx, bool p_separator) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].separator=p_separator;
update();
}
bool PopupMenu::is_item_separator(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),false);
return items[p_idx].separator;
}
void PopupMenu::set_item_as_checkable(int p_idx, bool p_checkable) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].checkable=p_checkable;
update();
}
void PopupMenu::set_item_tooltip(int p_idx,const String& p_tooltip) {
ERR_FAIL_INDEX(p_idx,items.size());
items[p_idx].tooltip=p_tooltip;
update();
}
void PopupMenu::set_item_shortcut(int p_idx, const Ref<ShortCut>& p_shortcut) {
ERR_FAIL_INDEX(p_idx,items.size());
if (items[p_idx].shortcut.is_valid()) {
_unref_shortcut(items[p_idx].shortcut);
}
items[p_idx].shortcut=p_shortcut;
if (items[p_idx].shortcut.is_valid()) {
_ref_shortcut(items[p_idx].shortcut);
}
update();
}
bool PopupMenu::is_item_checkable(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx,items.size(),false);
return items[p_idx].checkable;
}
int PopupMenu::get_item_count() const {
return items.size();
}
bool PopupMenu::activate_item_by_event(const InputEvent& p_event) {
uint32_t code=0;
if (p_event.type==InputEvent::KEY) {
code=p_event.key.scancode;
if (code==0)
code=p_event.key.unicode;
if (p_event.key.mod.control)
code|=KEY_MASK_CTRL;
if (p_event.key.mod.alt)
code|=KEY_MASK_ALT;
if (p_event.key.mod.meta)
code|=KEY_MASK_META;
if (p_event.key.mod.shift)
code|=KEY_MASK_SHIFT;
}
int il=items.size();
for(int i=0;i<il;i++) {
if (is_item_disabled(i))
continue;
if (items[i].shortcut.is_valid() && items[i].shortcut->is_shortcut(p_event)) {
activate_item(i);
return true;
}
if (code!=0 && items[i].accel==code) {
activate_item(i);
return true;
}
if (items[i].submenu!="") {
Node* n = get_node(items[i].submenu);
if(!n)
continue;
PopupMenu* pm = n->cast_to<PopupMenu>();
if(!pm)
continue;
if(pm->activate_item_by_event(p_event)) {
return true;
}
}
}
return false;
}
void PopupMenu::activate_item(int p_item) {
ERR_FAIL_INDEX(p_item,items.size());
ERR_FAIL_COND(items[p_item].separator);
int id = items[p_item].ID>=0?items[p_item].ID:p_item;
emit_signal("item_pressed",id);
//hide all parent PopupMenue's
Node *next = get_parent();
PopupMenu *pop = next->cast_to<PopupMenu>();
while (pop) {
// We close all parents that are chained together,
// with hide_on_item_selection enabled
if(hide_on_item_selection && pop->is_hide_on_item_selection()) {
pop->hide();
next = next->get_parent();
pop = next->cast_to<PopupMenu>();
}
else {
// Break out of loop when the next parent has
// hide_on_item_selection disabled
break;
}
}
// Hides popup by default; unless otherwise specified
// by using set_hide_on_item_selection
if (hide_on_item_selection) {
hide();
}
}
void PopupMenu::remove_item(int p_idx) {
ERR_FAIL_INDEX(p_idx,items.size());
if (items[p_idx].shortcut.is_valid()) {
_unref_shortcut(items[p_idx].shortcut);
}
items.remove(p_idx);
update();
}
void PopupMenu::add_separator() {
Item sep;
sep.separator=true;
sep.ID=-1;
items.push_back(sep);
update();
}
void PopupMenu::clear() {
for(int i=0;i<items.size();i++) {
if (items[i].shortcut.is_valid()) {
_unref_shortcut(items[i].shortcut);
}
}
items.clear();
mouse_over=-1;
update();
}
Array PopupMenu::_get_items() const {
Array items;
for(int i=0;i<get_item_count();i++) {
items.push_back(get_item_text(i));
items.push_back(get_item_icon(i));
items.push_back(is_item_checkable(i));
items.push_back(is_item_checked(i));
items.push_back(is_item_disabled(i));
items.push_back(get_item_ID(i));
items.push_back(get_item_accelerator(i));
items.push_back(get_item_metadata(i));
items.push_back(get_item_submenu(i));
items.push_back(is_item_separator(i));
}
return items;
}
void PopupMenu::_ref_shortcut( Ref<ShortCut> p_sc) {
if (!shortcut_refcount.has(p_sc)) {
shortcut_refcount[p_sc]=1;
p_sc->connect("changed",this,"update");
} else {
shortcut_refcount[p_sc]+=1;
}
}
void PopupMenu::_unref_shortcut(Ref<ShortCut> p_sc) {
ERR_FAIL_COND(!shortcut_refcount.has(p_sc));
shortcut_refcount[p_sc]--;
if (shortcut_refcount[p_sc]==0) {
p_sc->disconnect("changed",this,"update");
shortcut_refcount.erase(p_sc);
}
}
void PopupMenu::_set_items(const Array& p_items){
ERR_FAIL_COND(p_items.size() % 10);
clear();
for(int i=0;i<p_items.size();i+=10) {
String text=p_items[i+0];
Ref<Texture> icon=p_items[i+1];
bool checkable=p_items[i+2];
bool checked=p_items[i+3];
bool disabled=p_items[i+4];
int id=p_items[i+5];
int accel=p_items[i+6];
Variant meta=p_items[i+7];
String subm=p_items[i+8];
bool sep=p_items[i+9];
int idx=get_item_count();
add_item(text,id);
set_item_icon(idx,icon);
set_item_as_checkable(idx,checkable);
set_item_checked(idx,checked);
set_item_disabled(idx,disabled);
set_item_ID(idx,id);
set_item_metadata(idx,meta);
set_item_as_separator(idx,sep);
set_item_accelerator(idx,accel);
set_item_submenu(idx,subm);
}
}
// Hide on item selection determines whether or not the popup will close after item selection
void PopupMenu::set_hide_on_item_selection(bool p_enabled) {
hide_on_item_selection=p_enabled;
}
bool PopupMenu::is_hide_on_item_selection() {
return hide_on_item_selection;
}
String PopupMenu::get_tooltip(const Point2& p_pos) const {
int over=_get_mouse_over(p_pos);
if (over<0 || over>=items.size())
return "";
return items[over].tooltip;
}
void PopupMenu::set_parent_rect(const Rect2& p_rect) {
parent_rect=p_rect;
}
void PopupMenu::get_translatable_strings(List<String> *p_strings) const {
for(int i=0;i<items.size();i++) {
if (items[i].text!="")
p_strings->push_back(items[i].text);
}
}
void PopupMenu::add_autohide_area(const Rect2& p_area) {
autohide_areas.push_back(p_area);
}
void PopupMenu::clear_autohide_areas(){
autohide_areas.clear();
}
void PopupMenu::_bind_methods() {
ObjectTypeDB::bind_method(_MD("_input_event"),&PopupMenu::_input_event);
ObjectTypeDB::bind_method(_MD("add_icon_item","texture","label","id","accel"),&PopupMenu::add_icon_item,DEFVAL(-1),DEFVAL(0));
ObjectTypeDB::bind_method(_MD("add_item","label","id","accel"),&PopupMenu::add_item,DEFVAL(-1),DEFVAL(0));
ObjectTypeDB::bind_method(_MD("add_icon_check_item","texture","label","id","accel"),&PopupMenu::add_icon_check_item,DEFVAL(-1),DEFVAL(0));
ObjectTypeDB::bind_method(_MD("add_check_item","label","id","accel"),&PopupMenu::add_check_item,DEFVAL(-1),DEFVAL(0));
ObjectTypeDB::bind_method(_MD("add_submenu_item","label","submenu","id"),&PopupMenu::add_submenu_item,DEFVAL(-1));
ObjectTypeDB::bind_method(_MD("add_icon_shortcut","texture","shortcut:ShortCut","id"),&PopupMenu::add_icon_shortcut,DEFVAL(-1));
ObjectTypeDB::bind_method(_MD("add_shortcut","shortcut:ShortCut","id"),&PopupMenu::add_shortcut,DEFVAL(-1));
ObjectTypeDB::bind_method(_MD("add_icon_check_shortcut","texture","shortcut:ShortCut","id"),&PopupMenu::add_icon_check_shortcut,DEFVAL(-1));
ObjectTypeDB::bind_method(_MD("add_check_shortcut","shortcut:ShortCut","id"),&PopupMenu::add_check_shortcut,DEFVAL(-1));
ObjectTypeDB::bind_method(_MD("set_item_text","idx","text"),&PopupMenu::set_item_text);
ObjectTypeDB::bind_method(_MD("set_item_icon","idx","icon"),&PopupMenu::set_item_icon);
ObjectTypeDB::bind_method(_MD("set_item_checked","idx","checked"),&PopupMenu::set_item_checked);
ObjectTypeDB::bind_method(_MD("set_item_ID","idx","id"),&PopupMenu::set_item_ID);
ObjectTypeDB::bind_method(_MD("set_item_accelerator","idx","accel"),&PopupMenu::set_item_accelerator);
ObjectTypeDB::bind_method(_MD("set_item_metadata","idx","metadata"),&PopupMenu::set_item_metadata);
ObjectTypeDB::bind_method(_MD("set_item_disabled","idx","disabled"),&PopupMenu::set_item_disabled);
ObjectTypeDB::bind_method(_MD("set_item_submenu","idx","submenu"),&PopupMenu::set_item_submenu);
ObjectTypeDB::bind_method(_MD("set_item_as_separator","idx","enable"),&PopupMenu::set_item_as_separator);
ObjectTypeDB::bind_method(_MD("set_item_as_checkable","idx","enable"),&PopupMenu::set_item_as_checkable);
ObjectTypeDB::bind_method(_MD("set_item_tooltip","idx","tooltip"),&PopupMenu::set_item_tooltip);
ObjectTypeDB::bind_method(_MD("set_item_shortcut","idx","shortcut:ShortCut"),&PopupMenu::set_item_shortcut);
ObjectTypeDB::bind_method(_MD("toggle_item_checked","idx"), &PopupMenu::toggle_item_checked);
ObjectTypeDB::bind_method(_MD("get_item_text","idx"),&PopupMenu::get_item_text);
ObjectTypeDB::bind_method(_MD("get_item_icon","idx"),&PopupMenu::get_item_icon);
ObjectTypeDB::bind_method(_MD("is_item_checked","idx"),&PopupMenu::is_item_checked);
ObjectTypeDB::bind_method(_MD("get_item_ID","idx"),&PopupMenu::get_item_ID);
ObjectTypeDB::bind_method(_MD("get_item_index","id"),&PopupMenu::get_item_index);
ObjectTypeDB::bind_method(_MD("get_item_accelerator","idx"),&PopupMenu::get_item_accelerator);
ObjectTypeDB::bind_method(_MD("get_item_metadata","idx"),&PopupMenu::get_item_metadata);
ObjectTypeDB::bind_method(_MD("is_item_disabled","idx"),&PopupMenu::is_item_disabled);
ObjectTypeDB::bind_method(_MD("get_item_submenu","idx"),&PopupMenu::get_item_submenu);
ObjectTypeDB::bind_method(_MD("is_item_separator","idx"),&PopupMenu::is_item_separator);
ObjectTypeDB::bind_method(_MD("is_item_checkable","idx"),&PopupMenu::is_item_checkable);
ObjectTypeDB::bind_method(_MD("get_item_tooltip","idx"),&PopupMenu::get_item_tooltip);
ObjectTypeDB::bind_method(_MD("get_item_shortcut:ShortCut","idx"),&PopupMenu::get_item_shortcut);
ObjectTypeDB::bind_method(_MD("get_item_count"),&PopupMenu::get_item_count);
ObjectTypeDB::bind_method(_MD("remove_item","idx"),&PopupMenu::remove_item);
ObjectTypeDB::bind_method(_MD("add_separator"),&PopupMenu::add_separator);
ObjectTypeDB::bind_method(_MD("clear"),&PopupMenu::clear);
ObjectTypeDB::bind_method(_MD("_set_items"),&PopupMenu::_set_items);
ObjectTypeDB::bind_method(_MD("_get_items"),&PopupMenu::_get_items);
ObjectTypeDB::bind_method(_MD("set_hide_on_item_selection","enable"),&PopupMenu::set_hide_on_item_selection);
ObjectTypeDB::bind_method(_MD("is_hide_on_item_selection"),&PopupMenu::is_hide_on_item_selection);
ObjectTypeDB::bind_method(_MD("_submenu_timeout"),&PopupMenu::_submenu_timeout);
ADD_PROPERTY( PropertyInfo(Variant::ARRAY,"items",PROPERTY_HINT_NONE,"",PROPERTY_USAGE_NOEDITOR), _SCS("_set_items"),_SCS("_get_items") );
ADD_PROPERTYNO( PropertyInfo(Variant::BOOL, "hide_on_item_selection" ), _SCS("set_hide_on_item_selection"), _SCS("is_hide_on_item_selection") );
ADD_SIGNAL( MethodInfo("item_pressed", PropertyInfo( Variant::INT,"ID") ) );
}
void PopupMenu::set_invalidate_click_until_motion() {
moved=Vector2();
invalidated_click=true;
}
PopupMenu::PopupMenu() {
mouse_over=-1;
set_focus_mode(FOCUS_ALL);
set_as_toplevel(true);
set_hide_on_item_selection(true);
submenu_timer = memnew( Timer );
submenu_timer->set_wait_time(0.3);
submenu_timer->set_one_shot(true);
submenu_timer->connect("timeout",this,"_submenu_timeout");
add_child(submenu_timer);
}
PopupMenu::~PopupMenu() {
}