This is a particular kind of PGItem that handles simple one-line or short multi-line text entries, of the sort where the user can type any string. More...

#include "pgEntry.h"

Inheritance diagram for PGEntry:

Public Types
enum	State { S_focus = 0, S_no_focus, S_inactive }

Public Types inherited from PandaNode
enum	FancyBits { FB_transform = 0x0001, FB_state = 0x0002, FB_effects = 0x0004, FB_tag = 0x0010, FB_draw_mask = 0x0020, FB_cull_callback = 0x0040 }

typedef bool	SceneRootFunc(const PandaNode *)

enum	UnexpectedChange { UC_parents = 0x001, UC_children = 0x002, UC_transform = 0x004, UC_state = 0x008, UC_draw_mask = 0x010 }

Public Member Functions
	PGEntry (const std::string &name)

virtual void	accept (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the entry is accepted by the user pressing Enter normally. More...

virtual void	accept_failed (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the user presses Enter but we can't accept the input. More...

virtual void	candidate (const MouseWatcherParameter &param, bool background)
	This is a callback hook function, called whenever the user selects an item from the IME menu. More...

void	clear_cursor_def ()
	Removes all the children from the cursor_def node, in preparation for adding a new definition. More...

virtual bool	cull_callback (CullTraverser *trav, CullTraverserData &data)
	This function will be called during the cull traversal to perform any additional operations that should be performed at cull time. More...

virtual void	cursormove ()
	This is a callback hook function, called whenever the cursor moves. More...

virtual void	erase (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the user erase characters in the text. More...

virtual TypeHandle	force_init_type ()

std::string	get_accept_event (const ButtonHandle &button) const
	Returns the event name that will be thrown when the entry is accepted normally. More...

std::string	get_accept_failed_event (const ButtonHandle &button) const
	Returns the event name that will be thrown when the entry cannot accept an input. More...

PN_stdfloat	get_blink_rate () const
	Returns the number of times per second the cursor will blink, or 0 if the cursor is not to blink. More...

const std::string &	get_candidate_active () const
	See set_candidate_active(). More...

const std::string &	get_candidate_inactive () const
	See set_candidate_inactive(). More...

wchar_t	get_character (int n) const
	Returns the character at the indicated position in the entry. More...

NodePath	get_cursor_def ()
	Returns the Node that will be rendered to represent the cursor. More...

bool	get_cursor_keys_active () const
	Returns whether the arrow keys are currently set to control movement of the cursor; see set_cursor_keys_active(). More...

int	get_cursor_position () const
	Returns the current position of the cursor. More...

PN_stdfloat	get_cursor_X () const
	Returns the node position x of the cursor. More...

PN_stdfloat	get_cursor_Y () const
	Returns the node position y of the cursor. More...

std::string	get_cursormove_event () const
	Returns the event name that will be thrown whenever the cursor moves. More...

std::string	get_erase_event () const
	Returns the event name that will be thrown whenever the user erases characters in the text. More...

const TextGraphic *	get_graphic (int n) const
	Returns the graphic object at the indicated position in the pre-wordwrapped string. More...

int	get_max_chars () const
	Returns the current maximum number of characters that may be typed into the entry, or 0 if there is no limit. More...

PN_stdfloat	get_max_width () const
	Returns the current maximum width of the characters that may be typed into the entry, or 0 if there is no limit. More...

int	get_num_characters () const
	Returns the number of characters of text in the entry. More...

int	get_num_lines () const
	Returns the number of lines of text the PGEntry will use, if _max_width is not 0. More...

bool	get_obscure_mode () const
	Specifies whether obscure mode is enabled. More...

std::string	get_overflow_event () const
	Returns the event name that will be thrown when too much text is attempted to be entered into the PGEntry, exceeding either the limit set via set_max_chars() or via set_max_width(). More...

bool	get_overflow_mode () const
	Specifies whether overflow mode is enabled. More...

std::string	get_plain_text () const
	Returns the text currently displayed within the entry, without any embedded properties characters. More...

std::wstring	get_plain_wtext () const
	Returns the text currently displayed within the entry, without any embedded properties characters. More...

const TextProperties &	get_properties (int n) const
	Returns the TextProperties in effect for the object at the indicated position in the pre-wordwrapped string. More...

std::string	get_text () const
	Returns the text currently displayed within the entry. More...

TextNode *	get_text_def (int state) const
	Returns the TextNode that will be used to render the text within the entry when the entry is in the indicated state. More...

virtual TypeHandle	get_type () const

std::string	get_type_event () const
	Returns the event name that will be thrown whenever the user extends the text by typing. More...

std::wstring	get_wtext () const
	Returns the text currently displayed within the entry. More...

bool	is_wtext () const
	Returns true if any of the characters in the string returned by get_wtext() are out of the range of an ASCII character (and, therefore, get_wtext() should be called in preference to get_text()). More...

virtual void	keystroke (const MouseWatcherParameter &param, bool background)
	This is a callback hook function, called whenever the user types a key. More...

virtual PandaNode *	make_copy () const
	Returns a newly-allocated Node that is a shallow copy of this one. More...

virtual void	overflow (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the entry is overflowed because the user attempts to type too many characters, exceeding either set_max_chars() or set_max_width(). More...

virtual void	press (const MouseWatcherParameter &param, bool background)
	This is a callback hook function, called whenever a mouse or keyboard entry is depressed while the mouse is within the region. More...

void	set_accept_enabled (bool enabled)
	Sets whether the input may be accepted–use to disable submission by the user. More...

virtual void	set_active (bool active)
	Toggles the active/inactive state of the entry. More...

void	set_blink_rate (PN_stdfloat blink_rate)
	Sets the number of times per second the cursor will blink while the entry has keyboard focus. More...

void	set_candidate_active (const std::string &candidate_active)
	Specifies the name of the TextProperties structure added to the TextPropertiesManager that will be used to render candidate strings from the IME, used for typing characters in east Asian languages. More...

void	set_candidate_inactive (const std::string &candidate_inactive)
	Specifies the name of the TextProperties structure added to the TextPropertiesManager that will be used to render candidate strings from the IME, used for typing characters in east Asian languages. More...

void	set_cursor_keys_active (bool flag)
	Sets whether the arrow keys (and home/end) control movement of the cursor. More...

void	set_cursor_position (int position)
	Sets the current position of the cursor. More...

virtual void	set_focus (bool focus)
	Toggles the focus state of the entry. More...

void	set_max_chars (int max_chars)
	Sets the maximum number of characters that may be typed into the entry. More...

void	set_max_width (PN_stdfloat max_width)
	Sets the maximum width of all characters that may be typed into the entry. More...

void	set_num_lines (int num_lines)
	Sets the number of lines of text the PGEntry will use. More...

void	set_obscure_mode (bool flag)
	Specifies whether obscure mode should be enabled. More...

void	set_overflow_mode (bool flag)
	Specifies whether overflow mode should be enabled. More...

bool	set_text (const std::string &text)
	Changes the text currently displayed within the entry. More...

void	set_text_def (int state, TextNode *node)
	Changes the TextNode that will be used to render the text within the entry when the entry is in the indicated state. More...

bool	set_wtext (const std::wstring &wtext)
	Changes the text currently displayed within the entry. More...

void	setup (PN_stdfloat width, int num_lines)
	Sets up the entry for normal use. More...

void	setup_minimal (PN_stdfloat width, int num_lines)
	Sets up the entry without creating any frame or other decoration. More...

virtual void	type (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the user extends the text by typing. More...

virtual void	xform (const LMatrix4 &mat)
	Transforms the contents of this node by the indicated matrix, if it means anything to do so. More...

Public Member Functions inherited from PGItem
	PGItem (const std::string &name)

void	clear_frame ()
	Removes the bounding rectangle from the item. More...

void	clear_state_def (int state)
	Resets the NodePath assigned to the indicated state to its initial default, with only a frame representation if appropriate. More...

virtual void	enter_region (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the mouse enters the region. More...

virtual void	exit_region (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the mouse exits the region. More...

virtual void	focus_in ()
	This is a callback hook function, called whenever the widget gets the keyboard focus. More...

virtual void	focus_out ()
	This is a callback hook function, called whenever the widget loses the keyboard focus. More...

bool	get_active () const
	Returns whether the PGItem is currently active for mouse events. More...

bool	get_background_focus () const
	Returns whether background_focus is currently enabled. More...

std::string	get_enter_event () const
	Returns the event name that will be thrown when the item is active and the mouse enters its frame, but not any nested frames. More...

std::string	get_exit_event () const
	Returns the event name that will be thrown when the item is active and the mouse exits its frame, or enters a nested frame. More...

bool	get_focus () const
	Returns whether the PGItem currently has focus for keyboard events. More...

std::string	get_focus_in_event () const
	Returns the event name that will be thrown when the item gets the keyboard focus. More...

std::string	get_focus_out_event () const
	Returns the event name that will be thrown when the item loses the keyboard focus. More...

const LVecBase4 &	get_frame () const
	Returns the bounding rectangle of the item. More...

LMatrix4	get_frame_inv_xform () const
	Returns the inverse of the frame transform matrix. More...

PGFrameStyle	get_frame_style (int state)
	Returns the kind of frame that will be drawn behind the item when it is in the indicated state. More...

const std::string &	get_id () const
	Returns the unique ID assigned to this PGItem. More...

std::string	get_keystroke_event () const
	Returns the event name that will be thrown when the item is active and any key is pressed by the user. More...

PGItemNotify *	get_notify () const
	Returns the object which will be notified when the PGItem changes, if any. More...

int	get_num_state_defs () const

std::string	get_press_event (const ButtonHandle &button) const
	Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is depressed while the mouse is within the frame. More...

PGMouseWatcherRegion *	get_region () const
	Returns the MouseWatcherRegion associated with this item. More...

std::string	get_release_event (const ButtonHandle &button) const
	Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button, formerly clicked down is within the frame, is released. More...

std::string	get_repeat_event (const ButtonHandle &button) const
	Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is continuously held down while the mouse is within the frame. More...

int	get_state () const
	Returns the "state" of this particular PGItem. More...

NodePath &	get_state_def (int state)

int	get_suppress_flags () const
	This is just an interface to get the suppress flags on the underlying MouseWatcherRegion. More...

std::string	get_within_event () const
	Returns the event name that will be thrown when the item is active and the mouse moves within the boundaries of the frame. More...

std::string	get_without_event () const
	Returns the event name that will be thrown when the item is active and the mouse moves completely outside the boundaries of the frame. More...

bool	has_frame () const
	Returns true if the item has a bounding rectangle; see set_frame(). More...

bool	has_notify () const
	Returns true if there is an object configured to be notified when the PGItem changes, false otherwise. More...

bool	has_state_def (int state) const
	Returns true if get_state_def() has ever been called for the indicated state (thus defining a render subgraph for this state index), false otherwise. More...

NodePath	instance_to_state_def (int state, const NodePath &path)
	Parents an instance of the bottom node of the indicated NodePath to the indicated state index. More...

virtual void	move (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever a mouse is moved while within the region. More...

virtual void	release (const MouseWatcherParameter &param, bool background)
	This is a callback hook function, called whenever a mouse or keyboard button previously depressed with press() is released. More...

void	set_background_focus (bool focus)
	Sets the background_focus flag for this item. More...

void	set_frame (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
	Sets the bounding rectangle of the item, in local coordinates. More...

void	set_frame (const LVecBase4 &frame)
	Sets the bounding rectangle of the item, in local coordinates. More...

void	set_frame_style (int state, const PGFrameStyle &style)
	Changes the kind of frame that will be drawn behind the item when it is in the indicated state. More...

void	set_id (const std::string &id)
	Set the unique ID assigned to this PGItem. More...

void	set_name (const std::string &name)

void	set_notify (PGItemNotify *notify)
	Sets the object which will be notified when the PGItem changes. More...

void	set_state (int state)
	Sets the "state" of this particular PGItem. More...

void	set_suppress_flags (int suppress_flags)
	This is just an interface to set the suppress flags on the underlying MouseWatcherRegion. More...

virtual void	within_region (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the mouse moves within the boundaries of the region, even if it is also within the boundaries of a nested region. More...

virtual void	without_region (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region. More...

Public Member Functions inherited from PandaNode
	PandaNode (const std::string &name)

void	add_child (PandaNode child_node, int sort=0, Thread current_thread=Thread::get_current_thread())

virtual void	add_for_draw (CullTraverser *trav, CullTraverserData &data)
	Adds the node's contents to the CullResult we are building up during the cull traversal, so that it will be drawn at render time. More...

void	add_stashed (PandaNode child_node, int sort=0, Thread current_thread=Thread::get_current_thread())
	Adds a new child to the node, directly as a stashed child. More...

void	adjust_draw_mask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
	Adjusts the hide/show bits of this particular node. More...

virtual void	apply_attribs_to_vertices (const AccumulatedAttribs &attribs, int attrib_types, GeomTransformer &transformer)
	Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate. More...

virtual Light *	as_light ()
	Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...

void	clear_attrib (TypeHandle type)

void	clear_attrib (int slot)
	Removes the render attribute of the given type from this node. More...

void	clear_bounds ()
	Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...

void	clear_effect (TypeHandle type)
	Removes the render effect of the given type from this node. More...

void	clear_effects (Thread *current_thread=Thread::get_current_thread())

void	clear_state (Thread *current_thread=Thread::get_current_thread())

void	clear_tag (const std::string &key, Thread *current_thread=Thread::get_current_thread())

void	clear_transform (Thread *current_thread=Thread::get_current_thread())

void	clear_unexpected_change (unsigned int flags)
	Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. More...

virtual PandaNode *	combine_with (PandaNode *other)
	Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More...

int	compare_tags (const PandaNode *other) const
	Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. More...

void	copy_all_properties (PandaNode *other)
	Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...

void	copy_children (PandaNode other, Thread current_thread=Thread::get_current_thread())
	Makes another instance of all the children of the other node, copying them to this node. More...

void	copy_tags (PandaNode *other)
	Copies all of the tags stored on the other node onto this node. More...

int	count_num_descendants () const

virtual	CPT (TransformState) calc_tight_bounds(LPoint3 &min_point

	CPT (RenderAttrib) get_attrib(TypeHandle type) const

	CPT (RenderAttrib) get_attrib(int slot) const

	CPT (RenderEffect) get_effect(TypeHandle type) const

	CPT (RenderState) get_state(Thread *current_thread

	CPT (RenderEffects) get_effects(Thread *current_thread

	CPT (TransformState) get_transform(Thread *current_thread

	CPT (TransformState) get_prev_transform(Thread *current_thread

	CPT (RenderAttrib) get_off_clip_planes(Thread *current_thread

	CPT (BoundingVolume) get_bounds(Thread *current_thread

	CPT (BoundingVolume) get_bounds(UpdateSeq &seq

	CPT (BoundingVolume) get_internal_bounds(Thread *current_thread

virtual PandaNode *	dupe_for_flatten () const
	This is similar to make_copy(), but it makes a copy for the specific purpose of flatten. More...

int	find_child (PandaNode node, Thread current_thread=Thread::get_current_thread()) const
	Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...

int	find_parent (PandaNode node, Thread current_thread=Thread::get_current_thread()) const
	Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...

int	find_stashed (PandaNode node, Thread current_thread=Thread::get_current_thread()) const
	Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...

BoundingVolume::BoundsType	get_bounds_type () const

PandaNode *	get_child (int n, Thread *current_thread=Thread::get_current_thread()) const

int	get_child_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
	Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...

Children	get_children (Thread *current_thread=Thread::get_current_thread()) const

DrawMask	get_draw_control_mask () const

DrawMask	get_draw_show_mask () const

int	get_fancy_bits (Thread *current_thread=Thread::get_current_thread()) const
	Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...

virtual int	get_first_visible_child () const
	Returns the index number of the first visible child of this node, or a number >= get_num_children() if there are no visible children of this node. More...

int	get_internal_vertices (Thread *current_thread=Thread::get_current_thread()) const

CollideMask	get_into_collide_mask () const

virtual CollideMask	get_legal_collide_mask () const

int	get_nested_vertices (Thread *current_thread=Thread::get_current_thread()) const

CollideMask	get_net_collide_mask (Thread *current_thread=Thread::get_current_thread()) const
	Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...

DrawMask	get_net_draw_control_mask () const
	Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...

DrawMask	get_net_draw_show_mask () const
	Returns the union of all draw_show_mask values–of renderable nodes only– at this level and below. More...

virtual int	get_next_visible_child (int n) const
	Returns the index number of the next visible child of this node following the indicated child, or a number >= get_num_children() if there are no more visible children of this node. More...

int	get_num_children (Thread *current_thread=Thread::get_current_thread()) const

int	get_num_parents (Thread *current_thread=Thread::get_current_thread()) const

int	get_num_stashed (Thread *current_thread=Thread::get_current_thread()) const

size_t	get_num_tags () const

PandaNode *	get_parent (int n, Thread *current_thread=Thread::get_current_thread()) const

Parents	get_parents (Thread *current_thread=Thread::get_current_thread()) const

PandaNode *	get_stashed (int n, Thread *current_thread=Thread::get_current_thread()) const

Stashed	get_stashed (Thread *current_thread=Thread::get_current_thread()) const

int	get_stashed_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
	Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...

std::string	get_tag (const std::string &key, Thread *current_thread=Thread::get_current_thread()) const

std::string	get_tag_key (size_t i) const

void	get_tag_keys (vector_string &keys) const
	Fills the given vector up with the list of tags on this PandaNode. More...

unsigned int	get_unexpected_change (unsigned int flags) const
	Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More...

virtual int	get_unsafe_to_apply_attribs () const
	Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node. More...

virtual int	get_visible_child () const
	Returns the index number of the currently visible child of this node. More...

bool	has_attrib (TypeHandle type) const

bool	has_attrib (int slot) const

bool	has_dirty_prev_transform () const

bool	has_effect (TypeHandle type) const

virtual bool	has_selective_visibility () const
	Should be overridden by derived classes to return true if this kind of node has some restrictions on the set of children that should be rendered. More...

virtual bool	has_single_child_visibility () const
	Should be overridden by derived classes to return true if this kind of node has the special property that just one of its children is visible at any given time, and furthermore that the particular visible child can be determined without reference to any external information (such as a camera). More...

bool	has_tag (const std::string &key, Thread *current_thread=Thread::get_current_thread()) const

bool	has_tags () const

virtual bool	is_ambient_light () const
	Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...

bool	is_bounds_stale () const

virtual bool	is_collision_node () const
	A simple downcast check. More...

bool	is_final (Thread *current_thread=Thread::get_current_thread()) const

virtual bool	is_geom_node () const
	A simple downcast check. More...

virtual bool	is_lod_node () const
	A simple downcast check. More...

bool	is_overall_hidden () const

bool	is_scene_root () const
	Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...

bool	is_under_scene_root () const
	Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. More...

void	list_tags (std::ostream &out, const std::string &separator="\n") const
	Writes a list of all the tag keys assigned to the node to the indicated stream. More...

void	ls (std::ostream &out, int indent_level) const

void	mark_bounds_stale (Thread *current_thread=Thread::get_current_thread()) const

void	mark_internal_bounds_stale (Thread *current_thread=Thread::get_current_thread())

virtual void	output (std::ostream &out) const

void	prepare_scene (GraphicsStateGuardianBase gsg, const RenderState node_state)

virtual bool	preserve_name () const
	Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise. More...

	PT (PandaNode) copy_subgraph(Thread *current_thread

void	remove_all_children (Thread *current_thread=Thread::get_current_thread())
	Removes all the children from the node at once, including stashed children. More...

void	remove_child (int child_index, Thread *current_thread=Thread::get_current_thread())
	Removes the nth child from the node. More...

bool	remove_child (PandaNode child_node, Thread current_thread=Thread::get_current_thread())
	Removes the indicated child from the node. More...

void	remove_stashed (int child_index, Thread *current_thread=Thread::get_current_thread())
	Removes the nth stashed child from the node. More...

bool	replace_child (PandaNode orig_child, PandaNode new_child, Thread *current_thread=Thread::get_current_thread())
	Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...

void	replace_node (PandaNode *other)
	Inserts this node into the scene graph in place of the other one, and removes the other node. More...

void	reset_prev_transform (Thread *current_thread=Thread::get_current_thread())
	Resets the transform that represents this node's "previous" position to the same as the current transform. More...

virtual bool	safe_to_combine () const
	Returns true if it is generally safe to combine this particular kind of PandaNode with other kinds of PandaNodes of compatible type, adding children or whatever. More...

virtual bool	safe_to_combine_children () const
	Returns true if it is generally safe to combine the children of this PandaNode with each other. More...

virtual bool	safe_to_flatten () const
	Returns true if it is generally safe to flatten out this particular kind of PandaNode by duplicating instances (by calling dupe_for_flatten()), false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful). More...

virtual bool	safe_to_flatten_below () const
	Returns true if a flatten operation may safely continue past this node, or false if nodes below this node may not be molested. More...

virtual bool	safe_to_modify_transform () const
	Returns true if it is safe to automatically adjust the transform on this kind of node. More...

virtual bool	safe_to_transform () const
	Returns true if it is generally safe to transform this particular kind of PandaNode by calling the xform() method, false otherwise. More...

void	set_attrib (const RenderAttrib *attrib, int override=0)
	Adds the indicated render attribute to the scene graph on this node. More...

void	set_bound (const BoundingVolume *volume)
	Deprecated. More...

void	set_bounds (const BoundingVolume *volume)
	Resets the bounding volume so that it is the indicated volume. More...

void	set_bounds_type (BoundingVolume::BoundsType bounds_type)
	Specifies the desired type of bounding volume that will be created for this node. More...

void	set_effect (const RenderEffect *effect)
	Adds the indicated render effect to the scene graph on this node. More...

void	set_effects (const RenderEffects effects, Thread current_thread=Thread::get_current_thread())

void	set_final (bool flag)

void	set_into_collide_mask (CollideMask mask)

void	set_overall_hidden (bool overall_hidden)

void	set_prev_transform (const TransformState transform, Thread current_thread=Thread::get_current_thread())
	Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...

void	set_state (const RenderState state, Thread current_thread=Thread::get_current_thread())

void	set_tag (const std::string &key, const std::string &value, Thread *current_thread=Thread::get_current_thread())

void	set_transform (const TransformState transform, Thread current_thread=Thread::get_current_thread())

void	set_unexpected_change (unsigned int flags)
	Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. More...

bool	stash_child (PandaNode child_node, Thread current_thread=Thread::get_current_thread())
	Stashes the indicated child node. More...

void	stash_child (int child_index, Thread *current_thread=Thread::get_current_thread())
	Stashes the indicated child node. More...

void	steal_children (PandaNode other, Thread current_thread=Thread::get_current_thread())
	Moves all the children from the other node onto this node. More...

bool	unstash_child (PandaNode child_node, Thread current_thread=Thread::get_current_thread())
	Returns the indicated stashed node to normal child status. More...

void	unstash_child (int stashed_index, Thread *current_thread=Thread::get_current_thread())
	Returns the indicated stashed node to normal child status. More...

virtual void	update_bam_nested (BamWriter *manager)
	Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...

virtual void	write (std::ostream &out, int indent_level) const

virtual void	write_datagram (BamWriter *manager, Datagram &dg)
	Writes the contents of this object to the datagram for shipping out to a Bam file. More...

void	write_recorder (BamWriter *manager, Datagram &dg)
	This method is provided for the benefit of classes (like MouseRecorder) that inherit from PandaMode and also RecorderBase. More...

Public Member Functions inherited from TypedWritableReferenceCount
	TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)

virtual ReferenceCount *	as_reference_count ()
	Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...

void	operator= (const TypedWritableReferenceCount &copy)

Public Member Functions inherited from TypedWritable
	TypedWritable (const TypedWritable &copy)

virtual int	complete_pointers (TypedWritable *p_list, BamReader manager)
	Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...

vector_uchar	encode_to_bam_stream () const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...

bool	encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...

virtual void	finalize (BamReader *manager)
	Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...

UpdateSeq	get_bam_modified () const
	Returns the current bam_modified counter. More...

void	mark_bam_modified ()
	Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...

void	operator= (const TypedWritable &copy)

virtual bool	require_fully_complete () const
	Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

int	get_best_parent_from_Set (const std::set< int > &) const

int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...

bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly. More...

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type. More...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object. More...

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...

void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...

void	ref () const
	Explicitly increments the reference count. More...

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. More...

bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus. More...

bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...

virtual bool	unref () const
	Explicitly decrements the reference count. More...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object. More...

Public Member Functions inherited from Namable
	Namable (const std::string &initial_name="")

void	clear_name ()
	Resets the Namable's name to empty. More...

const std::string &	get_name () const

bool	has_name () const
	Returns true if the Namable has a nonempty name set, false if the name is empty. More...

void	output (std::ostream &out) const
	Outputs the Namable. More...

void	set_name (const std::string &name)

Static Public Member Functions
static std::string	get_accept_failed_prefix ()
	Returns the prefix that is used to define the accept failed event for all PGEntries. More...

static std::string	get_accept_prefix ()
	Returns the prefix that is used to define the accept event for all PGEntries. More...

static TypeHandle	get_class_type ()

static std::string	get_cursormove_prefix ()
	Returns the prefix that is used to define the cursor event for all PGEntries. More...

static std::string	get_erase_prefix ()
	Returns the prefix that is used to define the erase event for all PGEntries. More...

static std::string	get_overflow_prefix ()
	Returns the prefix that is used to define the overflow event for all PGEntries. More...

static std::string	get_type_prefix ()
	Returns the prefix that is used to define the type event for all PGEntries. More...

static void	init_type ()

Static Public Member Functions inherited from PGItem
static void	background_candidate (const MouseWatcherParameter &param)
	Calls candidate() on all the PGItems with background focus. More...

static void	background_keystroke (const MouseWatcherParameter &param)
	Calls keystroke() on all the PGItems with background focus. More...

static void	background_press (const MouseWatcherParameter &param)
	Calls press() on all the PGItems with background focus. More...

static void	background_release (const MouseWatcherParameter &param)
	Calls release() on all the PGItems with background focus. More...

static TypeHandle	get_class_type ()

static std::string	get_enter_prefix ()
	Returns the prefix that is used to define the enter event for all PGItems. More...

static std::string	get_exit_prefix ()
	Returns the prefix that is used to define the exit event for all PGItems. More...

static std::string	get_focus_in_prefix ()
	Returns the prefix that is used to define the focus_in event for all PGItems. More...

static PGItem *	get_focus_item ()
	Returns the one PGItem in the world that currently has keyboard focus, if any, or NULL if no item has keyboard focus. More...

static std::string	get_focus_out_prefix ()
	Returns the prefix that is used to define the focus_out event for all PGItems. More...

static std::string	get_keystroke_prefix ()
	Returns the prefix that is used to define the keystroke event for all PGItems. More...

static std::string	get_press_prefix ()
	Returns the prefix that is used to define the press event for all PGItems. More...

static std::string	get_release_prefix ()
	Returns the prefix that is used to define the release event for all PGItems. More...

static std::string	get_repeat_prefix ()
	Returns the prefix that is used to define the repeat event for all PGItems. More...

static TextNode *	get_text_node ()
	Returns the TextNode object that will be used by all PGItems to generate default labels given a string. More...

static std::string	get_within_prefix ()
	Returns the prefix that is used to define the within event for all PGItems. More...

static std::string	get_without_prefix ()
	Returns the prefix that is used to define the without event for all PGItems. More...

static void	init_type ()

static void	set_text_node (TextNode *node)
	Changes the TextNode object that will be used by all PGItems to generate default labels given a string. More...

Static Public Member Functions inherited from PandaNode
static DrawMask	get_all_camera_mask ()

static TypeHandle	get_class_type ()

static DrawMask	get_overall_bit ()

static void	init_type ()

static	PT (PandaNode) decode_from_bam_stream(vector_uchar data

static void	register_with_read_factory ()
	Tells the BamReader how to create objects of type PandaNode. More...

static void	reset_all_prev_transform (Thread *current_thread=Thread::get_current_thread())
	Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More...

static void	set_scene_root_func (SceneRootFunc *func)
	This is used by the GraphicsEngine to hook in a pointer to the scene_root_func(), the function to determine whether the node is an active scene root. More...

Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

static	PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data

Static Public Member Functions inherited from TypedWritable
static bool	decode_raw_from_bam_stream (TypedWritable &ptr, ReferenceCount &ref_ptr, vector_uchar data, BamReader *reader=nullptr)
	Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...

static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedObject
static TypeHandle	get_class_type ()

static void	init_type ()
	This function is declared non-inline to work around a compiler bug in g++ 2.96. More...

Static Public Member Functions inherited from ReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from Namable
static TypeHandle	get_class_type ()

static void	init_type ()

Additional Inherited Members
Public Attributes inherited from PGItem
	get_num_state_defs
	Returns one more than the highest-numbered state def that was ever assigned to the PGItem. More...

	get_state_def
	Returns the Node that is the root of the subgraph that will be drawn when the PGItem is in the indicated state. More...

Public Attributes inherited from PandaNode
	clear_tag
	Removes the value defined for this key on this particular node. More...

virtual LPoint3 bool const TransformState Thread *	current_thread = Thread::get_current_thread()) const

Thread *	current_thread = Thread::get_current_thread()) const

virtual LPoint3 bool &	found_any

	get_all_camera_mask
	Returns a DrawMask that is appropriate for rendering to all cameras. More...

	get_bounds_type
	Returns the bounding volume type set with set_bounds_type(). More...

	get_child
	Returns the nth child node of this node. More...

	get_children
	Returns an object that can be used to walk through the list of children of the node. More...

	get_draw_control_mask
	Returns the set of bits in draw_show_mask that are considered meaningful. More...

	get_draw_show_mask
	Returns the hide/show bits of this particular node. More...

	get_effects

	get_internal_bounds

	get_internal_vertices

	get_into_collide_mask
	Returns the "into" collide mask for this node. More...

	get_legal_collide_mask
	Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...

	get_nested_vertices

	get_num_children
	Returns the number of child nodes this node has. More...

	get_num_parents
	Returns the number of parent nodes this node has. More...

	get_num_stashed
	Returns the number of stashed nodes this node has. More...

	get_num_tags

	get_overall_bit

	get_parent
	Returns the nth parent node of this node. More...

	get_parents
	Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...

	get_prev_transform

	get_python_tags

	get_stashed
	Returns the nth stashed child of this node. More...

	get_state

	get_tag

	get_tag_key

	get_transform

	has_tag

	is_bounds_stale

	is_final
	Returns the current state of the "final" flag. More...

	is_overall_hidden
	Returns true if the node has been hidden to all cameras by clearing its overall bit. More...

virtual LPoint3 &	max_point

static BamReader *	reader = nullptr)

	set_effects
	Sets the complete RenderEffects that will be applied this node. More...

	set_final

	set_into_collide_mask
	Sets the "into" CollideMask. More...

	set_overall_hidden
	Sets or clears the hidden flag. More...

	set_state
	Sets the complete RenderState that will be applied to all nodes at this level and below. More...

	set_tag
	Associates a user-defined value with a user-defined key which is stored on the node. More...

	set_transform
	Sets the transform that will be applied to this node and below. More...

virtual LPoint3 bool const TransformState *	transform

Public Attributes inherited from TypedWritableReferenceCount
static BamReader *	reader = nullptr)

Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count. More...

Public Attributes inherited from Namable
	get_name

	set_name

Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

Detailed Description

This is a particular kind of PGItem that handles simple one-line or short multi-line text entries, of the sort where the user can type any string.

A PGEntry does all of its internal manipulation on a wide string, so it can store the full Unicode character set. The interface can support either the wide string getters and setters, or the normal 8-bit string getters and setters, which use whatever encoding method is specified by the associated TextNode.

Definition at line 37 of file pgEntry.h.

Member Function Documentation

◆ accept()

void PGEntry::accept ( const MouseWatcherParameter & param )

virtual

This is a callback hook function, called whenever the entry is accepted by the user pressing Enter normally.

Definition at line 444 of file pgEntry.cxx.

References get_accept_event(), and MouseWatcherParameter::get_button().

Referenced by press().

◆ accept_failed()

void PGEntry::accept_failed ( const MouseWatcherParameter & param )

virtual

This is a callback hook function, called whenever the user presses Enter but we can't accept the input.

Definition at line 458 of file pgEntry.cxx.

References get_accept_failed_event(), and MouseWatcherParameter::get_button().

Referenced by press().

◆ candidate()

void PGEntry::candidate	(	const MouseWatcherParameter &	param,
		bool	background
	)

virtual

This is a callback hook function, called whenever the user selects an item from the IME menu.

Reimplemented from PGItem.

Definition at line 421 of file pgEntry.cxx.

References PGItem::candidate(), PGItem::get_active(), MouseWatcherParameter::get_candidate_string(), MouseWatcherParameter::get_cursor_pos(), MouseWatcherParameter::get_highlight_end(), MouseWatcherParameter::get_highlight_start(), MouseWatcherParameter::has_candidate(), and type().

◆ clear_cursor_def()

void PGEntry::clear_cursor_def ( )

inline

Removes all the children from the cursor_def node, in preparation for adding a new definition.

Definition at line 261 of file pgEntry.I.

References NodePath::attach_new_node(), and NodePath::remove_node().

Referenced by setup_minimal().

◆ cull_callback()

bool PGEntry::cull_callback	(	CullTraverser *	trav,
		CullTraverserData &	data
	)

virtual

This function will be called during the cull traversal to perform any additional operations that should be performed at cull time.

This may include additional manipulation of render state or additional visible/invisible decisions, or any other arbitrary operation.

Note that this function will *not* be called unless set_cull_callback() is called in the constructor of the derived class. It is necessary to call set_cull_callback() to indicated that we require cull_callback() to be called.

By the time this function is called, the node has already passed the bounding-volume test for the viewing frustum, and the node's transform and state have already been applied to the indicated CullTraverserData object.

The return value is true if this node should be visible, or false if it should be culled.

Reimplemented from PGItem.

Definition at line 176 of file pgEntry.cxx.

◆ cursormove()

void PGEntry::cursormove ( )

virtual

This is a callback hook function, called whenever the cursor moves.

Definition at line 511 of file pgEntry.cxx.

References get_cursormove_event().

◆ erase()

void PGEntry::erase ( const MouseWatcherParameter & param )

virtual

This is a callback hook function, called whenever the user erase characters in the text.

Definition at line 499 of file pgEntry.cxx.

References get_erase_event().

Referenced by press().

◆ get_accept_event()

std::string PGEntry::get_accept_event ( const ButtonHandle & button ) const

inline

Returns the event name that will be thrown when the entry is accepted normally.

Definition at line 458 of file pgEntry.I.

References get_accept_prefix(), PGItem::get_id(), and ButtonHandle::get_name.

Referenced by accept().

◆ get_accept_failed_event()

std::string PGEntry::get_accept_failed_event ( const ButtonHandle & button ) const

inline

Returns the event name that will be thrown when the entry cannot accept an input.

Definition at line 467 of file pgEntry.I.

References get_accept_failed_prefix(), PGItem::get_id(), and ButtonHandle::get_name.

Referenced by accept_failed().

◆ get_accept_failed_prefix()

std::string PGEntry::get_accept_failed_prefix ( )

inlinestatic

Returns the prefix that is used to define the accept failed event for all PGEntries.

This event is the concatenation of this string followed by get_id().

Definition at line 410 of file pgEntry.I.

Referenced by get_accept_failed_event().

◆ get_accept_prefix()

std::string PGEntry::get_accept_prefix ( )

inlinestatic

Returns the prefix that is used to define the accept event for all PGEntries.

The accept event is the concatenation of this string followed by get_id().

Definition at line 400 of file pgEntry.I.

Referenced by get_accept_event().

◆ get_blink_rate()

PN_stdfloat PGEntry::get_blink_rate ( ) const

inline

Returns the number of times per second the cursor will blink, or 0 if the cursor is not to blink.

Definition at line 241 of file pgEntry.I.

◆ get_candidate_active()

const std::string & PGEntry::get_candidate_active ( ) const

inline

See set_candidate_active().

Definition at line 362 of file pgEntry.I.

◆ get_candidate_inactive()

const std::string & PGEntry::get_candidate_inactive ( ) const

inline

See set_candidate_inactive().

Definition at line 389 of file pgEntry.I.

◆ get_character()

wchar_t PGEntry::get_character ( int n ) const

inline

Returns the character at the indicated position in the entry.

If the object at this position is a graphic object instead of a character, returns 0.

Definition at line 78 of file pgEntry.I.

References TextAssembler::get_character().

◆ get_cursor_def()

NodePath PGEntry::get_cursor_def ( )

inline

Returns the Node that will be rendered to represent the cursor.

You can attach suitable cursor geometry to this node.

Definition at line 251 of file pgEntry.I.

Referenced by setup_minimal().

◆ get_cursor_keys_active()

bool PGEntry::get_cursor_keys_active ( ) const

inline

Returns whether the arrow keys are currently set to control movement of the cursor; see set_cursor_keys_active().

Definition at line 282 of file pgEntry.I.

◆ get_cursor_position()

int PGEntry::get_cursor_position ( ) const

inline

Returns the current position of the cursor.

Definition at line 123 of file pgEntry.I.

◆ get_cursor_X()

PN_stdfloat PGEntry::get_cursor_X ( ) const

inline

Returns the node position x of the cursor.

Definition at line 133 of file pgEntry.I.

◆ get_cursor_Y()

PN_stdfloat PGEntry::get_cursor_Y ( ) const

inline

Returns the node position y of the cursor.

Definition at line 143 of file pgEntry.I.

◆ get_cursormove_event()

std::string PGEntry::get_cursormove_event ( ) const

inline

Returns the event name that will be thrown whenever the cursor moves.

Definition at line 503 of file pgEntry.I.

References get_cursormove_prefix(), and PGItem::get_id().

Referenced by cursormove().

◆ get_cursormove_prefix()

std::string PGEntry::get_cursormove_prefix ( )

inlinestatic

Returns the prefix that is used to define the cursor event for all PGEntries.

The cursor event is the concatenation of this string followed by get_id().

Definition at line 449 of file pgEntry.I.

Referenced by get_cursormove_event().

◆ get_erase_event()

std::string PGEntry::get_erase_event ( ) const

inline

Returns the event name that will be thrown whenever the user erases characters in the text.

Definition at line 495 of file pgEntry.I.

References get_erase_prefix(), and PGItem::get_id().

Referenced by erase().

◆ get_erase_prefix()

std::string PGEntry::get_erase_prefix ( )

inlinestatic

Returns the prefix that is used to define the erase event for all PGEntries.

The erase event is the concatenation of this string followed by get_id().

Definition at line 439 of file pgEntry.I.

Referenced by get_erase_event().

◆ get_graphic()

const TextGraphic * PGEntry::get_graphic ( int n ) const

inline

Returns the graphic object at the indicated position in the pre-wordwrapped string.

If the object at this position is a character instead of a graphic object, returns NULL.

Definition at line 89 of file pgEntry.I.

References TextAssembler::get_graphic().

◆ get_max_chars()

int PGEntry::get_max_chars ( ) const

inline

Returns the current maximum number of characters that may be typed into the entry, or 0 if there is no limit.

See set_max_chars().

Definition at line 167 of file pgEntry.I.

Referenced by keystroke().

◆ get_max_width()

PN_stdfloat PGEntry::get_max_width ( ) const

inline

Returns the current maximum width of the characters that may be typed into the entry, or 0 if there is no limit.

See set_max_width().

Definition at line 195 of file pgEntry.I.

◆ get_num_characters()

int PGEntry::get_num_characters ( ) const

inline

Returns the number of characters of text in the entry.

This is the actual number of visible characters, not counting implicit newlines due to wordwrapping, or formatted characters for text properties changes. If there is an embedded TextGraphic object, it counts as one character.

This is also the length of the string returned by get_plain_text().

Definition at line 67 of file pgEntry.I.

References TextAssembler::get_num_characters().

◆ get_num_lines()

int PGEntry::get_num_lines ( ) const

inline

Returns the number of lines of text the PGEntry will use, if _max_width is not 0.

See set_num_lines().

Definition at line 219 of file pgEntry.I.

◆ get_obscure_mode()

bool PGEntry::get_obscure_mode ( ) const

inline

Specifies whether obscure mode is enabled.

See set_obscure_mode().

Definition at line 310 of file pgEntry.I.

◆ get_overflow_event()

std::string PGEntry::get_overflow_event ( ) const

inline

Returns the event name that will be thrown when too much text is attempted to be entered into the PGEntry, exceeding either the limit set via set_max_chars() or via set_max_width().

Definition at line 477 of file pgEntry.I.

References PGItem::get_id(), and get_overflow_prefix().

Referenced by overflow().

◆ get_overflow_mode()

bool PGEntry::get_overflow_mode ( ) const

inline

Specifies whether overflow mode is enabled.

See set_overflow_mode().

Definition at line 335 of file pgEntry.I.

Referenced by keystroke(), and press().

◆ get_overflow_prefix()

std::string PGEntry::get_overflow_prefix ( )

inlinestatic

Returns the prefix that is used to define the overflow event for all PGEntries.

The overflow event is the concatenation of this string followed by get_id().

Definition at line 420 of file pgEntry.I.

Referenced by get_overflow_event().

◆ get_plain_text()

std::string PGEntry::get_plain_text ( ) const

inline

Returns the text currently displayed within the entry, without any embedded properties characters.

This uses the Unicode encoding currently specified for the "focus" TextNode; therefore, the TextNode must exist before calling get_text().

Definition at line 38 of file pgEntry.I.

References get_text_def().

◆ get_plain_wtext()

std::wstring PGEntry::get_plain_wtext ( ) const

inline

Returns the text currently displayed within the entry, without any embedded properties characters.

Definition at line 530 of file pgEntry.I.

References TextAssembler::get_plain_wtext().

◆ get_properties()

const TextProperties & PGEntry::get_properties ( int n ) const

inline

Returns the TextProperties in effect for the object at the indicated position in the pre-wordwrapped string.

Definition at line 99 of file pgEntry.I.

References TextAssembler::get_properties.

◆ get_text()

std::string PGEntry::get_text ( ) const

inline

Returns the text currently displayed within the entry.

This uses the Unicode encoding currently specified for the "focus" TextNode; therefore, the TextNode must exist before calling get_text().

Definition at line 51 of file pgEntry.I.

References get_text_def().

◆ get_text_def()

TextNode * PGEntry::get_text_def ( int state ) const

Returns the TextNode that will be used to render the text within the entry when the entry is in the indicated state.

See set_text_def().

Definition at line 664 of file pgEntry.cxx.

References PGItem::get_text_node().

Referenced by get_plain_text(), get_text(), set_text(), setup(), and setup_minimal().

◆ get_type_event()

std::string PGEntry::get_type_event ( ) const

inline

Returns the event name that will be thrown whenever the user extends the text by typing.

Definition at line 486 of file pgEntry.I.

References PGItem::get_id(), and get_type_prefix().

Referenced by type().

◆ get_type_prefix()

std::string PGEntry::get_type_prefix ( )

inlinestatic

Returns the prefix that is used to define the type event for all PGEntries.

The type event is the concatenation of this string followed by get_id().

Definition at line 429 of file pgEntry.I.

Referenced by get_type_event().

◆ get_wtext()

std::wstring PGEntry::get_wtext ( ) const

inline

Returns the text currently displayed within the entry.

Definition at line 539 of file pgEntry.I.

References TextAssembler::get_wtext().

◆ is_wtext()

bool PGEntry::is_wtext ( ) const

Returns true if any of the characters in the string returned by get_wtext() are out of the range of an ASCII character (and, therefore, get_wtext() should be called in preference to get_text()).

Definition at line 705 of file pgEntry.cxx.

◆ keystroke()

void PGEntry::keystroke	(	const MouseWatcherParameter &	param,
		bool	background
	)

virtual

This is a callback hook function, called whenever the user types a key.

Reimplemented from PGItem.

Definition at line 315 of file pgEntry.cxx.

References TextAssembler::calc_r_c(), PGItem::get_active(), TextAssembler::get_character(), MouseWatcherParameter::get_keycode(), get_max_chars(), TextAssembler::get_num_characters(), TextAssembler::get_num_cols(), TextAssembler::get_num_rows(), get_overflow_mode(), TextAssembler::get_xpos(), MouseWatcherParameter::has_keycode(), PGItem::keystroke(), overflow(), TextAssembler::set_wsubstr(), TextAssembler::set_wtext(), and type().

◆ make_copy()

PandaNode * PGEntry::make_copy ( ) const

virtual

Returns a newly-allocated Node that is a shallow copy of this one.

It will be a different Node pointer, but its internal data may or may not be shared with that of the original Node.

Reimplemented from PGItem.

Definition at line 141 of file pgEntry.cxx.

◆ overflow()

void PGEntry::overflow ( const MouseWatcherParameter & param )

virtual

This is a callback hook function, called whenever the entry is overflowed because the user attempts to type too many characters, exceeding either set_max_chars() or set_max_width().

Definition at line 473 of file pgEntry.cxx.

References get_overflow_event().

Referenced by keystroke(), and press().

◆ press()

void PGEntry::press	(	const MouseWatcherParameter &	param,
		bool	background
	)

virtual

This is a callback hook function, called whenever a mouse or keyboard entry is depressed while the mouse is within the region.

Reimplemented from PGItem.

Definition at line 195 of file pgEntry.cxx.

References accept(), accept_failed(), erase(), MouseButton::five(), MouseButton::four(), PGItem::get_active(), PGItem::get_background_focus(), MouseWatcherParameter::get_button(), PGItem::get_focus(), ClockObject::get_frame_time, ClockObject::get_global_clock(), TextAssembler::get_num_characters(), get_overflow_mode(), MouseWatcherParameter::has_button(), MouseButton::one(), overflow(), PGItem::press(), set_focus(), TextAssembler::set_wsubstr(), MouseButton::three(), MouseButton::two(), and type().

◆ set_accept_enabled()

void PGEntry::set_accept_enabled ( bool enabled )

inline

Sets whether the input may be accepted–use to disable submission by the user.

Definition at line 549 of file pgEntry.I.

◆ set_active()

void PGEntry::set_active ( bool active )

virtual

Toggles the active/inactive state of the entry.

In the case of a PGEntry, this also changes its visual appearance.

Reimplemented from PGItem.

Definition at line 681 of file pgEntry.cxx.

References PGItem::set_active().

◆ set_blink_rate()

void PGEntry::set_blink_rate ( PN_stdfloat blink_rate )

inline

Sets the number of times per second the cursor will blink while the entry has keyboard focus.

If this is 0, the cursor does not blink, but is held steady.

Definition at line 231 of file pgEntry.I.

◆ set_candidate_active()

void PGEntry::set_candidate_active ( const std::string & candidate_active )

inline

Specifies the name of the TextProperties structure added to the TextPropertiesManager that will be used to render candidate strings from the IME, used for typing characters in east Asian languages.

Each candidate string represents one possible way to interpret the sequence of keys the user has just entered; it should not be considered typed yet, but it is important for the user to be able to see what he is considering entering.

This particular method sets the properties for the subset of the current candidate string that the user can actively scroll through.

Definition at line 353 of file pgEntry.I.

◆ set_candidate_inactive()

void PGEntry::set_candidate_inactive ( const std::string & candidate_inactive )

inline

Specifies the name of the TextProperties structure added to the TextPropertiesManager that will be used to render candidate strings from the IME, used for typing characters in east Asian languages.

Each candidate string represents one possible way to interpret the sequence of keys the user has just entered; it should not be considered typed yet, but it is important for the user to be able to see what he is considering entering.

This particular method sets the properties for the subset of the current candidate string that the user is not actively scrolling through.

Definition at line 380 of file pgEntry.I.

◆ set_cursor_keys_active()

void PGEntry::set_cursor_keys_active ( bool flag )

inline

Sets whether the arrow keys (and home/end) control movement of the cursor.

If true, they are active; if false, they are ignored.

Definition at line 272 of file pgEntry.I.

◆ set_cursor_position()

void PGEntry::set_cursor_position ( int position )

inline

Sets the current position of the cursor.

This is the position within the text at which the next letter typed by the user will be inserted; normally it is the same as the length of the text.

Definition at line 110 of file pgEntry.I.

References ClockObject::get_frame_time, and ClockObject::get_global_clock().

Referenced by set_wtext().

◆ set_focus()

void PGEntry::set_focus ( bool focus )

virtual

Toggles the focus state of the entry.

In the case of a PGEntry, this also changes its visual appearance.

Reimplemented from PGItem.

Definition at line 692 of file pgEntry.cxx.

References ClockObject::get_frame_time, ClockObject::get_global_clock(), and PGItem::set_focus().

Referenced by press().

◆ set_max_chars()

void PGEntry::set_max_chars ( int max_chars )

inline

Sets the maximum number of characters that may be typed into the entry.

This is a limit on the number of characters, as opposed to the width of the entry; see also set_max_width().

If this is 0, there is no limit.

Definition at line 157 of file pgEntry.I.

Referenced by setup_minimal().

◆ set_max_width()

void PGEntry::set_max_width ( PN_stdfloat max_width )

inline

Sets the maximum width of all characters that may be typed into the entry.

This is a limit on the width of the formatted text, not a fixed limit on the number of characters; also set_max_chars().

If this is 0, there is no limit.

If _num_lines is more than 1, rather than being a fixed width on the whole entry, this becomes instead the wordwrap width (and the width limit on the entry is essentially _max_width * _num_lines).

Definition at line 184 of file pgEntry.I.

Referenced by setup_minimal().

◆ set_num_lines()

void PGEntry::set_num_lines ( int num_lines )

inline

Sets the number of lines of text the PGEntry will use.

This only has meaning if _max_width is not 0; _max_width indicates the wordwrap width of each line.

Definition at line 206 of file pgEntry.I.

Referenced by setup_minimal().

◆ set_obscure_mode()

void PGEntry::set_obscure_mode ( bool flag )

inline

Specifies whether obscure mode should be enabled.

In obscure mode, a string of asterisks is displayed instead of the literal text, e.g. for entering passwords.

In obscure mode, the width of the text is computed based on the width of the string of asterisks, not on the width of the actual text. This has implications on the maximum length of text that may be entered if max_width is in effect.

Definition at line 298 of file pgEntry.I.

◆ set_overflow_mode()

void PGEntry::set_overflow_mode ( bool flag )

inline

Specifies whether overflow mode should be enabled.

In overflow mode, text can overflow the boundaries of the Entry element horizontally.

Overflow mode only works when the number of lines is 1.

Definition at line 322 of file pgEntry.I.

◆ set_text()

bool PGEntry::set_text ( const std::string & text )

inline

Changes the text currently displayed within the entry.

This uses the Unicode encoding currently specified for the "focus" TextNode; therefore, the TextNode must exist before calling set_text().

The return value is true if all the text is accepted, or false if some was truncated (see set_max_width(), etc.).

Definition at line 23 of file pgEntry.I.

References get_text_def().

Referenced by setup_minimal().

◆ set_text_def()

void PGEntry::set_text_def	(	int	state,
		TextNode *	node
	)

Changes the TextNode that will be used to render the text within the entry when the entry is in the indicated state.

The default if nothing is specified is the same TextNode returned by PGItem::get_text_node().

Definition at line 647 of file pgEntry.cxx.

◆ set_wtext()

bool PGEntry::set_wtext ( const std::wstring & wtext )

inline

Changes the text currently displayed within the entry.

The return value is true if all the text is accepted, or false if some was truncated (see set_max_width(), etc.).

Definition at line 514 of file pgEntry.I.

References TextAssembler::get_num_characters(), set_cursor_position(), and TextAssembler::set_wtext().

◆ setup()

void PGEntry::setup	(	PN_stdfloat	width,
		int	num_lines
	)

Sets up the entry for normal use.

The width is the maximum width of characters that will be typed, and num_lines is the integer number of lines of text of the entry. Both of these together determine the size of the entry, based on the TextNode in effect.

Definition at line 524 of file pgEntry.cxx.

References TextNode::get_line_height(), get_text_def(), and setup_minimal().

◆ setup_minimal()

void PGEntry::setup_minimal	(	PN_stdfloat	width,
		int	num_lines
	)

Sets up the entry without creating any frame or other decoration.

Definition at line 611 of file pgEntry.cxx.

References NodePath::attach_new_node(), clear_cursor_def(), LineSegs::create(), LineSegs::draw_to(), get_cursor_def(), TextNode::get_line_height(), get_text_def(), LineSegs::move_to(), LineSegs::set_color(), set_max_chars(), set_max_width(), set_num_lines(), and set_text().

Referenced by setup().

◆ type()

void PGEntry::type ( const MouseWatcherParameter & param )

virtual

This is a callback hook function, called whenever the user extends the text by typing.

Definition at line 486 of file pgEntry.cxx.

References get_type_event().

Referenced by candidate(), keystroke(), and press().

◆ xform()

void PGEntry::xform ( const LMatrix4 & mat )

virtual

Transforms the contents of this node by the indicated matrix, if it means anything to do so.

For most kinds of nodes, this does nothing.

Reimplemented from PGItem.

Definition at line 151 of file pgEntry.cxx.

The documentation for this class was generated from the following files:

panda/src/pgui/pgEntry.h
panda/src/pgui/pgEntry.cxx
panda/src/pgui/pgEntry.I

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ accept()

◆ accept_failed()

◆ candidate()

◆ clear_cursor_def()

◆ cull_callback()

◆ cursormove()

◆ erase()

◆ get_accept_event()

◆ get_accept_failed_event()

◆ get_accept_failed_prefix()

◆ get_accept_prefix()

◆ get_blink_rate()

◆ get_candidate_active()

◆ get_candidate_inactive()

◆ get_character()

◆ get_cursor_def()

◆ get_cursor_keys_active()

◆ get_cursor_position()

◆ get_cursor_X()

◆ get_cursor_Y()

◆ get_cursormove_event()

◆ get_cursormove_prefix()

◆ get_erase_event()

◆ get_erase_prefix()

◆ get_graphic()

◆ get_max_chars()

◆ get_max_width()

◆ get_num_characters()

◆ get_num_lines()

◆ get_obscure_mode()

◆ get_overflow_event()

◆ get_overflow_mode()

◆ get_overflow_prefix()

◆ get_plain_text()

◆ get_plain_wtext()

◆ get_properties()

◆ get_text()

◆ get_text_def()

◆ get_type_event()

◆ get_type_prefix()

◆ get_wtext()

◆ is_wtext()

◆ keystroke()

◆ make_copy()

◆ overflow()

◆ press()

◆ set_accept_enabled()

◆ set_active()

◆ set_blink_rate()

◆ set_candidate_active()

◆ set_candidate_inactive()

◆ set_cursor_keys_active()

◆ set_cursor_position()

◆ set_focus()

◆ set_max_chars()

◆ set_max_width()

◆ set_num_lines()

◆ set_obscure_mode()

◆ set_overflow_mode()

◆ set_text()

◆ set_text_def()

◆ set_wtext()

◆ setup()

◆ setup_minimal()

◆ type()

◆ xform()