LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SEE_SwitchToSchematicPage Class Referencefinal

The SEE_SwitchToSchematicPage class. More...

#include <schematiceditorevent.h>

+ Inheritance diagram for SEE_SwitchToSchematicPage:
+ Collaboration diagram for SEE_SwitchToSchematicPage:

Public Member Functions

 SEE_SwitchToSchematicPage (unsigned int schematicIndex)
 
virtual ~SEE_SwitchToSchematicPage ()
 
unsigned int getSchematicIndex () const noexcept
 
- Public Member Functions inherited from SEE_Base
 SEE_Base (EventType_t type)
 
virtual ~SEE_Base ()
 
EventType_t getType () const noexcept
 
bool isAccepted () const noexcept
 
virtual void setAccepted (bool accepted) noexcept
 

Private Attributes

unsigned int mSchematicIndex
 the requested schematic page index More...
 

Additional Inherited Members

- Public Types inherited from SEE_Base
enum  EventType_t
 FSM event types. More...
 
- Protected Attributes inherited from SEE_Base
EventType_t mType
 
bool mAccepted
 

Detailed Description

The SEE_SwitchToSchematicPage class.

If someone (the user or the application) wants to switch to another schematic page in the schematic editor, this is not allowed at any time (for example, while drawing a netline in the active schematic, you cannot switch to another schematic). So this type of event must be processed by the FSM. The FSM then will only decide whether changing the schematic is allowed (event accepted) or not (event rejected). If the event was accepted, the schematic editor then will switch to the requested schematic page.

See Also
#project#SchematicEditor#setActiveSchematicIndex()

Constructor & Destructor Documentation

SEE_SwitchToSchematicPage ( unsigned int  schematicIndex)
inline
virtual ~SEE_SwitchToSchematicPage ( )
inlinevirtual

Member Function Documentation

unsigned int getSchematicIndex ( ) const
inlinenoexcept

Member Data Documentation

unsigned int mSchematicIndex
private

the requested schematic page index


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