SetPropertyStatus.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	SetPropertyStatus { SET_PROPERTY_ERROR = -1, SET_PROPERTY_SUCCEED = 0, SET_PROPERTY_UNCHANGED = 1 }
Functions
SetPropertyStatus	sciSetFinalStatus (SetPropertyStatus status1, SetPropertyStatus status2)

---

Enumeration Type Documentation

enum SetPropertyStatus

define the diffrent type of return for a set function :

• SET_PROPERTY_ERROR when an error occured during the set
• SET_PROPERTY_UNCHANGED when the property was already set to the value, then nothing should be done
• SET_PROPERTY_SUCCEED when the property was successfully modified

Enumerator:

SET_PROPERTY_ERROR
SET_PROPERTY_SUCCEED
SET_PROPERTY_UNCHANGED

Definition at line 19 of file SetPropertyStatus.h.

{ SET_PROPERTY_ERROR     = -1,
  SET_PROPERTY_SUCCEED   =  0 ,
  SET_PROPERTY_UNCHANGED =  1  } SetPropertyStatus ;

---

Function Documentation

SetPropertyStatus sciSetFinalStatus	(	SetPropertyStatus	status1,
		SetPropertyStatus	status2
	)

when two properties are set at the same time return only one which can be used after

Definition at line 12 of file SetPropertyStatus.c.

References SET_PROPERTY_ERROR, SET_PROPERTY_SUCCEED, and SET_PROPERTY_UNCHANGED.

Referenced by set_clip_box_property(), set_current_axes_property(), set_mark_style_property(), set_text_box_mode_property(), and set_viewport_property().

{
  if ( status1 == SET_PROPERTY_ERROR || status2 == SET_PROPERTY_ERROR )
  {
    /* problem */
    return SET_PROPERTY_ERROR ;
  }
  else if ( status1 == SET_PROPERTY_UNCHANGED && status2 == SET_PROPERTY_UNCHANGED )
  {
    /* nothing changed */
    return SET_PROPERTY_UNCHANGED ;
  }
  else
  {
    /* everything should be ok */
    return SET_PROPERTY_SUCCEED ;
  }
}

Here is the caller graph for this function:

---