MyFrame Class Reference

#include <MyFrame.h>

Inheritance diagram for MyFrame:

[legend]Collaboration diagram for MyFrame:

[legend]List of all members.

---

Detailed Description

The NClip base class.

requirements

GNU C++ Compatible Compiler or MS Compiler
win2k or later
WxWidgets 2.6

Version:

1.0 first version

Date:

08-31-2005

Author:

kamp

license

This code is absolutely free to use and modify. The code is provided "as is" with no expressed or implied warranty. The author accepts no liability if it causes any damage to your computer, causes your pet to fall ill, increases baldness or makes your car start emitting strange noises when you start it up. This code has no bugs, just undocumented features!

Todo:

This is the first version of the frame. More to come.

Bug:

No Bugs yet.

Definition at line 36 of file MyFrame.h.

Public Member Functions
	MyFrame ()
virtual	~MyFrame ()
void	FileOpen (wxCommandEvent &event)
void	SplitHorizontal (wxCommandEvent &event)
void	SplitVertical (wxCommandEvent &event)
void	Unsplit (wxCommandEvent &event)
void	ToggleLive (wxCommandEvent &event)
void	SetPosition (wxCommandEvent &event)
void	SetMinSize (wxCommandEvent &event)
void	SetGravity (wxCommandEvent &event)
void	Replace (wxCommandEvent &event)
void	Quit (wxCommandEvent &event)
void	UpdateUIHorizontal (wxUpdateUIEvent &event)
void	UpdateUIVertical (wxUpdateUIEvent &event)
void	UpdateUIUnsplit (wxUpdateUIEvent &event)
void	OnAbout (wxCommandEvent &WXUNUSED(event))
NclLog *	GetLog ()
Private Attributes
wxScrolledWindow *	m_left
wxScrolledWindow *	m_right
wxSplitterWindow *	m_splitter
wxWindow *	m_replacewindow
NclLog *	log
NclBase *	base

---

Constructor & Destructor Documentation

MyFrame::MyFrame (   )

Constructor Returns: None Definition at line 53 of file MyFrame.cpp. References NclLog::Creation().

MyFrame::~MyFrame (   )  [virtual]

Returns: Definition at line 147 of file MyFrame.cpp. References NclLog::Destruction().

---

Member Function Documentation

void MyFrame::FileOpen (  wxCommandEvent &  event  )

Open a file. Parameters: event  The current event of this frame.

NclLog * MyFrame::GetLog (   )

Return a pointer to the log object. Returns: Definition at line 302 of file MyFrame.cpp.

void MyFrame::OnAbout (  wxCommandEvent &  WXUNUSED(event)  )

Show information about this application. Parameters: event  Definition at line 293 of file MyFrame.cpp.

void MyFrame::Quit (  wxCommandEvent &  event  )

Quit this appliaction. Parameters: event  The current event of this frame.

void MyFrame::Replace (  wxCommandEvent &  event  )

This function replaces one of the windows managed by the wxSplitterWindow with another one. It is in general better to use it instead of calling Unsplit() and then resplitting the window back because it will provoke much less flicker (if any). It is valid to call this function whether the splitter has two windows or only one. Parameters: event  The current event of this frame.

void MyFrame::SetGravity (  wxCommandEvent &  event  )

Gravity is real factor which controls position of sash while resizing wxSplitterWindow. Gravity tells wxSplitterWindow how much will left/top window grow while resizing. Example values: 0.0 - only the bottom/right window is automaticaly resized 0.5 - both windows grow by equal size 1.0 - only left/top window grows Gravity should be real value betwwen 0.0 and 1.0. Default value of sash gravity is 0.0. That value is compatible with previous (before gravity was introduced) behaviour of wxSplitterWindow. Parameters: event  The current event of this frame.

void MyFrame::SetMinSize (  wxCommandEvent &  event  )

Set the minimum size of a canvas. Parameters: event  The current event of this frame.

void MyFrame::SetPosition (  wxCommandEvent &  event  )

The the splitter bar position. Parameters: event  The current event of this frame.

void MyFrame::SplitHorizontal (  wxCommandEvent &  event  )

Split the canvas horizontally. Parameters: event  The current event of this frame.

void MyFrame::SplitVertical (  wxCommandEvent &  event  )

Split the canvas vertically. Parameters: event  The current event of this frame.

void MyFrame::ToggleLive (  wxCommandEvent &  event  )

Toggle this: Don't draw XOR line but resize the child windows immediately. Parameters: event  The current event of this frame. Definition at line 199 of file MyFrame.cpp.

void MyFrame::Unsplit (  wxCommandEvent &  event  )

Revert to the left hand canvas. Parameters: event  The current event of this frame.

void MyFrame::UpdateUIHorizontal (  wxUpdateUIEvent &  event  )

Update the menu UI. Parameters: event  Definition at line 278 of file MyFrame.cpp.

void MyFrame::UpdateUIUnsplit (  wxUpdateUIEvent &  event  )

Update the menu UI. Parameters: event  Definition at line 288 of file MyFrame.cpp.

void MyFrame::UpdateUIVertical (  wxUpdateUIEvent &  event  )

Update the menu UI. Parameters: event  Definition at line 283 of file MyFrame.cpp.

---